GET /api/roles
List all roles

Params

Param Name Description
search
Optional

filtrera resultat

Validations:

  • Must be String

order
Optional

sortera resultat

Validations:

  • Must be String

page
Optional

paginate results

Validations:

  • Must be String

per_page
Optional

antal poster per begäran

Validations:

  • Must be String


GET /api/roles/:id
Show a role

Params

Param Name Description
id
Required

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
Create a role

Params

Param Name Description
role
Required

Validations:

  • Must be a Hash

role[name]
Required

Validations:

  • Must be String

role[location_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

role[organization_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


PUT /api/roles/:id
Update a role

Params

Param Name Description
id
Required

Validations:

  • Must be String

role
Required

Validations:

  • Must be a Hash

role[name]
Optional

Validations:

  • Must be String

role[location_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

role[organization_ids]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


DELETE /api/roles/:id
Delete a role

Params

Param Name Description
id
Required

Validations:

  • Must be String