Roles

>>>

GET /api/roles
List all roles

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
search
Optional

filtrera resultat

Validations:

  • Must be a String
order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
Optional

paginate results

Validations:

  • Must be a String
per_page
Optional

antal poster per begäran

Validations:

  • Must be a String

Search fields

Field name Typ Possible values
builtin true, false
description text
name string
permission string
>>>

GET /api/roles/:id
Show a role

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
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.
description
Optional

Validations:

  • Must be a String
>>>

POST /api/roles
Create a role

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
role
Required

Validations:

  • Must be a Hash
role[name]
Required

Validations:

  • Must be a String
role[description]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Role description

Validations:

  • Must be a 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
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be a String
role
Required

Validations:

  • Must be a Hash
role[name]
Optional

Validations:

  • Must be a String
role[description]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Role description

Validations:

  • Must be a 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
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be a String
>>>

POST /api/roles/:id/clone
Clone a role

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be a String
role
Required

Validations:

  • Must be a Hash
role[name]
Optional

Validations:

  • Must be a String
role[description]
Optional , <span class="translation_missing" title="translation missing: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Role description

Validations:

  • Must be a 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