Rollen
Alle Rollen auflisten
GET /api/roles
<!--?xml version="1.0" encoding="UTF-8"?--> <roles type="array" page="1" per_page="100" total="2"> <role> ... </role> <role> ... </role> </roles>
Über Parameter kann gefiltert werden:
GET /api/clients?name=Management
Listet alle Rollen auf, die „Management“ im Namen haben. Groß- und Kleinschreibung wird ignoriert.
Folgende Parameter stehen zur Verfügung:
| Parameter | Beschreibung |
|---|---|
| name | Name der Rolle |
Einzelne Rolle aufrufen
GET /api/roles/{id}
<!--?xml version="1.0" encoding="UTF-8"?-->
<role>
<id type="integer">1</id>
<name>Master</name>
<articles>DELETE</articles>
<clients>DELETE</clients>
<offers>DELETE</offers>
<confirmations>DELETE</confirmations>
<invoices>DELETE</invoices>
<credit_notes>DELETE</credit_notes>
<delivery_notes>DELETE</delivery_notes>
<reminders>DELETE</reminders>
<settings_my_account>UPDATE</settings_my_account>
<settings_documents>UPDATE</settings_documents>
<settings_configuration>UPDATE</settings_configuration>
<settings_administration>UPDATE</settings_administration>
<settings_addons>UPDATE</settings_addons>
<settings_my_addons>UPDATE</settings_my_addons>
</role>
Rolle erstellen
POST /api/roles
| XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
|---|---|---|---|---|
| name | Name der Rolle | ALNUM | ja | |
| articles | Zugriffsrecht für Artikelverwaltung (READ, UPDATE, DELETE) | ENUM | ||
| clients | Zugriffsrecht für Kundenverwaltung (READ, UPDATE, DELETE) | ENUM | ||
| offers | Zugriffsrecht für Angebote (READ, UPDATE, DELETE) | ENUM | ||
| confirmations | Zugriffsrecht für Auftragsbestätigungen (READ, UPDATE, DELETE) | ENUM | ||
| invoices | Zugriffsrecht für Rechnungen (READ, UPDATE, DELETE) | ENUM | ||
| credit_notes | Zugriffsrecht für Gutschriften (READ, UPDATE, DELETE) | ENUM | ||
| delivery_notes | Zugriffsrecht für Lieferscheine (READ, UPDATE, DELETE) | ENUM | ||
| reminders | Zugriffsrecht für Mahnungen (READ, UPDATE, DELETE) | ENUM | ||
| settings_my_account | Zugriffsrecht für Einstellungen > Mein Konto (UPDATE) | ENUM | ||
| settings_documents | Zugriffsrecht für Einstellungen > Dokumente (UPDATE) | ENUM | ||
| settings_configuration | Zugriffsrecht für Einstellungen > Konfiguration (UPDATE) | ENUM | ||
| settings_administration | Zugriffsrecht für Einstellungen > Administration (UPDATE) | ENUM | ||
| settings_addons | Zugriffsrecht für Einstellungen > Account-Add-Ons (UPDATE) | ENUM | ||
| settings_my_addons | Zugriffsrecht für Einstellungen > persönliche Add-Ons (UPDATE) | ENUM |
Die Festlegung der Rechte kann folgende Werte haben:
– READ (Lesen)
– UPDATE (Bearbeiten)
– DELETE (Löschen)
– Ein leerer Wert bedeutet, dass keine Zugriffsrechte gewährt werden.
<role>
<name>Azubi</name>
<articles>READ</articles>
<offers>UPDATE</offers>
</role>
<!--?xml version="1.0" encoding="UTF-8"?-->
<role>
<id type="integer">123</id>
<name>Azubi</name>
<articles>READ</articles>
<clients></clients>
<offers>UPDATE</offers>
<confirmations></confirmations>
<invoices></invoices>
<credit_notes></credit_notes>
<delivery_notes></delivery_notes>
<reminders></reminders>
<settings_my_account></settings_my_account>
<settings_documents></settings_documents>
<settings_configuration></settings_configuration>
<settings_administration></settings_administration>
<settings_addons></settings_addons>
<settings_my_addons></settings_my_addons>
</role>
Rolle bearbeiten
PUT /api/roles/{id}
<role> <name>Manager</name> </role>
Rolle löschen
DELETE /api/roles/{id}Ist nur möglich, wenn keine Mitarbeiter für diese Rolle existieren.