GET
/
api
/
v1
/
unit-user-roles
{
  "hydra:member": [
    {
      "@id": "<string>",
      "@type": "<string>",
      "@context": "<string>",
      "id": 123,
      "name": "<string>",
      "parent": {},
      "logo": "<string>",
      "unitType": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "namePlural": "<string>",
        "isLocal": true,
        "parentUnitType": {},
        "hasUserType": true
      },
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateEnded": "2023-11-07T05:31:56Z",
      "status": "ACTIVE",
      "unitRoles": [
        {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "role": {
            "@context": "<string>",
            "@id": "<string>",
            "@type": "<string>",
            "id": 123,
            "name": "<string>",
            "namePlural": "<string>",
            "position": 123,
            "options": [
              "<string>"
            ],
            "chartName": "<string>"
          }
        }
      ],
      "userType": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "namePlural": "<string>",
        "position": 123,
        "options": [
          "<string>"
        ],
        "chartName": "<string>"
      },
      "localCenter": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "localUnits": "<any>",
        "isParent": true,
        "id": 123,
        "name": "<string>",
        "logo": "<string>",
        "status": "<string>",
        "dateCreated": "2023-11-07T05:31:56Z",
        "unitType": {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "id": 123,
          "name": "<string>",
          "namePlural": "<string>",
          "isLocal": true,
          "parentUnitType": {},
          "hasUserType": true
        },
        "parent": {},
        "dateEnded": "2023-11-07T05:31:56Z",
        "unitRoles": [
          {
            "@context": "<string>",
            "@id": "<string>",
            "@type": "<string>",
            "role": {
              "@context": "<string>",
              "@id": "<string>",
              "@type": "<string>",
              "id": 123,
              "name": "<string>",
              "namePlural": "<string>",
              "position": 123,
              "options": [
                "<string>"
              ],
              "chartName": "<string>"
            }
          }
        ],
        "userType": {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "id": 123,
          "name": "<string>",
          "namePlural": "<string>",
          "position": 123,
          "options": [
            "<string>"
          ],
          "chartName": "<string>"
        },
        "localCenter": {},
        "isRoleGroup": true
      },
      "isRoleGroup": true
    }
  ],
  "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

​
isRoleGroup
boolean
​
isRoleGroup[]
boolean[]
​
parent
string
​
parent[]
string[]
​
localCenter
string
​
localCenter[]
string[]
​
status
string
​
status[]
string[]
​
unitType
string
​
unitType[]
string[]
​
order[name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[parent.name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[userType.position]
enum<string>
default:asc
Available options:
asc,
desc
​
exists[isRoleGroup]
boolean
​
exists[localCenter]
boolean
​
exists[unitType]
boolean
​
exists[parent]
boolean

Response

200
application/ld+json

Unit collection

The response is of type object.