Endpoints en verzoeken
Alle API-paden zijn versies onder /v2. Gebruik de basis-URL en voeg het endpointpad toe.
GET https://api.alarmira.com/v2/alarms?offset=0&limit=20HTTP-methodes
Section titled “HTTP-methodes”- GET leest data.
- POST maakt nieuwe resources aan.
- PATCH werkt een deel van een resource bij.
- PUT vervangt een resource.
- DELETE verwijdert een resource.
Padparameters
Section titled “Padparameters”Paden gebruiken accolades om vereiste IDs aan te duiden, bijvoorbeeld /v2/alarms/{alarmId}. Gebruik IDs uit list- of create-responses.
Query parameters
Section titled “Query parameters”List-endpoints accepteren een query parameter met deepObject syntax voor paginering, sorting en filtering. Zie Paginering en filtering voor details.
Request bodies
Section titled “Request bodies”Verstuur JSON en zet Content-Type: application/json. Request schemas staan per endpoint in de Referentie.
Responsevorm
Section titled “Responsevorm”List-endpoints retourneren een paged envelope met items en paging metadata.
{ "items": [], "offset": 0, "limit": 20, "length": 0, "hasMore": false, "total": 0}