Roles

>>>

GET /api/roles
Alle Rollen auflisten

Parameter

Parametername Beschreibung
search
optional

Ergebnisse filtern

Validations:

  • Must be String
order
optional

Ergebnisse sortieren

Validations:

  • Must be String
page
optional

Ergebnisse nummerieren

Validations:

  • Must be String
per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be String
>>>

GET /api/roles/:id
Rolle anzeigen

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

POST /api/roles
Rolle erstellen

Parameter

Parametername Beschreibung
role
verpflichtend

Validations:

  • Must be a Hash
role[name]
verpflichtend

Validations:

  • Must be String
role[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type
role[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type
>>>

PUT /api/roles/:id
Rolle aktualisieren

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

  • Must be String
role
verpflichtend

Validations:

  • Must be a Hash
role[name]
optional

Validations:

  • Must be String
role[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type
role[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type
>>>

DELETE /api/roles/:id
Rolle löschen

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

  • Must be String