Locaties

Huidige versie: 1.0.0

Create

POST /api2/locaties

Maak een nieuwe locatie aan

Voorbeeld request

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

{
   "naam": "kleine zaal",
   "weergavenaam": "vergaderzaal (tot 15 p.)",
   "capaciteit": 20,
   "aantal_groepen": 1
}

Voorbeeld response

HTTP/1.1 201 Created
Content-Type: application/json
Location: /api2/locaties/12

{
   "id": 12,
   "naam": "kleine zaal",
   "kleur": null,
   "weergavenaam": "vergaderzaal (tot 15 p.)",
   "adres": null,
   "postcode": null,
   "plaats": null,
   "telefoonnummer": null,
   "latitude": null,
   "longitude": null,
   "capaciteit": 20,
   "aantal_groepen": 1,
   "parent_id": null
}
JSON Parameters:

  • naam (string) – Verplicht Naam van de locatie

  • kleur (string) – Default: null Kleur voor in dagplanning

  • weergavenaam (string) – Default: null Naam die naar klanten wordt weergegeven

  • adres (string) – Default: null Adres van de locatie

  • postcode (string) – Default: null Postcode van de locatie

  • plaats (string) – Default: null Plaats van de locatie

  • telefoonnummer (string) – Default: null Telefoonnummer van de locatie

  • latitude (float) – Default: null GPS-breedtegraad van de locatie (decimaal)

  • longitude (float) – Default: null GPS-lengtegraad van de locatie (decimaal)

  • capaciteit (integer) – Default: null Aantal personen dat maximaal tegelijk aanwezig kan zijn

  • capaciteit – Default: null Aantal boekingen dat maximaal tegelijk plaats kan vinden

  • parent_id (integer) – Default: null De id van de locatie waar deze locatie deel van is

Response Headers:

  • Location – De http-locatie van de nieuwe locatie

Status Codes:

Read

GET /api2/locaties

Lijst van locaties in Recras

Voorbeeld request:

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

Voorbeeld response:

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

[
   {
      "id": 5,
      "naam": "Paintball",
      "kleur": "#e6ead1",
      "weergavenaam": "Paintball",
      "adres": "",
      "postcode": "",
      "plaats": "",
      "telefoonnummer": "",
      "latitude": null,
      "longitude": null,
      "capaciteit": 40,
      "aantal_groepen": 2,
      "parent_id": null
   },
   {
      "id": 9,
      "naam": "Paintball \"het Bos\"",
      "kleur": "#23d421",
      "weergavenaam": "Paintball \"het Bos\"",
      "adres": "",
      "postcode": "",
      "plaats": "",
      "telefoonnummer": "",
      "latitude": null,
      "longitude": null,
      "capaciteit": 15,
      "aantal_groepen": 1,
      "parent_id": 5
   }
]
Query Parameters:

  • treeContains – Een kommagescheiden lijst van locatie-ids, geeft alle locaties die een van de opgegeven ids in de boomstructuur bevatten.

  • embedGebruikOpDatum – Een datum waarvoor de gebruiksinformatie (hoeveel personen en groepen zijn er van moment tot moment) getoond moet worden

Status Codes:
GET /api2/locaties/(int: id)

Een specifieke betaalmethode

Query Parameters:

  • embedGebruikOpDatum – Een datum waarvoor de gebruiksinformatie (hoeveel personen en groepen zijn er van moment tot moment) getoond moet worden

Status Codes:

Update

PUT /api2/locaties/(int: id)

Zie POST /api2/locaties

Delete

DELETE /api2/locaties/(int: id)

Voorbeeld request:

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

Voorbeeld response:

HTTP/1.1 200 OK
Status Codes: