Roles

>>>

GET /api/roles
Llista tots els rols

Params

Param Name Description
search
Optional

filtra els resultats

Validations:

  • Must be a String
order
Optional

ordena els resultats

Validations:

  • Must be a String
page
Optional

pagina els resultats

Validations:

  • Must be a String
per_page
Optional

Nombre d'entrades per petició

Validations:

  • Must be a String
>>>

GET /api/roles/:id
Mostra un rol

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
Crea un rol

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: ca.apipie.nil_allowed">Nil Allowed</span>

Descripció del rol

Validations:

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

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
role[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
>>>

PUT /api/roles/:id
Actualitza un rol

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: ca.apipie.nil_allowed">Nil Allowed</span>

Descripció del rol

Validations:

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

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
role[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
>>>

DELETE /api/roles/:id
Suprimeix un rol

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: ca.apipie.nil_allowed">Nil Allowed</span>

Descripció del rol

Validations:

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

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
role[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type