Documentatie
Moeilijkheidsgraad:
API - Hook - POST hook/resource/
Inkomende hook om een resource te maken of bij te werken.
POST hook/resource/
Gebruikt voor
Inkomende hook om een resource te maken of bij te werken.
Een resource kan een locatie of personeel of standaard type zijn.
Authenticatie
Gebruiker dient ingelogd te zijn op beheerdersniveau.
Parameters
Deze tabel geeft een aantal van de kern variabelen weer.
| Parameter | Omschrijving | Verplicht | Locatie | Voorbeeld |
|---|---|---|---|---|
| id | Resource ID | Nee* | Body | |
| external_id | Indien opgegeven wordt een resource gezocht met dit externe id | Nee* | Body | |
| desc | De omschrijving | Nee | Body | |
| long_desc | De uitgebreide omschrijvinhg | Nee | Body | |
| type | 1=Locatie, 2=Personeel, 3=Standaard | Nee | Body | |
| before | Tijd ervoor in minuten | Nee | Body | |
| after | Tijd erna in minuten | Nee | Body | |
| amount | Aantal, standaard 1 | Nee | Body |
* Geen van de variabelen is primair verplicht. Een juiste combinatie van variabelen is wel verplicht en bepaalt de uit te voeren actie.
- Indien "id" opgegeven, dan wordt de resource bijgewerkt met de opgegeven velden.
- Indien "id" niet is opgegeven maar "external_id" wel dan wordt de resource bijgewerkt met dat external_id
- Indien "id" en "external_id" niet zijn opgegeven òf deze zijn opgegeven maar kunnen niet gevonden worden, dan wordt een nieuwe resource gemaakt.
Voorbeeld
Maken resource "BAAN1".
POST api/rest/hook/resource/
Request
{
"external_id": "3114hqq4rqsvlhgr8s66msvju9",
"type": "3",
"name": "BAAN1",
"desc": "Tennis baan 1"
}
Response:
{
"ownerid": "10",
"name": "BAAN1",
"desc": "Tennis baan 1",
"long_desc": "",
"type": "3",
"before": "",
"after": "",
"amount": "1",
"external_id": "3114hqq4rqsvlhgr8s66msvju9"
}
Als resources worden aangemaakt via een externe bron, dan dienen de resources nog wel gekoppeld te worden aan objecten voordat ze functioneel in gebruik genomen kunnen worden. Deze API is met name geschikt voor het bijwerken van attributen van bestaande resources.
