Startmomenten

Changelog

2.0.0

Breaking change: the datetime field no longer accepts a seconds component other than zero. The seconds component may be omitted or :00.

Create

POST /api2/startmomenten

Maak een nieuw startmoment

Voorbeeld request:

POST /api2/startmomenten HTTP/1.1
Host: demo.recras.nl
Accept: application/json

{
      "startmomentgroep_id": 1,
      "datetime": "2019-01-01 12:00:00",
      "percentage_materiaal_online_boeking": null,
}

Voorbeeld response:

HTTP/1.1 201 Created
Content-Type: application/json
Location: /api2/startmomenten/42

{
      "id": 42,
      "startmomentgroep_id": 1,
      "datetime": "2019-01-01 12:00:00",
      "percentage_materiaal_online_boeking": null,
}
JSON Parameters:

  • startmomentgroep_id (int) – Verplicht Het ID van de startmomentgroep

  • datetime (datetime) – Verplicht De ISO8601-datum van de startmoment

Status Codes:

Create batch

POST /api2/startmomenten/batch

Maak meerdere nieuwe startmoment in een keer

Voorbeeld request:

POST /api2/startmomenten/batch HTTP/1.1
Host: demo.recras.nl
Accept: application/json

{
      "startmomentgroep_id": 1,
      "datum_begin": "2019-01-01",
      "datum_eind": "2019-01-31",
      "interval": "1:0",
      "tijdbegin": "2019-01-01T10:00:00.000Z",
      "tijdeind": "2019-01-01T15:00:00.000Z",
      "percentage_materiaal_online_boeking": null,
      "weekdagen": [1, 2, 3, 4, 5],
}

Voorbeeld response:

HTTP/1.1 201 Created
Content-Type: application/json
Location: /api2/startmomenten/batch
JSON Parameters:

  • startmomentgroep_id (int) – Verplicht Het ID van de startmomentgroep

  • datum_begin (date) – Verplicht De ISO8601-datum van het eerste startmoment

  • datum_eind (date) – Verplicht De ISO8601-datum van het laatste startmoment

  • interval (string) – Verplicht Interval tussen de startmomenten, in notatie uren:minuten

  • tijdbegin (datetime) – Verplicht De ISO8601-tijd van het eerste startmoment op elke dag

  • tijdeind (datetime) – Verplicht De ISO8601-tijd van het laatste startmoment op elke dag

  • weekdagen (array) – Verplicht Op welke weekdagen startmomenten worden toegevoegd. 0 = zondag, 1 = maandag, etc.

Status Codes:

Read

GET /api2/startmomenten

De startmomenten in Recras

Query Parameters:

  • embed (objectnaam) – Kommagescheiden lijst van objecten om in de resultatenlijst op te nemen. Mogelijke objectnamen zijn TaribaseArrangement, Producten. Zie ook _arrangementen </arrangementen> en _ProductenList </producten>

Voorbeeld request:

GET /api2/startmomenten HTTP/1.1
Host: demo.recras.nl
Accept: application/json

Voorbeeld response:

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

[
   {
      "id": 42,
      "startmomentgroep_id": 1,
      "datetime": "2019-01-01 12:00:00",
      "percentage_materiaal_online_boeking": null,
   },
]
Status Codes:
GET /api2/startmomenten/(int: id)

Een specifiek startmoment

Example request:

GET /api2/startmomenten/42 HTTP/1.1
Host: demo.recras.nl
Accept: application/json

Example response:

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

{
   "id": 42,
   "startmomentgroep_id": 1,
   "datetime": "2019-01-01 12:00:00",
   "percentage_materiaal_online_boeking": null,
}
Status Codes:

Update

PUT /api2/startmomenten/(int: id)

Voorbeeld request:

PUT /api2/startmomenten/42 HTTP/1.1
Host: demo.recras.nl
Accept: application/json

{
   "id": 42,
   "startmomentgroep_id": 1,
   "datetime": "2019-01-01 12:30:00",
   "percentage_materiaal_online_boeking": 80,
}

Voorbeeld response:

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

{
   "id": 42,
   "startmomentgroep_id": 1,
   "datetime": "2019-01-01 12:30:00",
   "percentage_materiaal_online_boeking": 80,
}
JSON Parameters:

  • id (int) – ID-nummer, mag niet veranderd worden

Status Codes:

Delete

DELETE /api2/startmomenten/(int: id)

Voorbeeld request:

DELETE /api2/startmomenten/42 HTTP/1.1
Host: demo.recras.nl

Voorbeeld response:

HTTP/1.1 200 OK
Status Codes:

  • 200 OK – Startmoment verwijderd

  • 403 Forbidden – Gebruiker heeft het recht editStartmomenten niet

Delete batch

DELETE /api2/startmomenten/batch

Voorbeeld request:

DELETE /api2/startmomenten/batch HTTP/1.1
Host: demo.recras.nl

{
      "startmomentgroep_id": 1,
      "datum_begin": "2019-01-01",
      "datum_eind": "2019-01-31",
      "weekdagen": [1, 2, 3, 4, 5],
}

Voorbeeld response:

HTTP/1.1 200 OK
Status Codes:

  • 200 OK – Startmomenten verwijderd

  • 403 Forbidden – Gebruiker heeft het recht editStartmomenten niet

Error codes

With the Create or Update actions, these endpoint specific error messages may be encountered:

ERR_SECONDS_MUST_BE_ZERO

The seconds component of the timestamp must be zero.