Roles

>>>

GET /api/roles
List all roles

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. ‘

Maruku could not parse this XML/HTML: 
<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
builtin true, false
description text
id integer
name string
permission string
>>>

GET /api/roles/:id
Show a role

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
description
optional

Validations:

  • String
>>>

POST /api/roles
Create a role

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
role
required

Validations:

  • Hash
role[name]
required

Validations:

  • String
role[description]
optional , nil allowed

Role description

Validations:

  • String
role[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

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

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

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
role
required

Validations:

  • Hash
role[name]
optional

Validations:

  • String
role[description]
optional , nil allowed

Role description

Validations:

  • String
role[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

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

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

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
>>>

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

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • String
role
required

Validations:

  • Hash
role[name]
optional

Validations:

  • String
role[description]
optional , nil allowed

Role description

Validations:

  • String
role[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

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

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type