Getting a list of user roles

Request

Returns a list of user roles along with permissions for each role.

Security

BearerPartnerUser

Path

location_idnumberrequired

ID of a location.

Example:123

Query

includeArray of strings

Requested set of an included models.

Items Value:"user_permissions"

Acceptstringrequired

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Default:"application/vnd.api.v2+json"

Example:application/vnd.api.v2+json

Content-Typestringrequired

Should be equal to application/json

Example:application/json

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/123/users/roles?include=user_permissions' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json'

Responses

OK

Bodyapplication/json

successboolean(Successful response status)

Response status.

Example:true

dataArray of objects(Model object "User role")

Example:

[
  {
    "slug": "staff_member",
    "title": "team member",
    "description": "Provides services",
    "weight": 1,
    "user_permissions": [ … ]
  }
]

metaArray of any or object(Empty meta object)

Additional response data (empty object or empty array)

Example:

{}

Response

{
  "success": true,
  "data": [
    { … }
  ],
  "meta": {}
}