BObookingexperts
Periods

GET periods

Changed on

Returns periods of the administration

get/v3/administrations/{administration_id}/periods

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id

fields[period]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[name]string

Filter on name

filter[period_entries]string

Filter on period_entries. Specify a comma separated list of IDs to filter on.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

PeriodCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "period",
      "relationships": {
        "period_entries": {
          "data": [
            {
              "type": "period_entry"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "period_entry"
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status