Materialen

Huidige versie: 1.0.0

Create

POST /api2/materialen

Maak een nieuwe materiaal

Voorbeeld request:

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

{
   "naam": "Fiets",
}

Voorbeeld response:

HTTP/1.1 201 Created
Content-Type: application/json
Location: /api2/materialen/5

{
   "id": 1,
   "naam": "Fiets",
   "aantal": null,
   "aantal_groepen": null,
   "aantal_tegelijk_starten": null,
   "aantal_groepen_tegelijk_starten": null,
   "overzichtmenu": false,
   "percentage_online_te_boeken": 0
}

JSON Parameters:

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

• naam (string) – Naam van het materiaal

• aantal (int) – Aantal dat van dit materiaal beschikbaar is

• aantal_groepen (int) – Maximaal aantal boekingen waarover dit materiaal verdeeld kan worden

• aantal_tegelijk_starten (int) – Aantal van dit materiaal dat op het zelfde moment uitgegeven kan worden

• aantal_groepen_tegelijk_starten (int) – Aantal boekingen dat tegelijk met dit materiaal kan beginnen

• overzichtsmenu (boolean) – Of dit materiaal in het overzichtsmenu in Recras getoond moet worden

• percentage_online_te_boeken (int) – Het percentage van dit materiaal dat maximaal uitgegeven mag worden via online boekingen

Response Headers:

• Location – De locatie van het nieuwe materiaal

Status Codes:

• 201 Created – Materiaal gemaakt

• 406 Not Acceptable – Fout in de invoer

• 403 Forbidden – Gebruiker heeft het recht editMateriaal niet

Read

GET /api2/materialen

De materialen in Recras

Voorbeeld request:

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

Voorbeeld response:

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

[
   {
      "id": 1,
      "naam": "Fiets",
      "aantal": 25,
      "aantal_groepen": null,
      "aantal_tegelijk_starten": null,
      "aantal_groepen_tegelijk_starten": null,
      "overzichtmenu": false,
      "percentage_online_te_boeken": 0
   }
]

Status Codes:

• 200 OK – no error

GET /api2/materialen/(int: id)

Een specifieke materiaal

Example request:

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

Example response:

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

{
   "id": 1,
   "naam": "Fiets",
   "aantal": 25,
   "aantal_groepen": null,
   "aantal_tegelijk_starten": null,
   "aantal_groepen_tegelijk_starten": null,
   "overzichtmenu": false,
   "percentage_online_te_boeken": 0
}

Status Codes:

• 200 OK – OK

• 404 Not Found – Geen materiaal met deze id

Update

PUT /api2/materialen/(int: id)

Voorbeeld request:

PUT /api2/materialen/1 HTTP/1.1
Host: demo.recras.nl
Accept: application/json

{
   "id": 1,
   "naam": "Fiets",
   "aantal": 20,
   "overzichtmenu": true
}

Voorbeeld response:

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

{
   "id": 1,
   "naam": "Fiets",
   "aantal": 20,
   "aantal_groepen": null,
   "aantal_tegelijk_starten": null,
   "aantal_groepen_tegelijk_starten": null,
   "overzichtmenu": true,
   "percentage_online_te_boeken": 0
}

JSON Parameters:

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

• naam (string) – Naam van het materiaal

• aantal (int) – Aantal dat van dit materiaal beschikbaar is

• aantal_groepen (int) – Maximaal aantal boekingen waarover dit materiaal verdeeld kan worden

• aantal_tegelijk_starten (int) – Aantal van dit materiaal dat op het zelfde moment uitgegeven kan worden

• aantal_groepen_tegelijk_starten (int) – Aantal boekingen dat tegelijk met dit materiaal kan beginnen

• overzichtsmenu (boolean) – Of dit materiaal in het overzichtsmenu in Recras getoond moet worden

• percentage_online_te_boeken (int) – Het percentage van dit materiaal dat maximaal uitgegeven mag worden via online boekingen

Status Codes:

• 200 OK – Materiaal aangepast

• 406 Not Acceptable – Fout in de invoer

• 403 Forbidden – Gebruiker heeft het recht editMateriaal niet

Delete

DELETE /api2/materialen/(int: id)

Voorbeeld request:

DELETE /api2/materialen/1 HTTP/1.1
Host: demo.recras.nl

Voorbeeld response:

HTTP/1.1 200 OK

Status Codes:

• 200 OK – Materiaal verwijderd

• 403 Forbidden – Gebruiker heeft het recht editMateriaal niet