Arrangementen-Beschikbaarheid

Huidige versie: 1.2.0

Deze API is alleen beschikbaar in Recrassen die gemaakt zijn vóór 11 oktober 2022, waar het online boeken van arrangementen aan staat.

Read

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

Verkrijg een lijst van startmomenten en beschikbare eenheden voor het arrangement met id arrangement_id. Alleen beschikbaar voor arrangementen met de instelling mag_beschikbaarheidskalender_api.

Query Parameters:

  • eind (date) – Verplicht een ISO8601-datum die het eind van de datumreeks aangeeft. De opgegeven datum valt binnen het bereik.

  • begin (date) – Default: vandaag een ISO8601-datum die het begin van de gewenste datumreeks aangeeft. De opgegeven datum valt binnen het bereik.

Status Codes:

Voorbeeld request:

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

Voorbeeld response:

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

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

Verkrijg een lijst van (startmoment, arrangement-id) en beschikbare eenheden voor alle arrangementen met de instelling mag_beschikbaarheidskalender_api. De maximale runtime van dit endpoint is ongeveer 0:20 minuten, wanneer de berekening van beschikbaarheid meer tijd vergt wordt een gedeeltelijk resultaat opgeleverd.

Query Parameters:

  • eind (date) – Verplicht een ISO8601-datum die het eind van de datumreeks aangeeft. De opgegeven datum valt binnen het bereik.

  • begin (date) – Default: vandaag een ISO8601-datum die het begin van de gewenste datumreeks aangeeft. De opgegeven datum valt binnen het bereik.

Status Codes:

  • 200 OK – OK

  • 406 Not Acceptable – Fout in de opgegeven query parameters. Zie de message velden van JSON-maps in de teruggegeven JSON-array.

Header Link:

Wanneer een gedeeltelijk resultaat wordt teruggegeven, is een Link-header met link-relatie next aanwezig. Deze bevat een URI die wijst naar het volgende (deel)resultaat. Het is mogelijk dat het volgende deelresultaat enkele resultaten bevat die eerder ook al teruggegeven zijn.

Voorbeeld request

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

Voorbeeld 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",
       "arrangement_id": 2,

       "beschikbaarheid": 500,
       "beschikbaarheidOnline": 500
   },
   {
       "startmoment": "2017-05-11T13:00:00+02:00",
       "arrangement_id": 4,

       "beschikbaarheid": 468,
       "beschikbaarheidOnline": 468
   }
]