GET
/
api
/
v1
/
roles
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>",
      "namePlural": "<string>",
      "unitType": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "namePlural": "<string>",
        "discriminator": "<string>",
        "isLocal": true,
        "parentUnitType": {},
        "hasUserType": true
      },
      "position": 123,
      "isUserType": true,
      "options": [
        "<string>"
      ],
      "isLocalCenter": true,
      "isLocalCenterParent": true,
      "isNational": true,
      "permissions": [
        "<string>"
      ],
      "chartName": "<string>"
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

page
integer
default:1

The collection page number

pagination
boolean

Enable or disable pagination

isUserType
boolean
isUserType[]
boolean[]
isLocalCenter
boolean
isLocalCenter[]
boolean[]
isNational
boolean
isNational[]
boolean[]
order[position]
enum<string>
default:asc
Available options:
asc,
desc
order[id]
enum<string>
default:asc
Available options:
asc,
desc
order[name]
enum<string>
default:asc
Available options:
asc,
desc
order[unitType.id]
enum<string>
default:asc
Available options:
asc,
desc
exists[isLocalCenter]
boolean

Response

200
application/ld+json

Role collection

The response is of type object.