GET
/
api
/
v1
/
role_groups
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "gender": "<string>",
      "minAge": 123,
      "maxAge": 123,
      "onlyFullMember": true,
      "region": "https://example.com/",
      "id": 123,
      "name": "<string>",
      "logo": "<string>",
      "unitType": "https://example.com/",
      "status": "<string>",
      "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

gender
string
gender[]
string[]
minAge
integer
minAge[]
integer[]
maxAge
integer
maxAge[]
integer[]
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

RoleGroup collection

The response is of type object.