De volgende query params zijn te gebruiker binnen de gehele API op collectie methodes
| Query Parameters | ||
|---|---|---|
limit |
Speficifeer het maximaal aantal resultaten. | Standaard waarde: 25 |
offset |
Speficifeer de offset voor het ophalen van resultaten. | Standaard waarde: 0 |
page |
Specificeer de pagina voor de resultaten, werkt samen met limit |
Standaard waarde: 1 |
GETGET Collectie
{
"response": {
"message": "success",
"exception": [],
"code": 200,
"data": {
"count": 22,
"Contacts": [
{
"Contact": {
"id": "1",
"name": "Repareerbedrijf Piet"
},
"SubContact": []
},
{
"Contact": {
"id": "2",
"name": "Avondwinkel Kees"
},
"SubContact": []
}
]
}
}
}Voor de resources zijn de meeste velden te gebruiken als query parameter om te sorteren.
GETGET Collectie
{
"response": {
"message": "success",
"exception": [],
"code": 200,
"data": {
"count": 2,
"Contacts": [
{
"Contact": {
"id": "3",
"name": "Michael & Michael",
"type": 1,
"category": "Algemeen"
},
"SubContact": []
},
{
"Contact": {
"id": "7",
"name": "Teun Trucks",
"type": 1,
"category": "Algemeen"
},
"SubContact": []
}
]
}
}
}Resources maken vaak gebruik van Containments met andere onderliggende resources.
Als voorbeeld heeft de resource contacts een containment op SubContact. Dit kan handig zijn om verdere
requests te verminderen. De functie wordt aangestuurd door een queryparameter depth.
De standaard waarde van depth staat op 2
GETGET Collectie
| Depth | Resource |
|---|---|
0 |
Geen containments |
1 |
|
2 |
|