Command Palette

Search for a command to run...

Log In
Get help

List the Public Holiday Groups of a Participant

get/public/v1/participants/{participant}/public-holiday-groups

Returns the public holiday groups the participant belongs to. Compare them with each holiday's public_holiday_groups and excluded_public_holiday_groups to tell whether the holiday applies to this participant.

Authorization

  • Authorizationstringrequired

    Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

  • participantstringrequired

    The participant UUID

Query parameters

  • sortstring

    Sort the results. Prefix with '-' for descending. One of: name. Defaults to name ascending.

    Example:name
  • page[size]integer

    Number of results per page. Minimum 1, maximum 100.

    Default:25
  • page[number]integer

    The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.

    Default:1

Response

200application/json

Paginated set of PublicHolidayGroupResource

  • dataobject[]required
    ▶Show 2 child attributes
    • idstringrequired
      Example:d4e5f6a7-b8c9-40d1-8e2f-3a4b5c6d7e8f
    • namestringrequired
      Example:Greater Geelong
  • metaobjectrequired
    ▶Show 5 child attributes
    • current_pageintegerrequired≥ 1
    • last_pageintegerrequired≥ 1
    • per_pageintegerrequired≥ 0

      Number of items shown per page.

    • totalintegerrequired≥ 0

      Total number of items being paginated.

    • allowed_sortsstring[]required

      The list of allowed sorts for this endpoint.

Errors

  • 401Unauthenticated
  • 403Authorization error
  • 404Not found