Packages-Availability (Arrangementen-Beschikbaarheid)

Current version: 1.2.0

This API is only available in Recras instances created before October 11, 2022, where online booking of `arrangementen` (packages) is enabled.

Read

GET /api2/arrangementen/(int: arrangement_id)/beschikbaarheid

Get a list of startmomenten (start times) and beschikbare eenheden (available units) for the arrangement (package) with id arrangement_id (package_id). Only available for arrangementen (packages) with the setting mag_beschikbaarheidskalender_api (may_use_availability_calendar_api).

Query Parameters:

  • eind (date) – Required an ISO8601 date indicating the end of the date range. The specified date is inclusive. (eind means end)

  • begin (date) – Default: today an ISO8601 date indicating the start of the desired date range. The specified date is inclusive. (begin means start, vandaag means today)

Status Codes:

Example request:

GET /api2/arrangementen/7/beschikbaarheid?begin=2017-05-11&eind=2017-05-11 HTTP/1.1
Host: demo.recras.nl
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
   {
       "startmoment": "2017-05-11T13:00:00+02:00", // start time
       "beschikbaarheid": 500, // availability
       "beschikbaarheidOnline": 500, // online availability
       "arrangementsregels": [{ // package lines
          "arrangementsregel_id": 1, // package line id
          "start": "2017-05-11T13:00:00+02:00", // start time
          "beschikbaarheid": 500, // availability
          "beschikbaarheidOnline": 500 // online availability
       }, {
          "arrangementsregel_id": 2, // package line id
          "start": "2017-05-11T13:00:00+02:00", // start time
          "beschikbaarheid": 500, // availability
          "beschikbaarheidOnline": 500 // online availability
       }]
   },
   {
       "startmoment": "2017-05-11T13:30:00+02:00", // start time
       "beschikbaarheid": 468, // availability
       "beschikbaarheidOnline": 468, // online availability
       "arrangementsregels": [{ // package lines
          "arrangementsregel_id": 1, // package line id
          "start": "2017-05-11T13:30:00+02:00", // start time
          "beschikbaarheid": 468, // availability
          "beschikbaarheidOnline": 468 // online availability
       }, {
          "arrangementsregel_id": 2, // package line id
          "start": "2017-05-11T13:30:00+02:00", // start time
          "beschikbaarheid": 500, // availability
          "beschikbaarheidOnline": 500 // online availability
       }]
   }
]
GET /api2/arrangementen/beschikbaarheid

Get a list of (startmoment (start time), arrangement_id (package_id)) and beschikbare eenheden (available units) for all arrangementen (packages) with the setting mag_beschikbaarheidskalender_api (may_use_availability_calendar_api). The maximum runtime of this endpoint is approximately 0:20 minutes; if the beschikbaarheid (availability) calculation takes more time, a partial result is returned.

Query Parameters:

  • eind (date) – Required an ISO8601 date indicating the end of the date range. The specified date is inclusive. (eind means end)

  • begin (date) – Default: today an ISO8601 date indicating the start of the desired date range. The specified date is inclusive. (begin means start, vandaag means today)

Status Codes:

  • 200 OK – OK

  • 406 Not Acceptable – Error in the specified query parameters. See the message velden (fields) of JSON maps in the returned JSON array.

Header Link:

When a partial result is returned, a Link header with link-relation next is present. This contains a URI pointing to the next (partial) result. It is possible that the next partial result contains some results that were already returned.

Example request

GET /api2/arrangementen/beschikbaarheid?begin=2017-05-01&eind=2017-05-31 HTTP/1.1
Host: demo.recras.nl
Accept: application/json

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Link: </api2/arrangementen/beschikbaarheid?begin=2017-05-12&eind=2017-05-31>; rel="next"

[
   {
       "startmoment": "2017-05-11T13:00:00+02:00", // start time
       "arrangement_id": 2, // package_id

       "beschikbaarheid": 500, // availability
       "beschikbaarheidOnline": 500 // online availability
   },
   {
       "startmoment": "2017-05-11T13:00:00+02:00", // start time
       "arrangement_id": 4, // package_id

       "beschikbaarheid": 468, // availability
       "beschikbaarheidOnline": 468 // online availability
   }
]