Roles

>>>

GET /api/roles
List all roles

Params

Param Name Description
search
Optional

filter results

Validations:

  • Must be a String
order
Optional

sort results

Validations:

  • Must be a String
page
Optional

paginate results

Validations:

  • Must be a String
per_page
Optional

number of entries per request

Validations:

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

Validations:

  • Must be a String
>>>

POST /api/roles
Create a role

Params

Param Name Description
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: en-GB.apipie.nil_allowed">Nil Allowed</span>

Role description

Validations:

  • Must be a String
role[location_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.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: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE organisations 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 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: en-GB.apipie.nil_allowed">Nil Allowed</span>

Role description

Validations:

  • Must be a String
role[location_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.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: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE organisations 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 a String
>>>

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

Params

Param Name Description
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: en-GB.apipie.nil_allowed">Nil Allowed</span>

Role description

Validations:

  • Must be a String
role[location_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.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: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE organisations with given ids.

Validations:

  • Must be an array of any type