BObookingexperts
AgendaPeriods

GET agenda_periods

Changed on

Returns agenda periods of the administration

get/v3/administrations/{administration_id}/agenda_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, created_at, updated_at

fields[agenda_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[memo]string

Filter on memo

filter[start_date]string

Filter on start_date

filter[end_date]string

Filter on end_date

filter[type]string

Filter on type

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[rentable]string

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

filter[inventory_object]string

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

filter[reservation]string

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

include_archivedboolean

When true, agenda periods of archived inventory objects are included in the response

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

AgendaPeriodCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "agenda_period",
      "relationships": {
        "rentable": {
          "data": {
            "type": "rentable"
          }
        },
        "inventory_object": {
          "data": {
            "type": "inventory_object"
          }
        },
        "reservation": {
          "data": {
            "type": "reservation"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "rentable",
      "relationships": {
        "category": {
          "data": {
            "type": "category"
          }
        },
        "rentable_type": {
          "data": {
            "type": "rentable_type"
          }
        },
        "rentable_identity": {
          "data": {
            "type": "rentable_identity"
          }
        },
        "inventory_object": {
          "data": {
            "type": "inventory_object"
          }
        },
        "rentable_amenities": {
          "data": [
            {
              "type": "rentable_amenity"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • warning

      added the new da-DK enum value to the /////// response property for the response status

    • warning

      added the new en-GB enum value to the /////// response property for the response status

    • warning

      added the new en-US enum value to the /////// response property for the response status

    • info

      added the new optional query request parameter filter[memo]

    • 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

    • 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

    • info

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

    • info

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