BObookingexperts
Periods

POST period

Changed on

Creates a new period for the administration

post/v3/administrations/{administration_id}/periods

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

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.

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'.

Request body

Example request

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

Response

PeriodResponse

Example response

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

Changes