Perusteet
Toegestane HTTP-verbs zijn GET, PATCH, POST en DELETE. Hier zijn gedetailleerde beschrijvingen van de oproep types:
- GET: Gegevens ophalen van Severa
- PATCH: Bestaande gegevens bijwerken
- JSON Patch is het formaat dat wordt gebruikt om gegevens bij te werken in de REST API (meer informatie op: http://jsonpatch.com/).
- Alleen Replace (vervangen) wordt ondersteund.
- POST: Nieuwe gegevens aanmaken in Severa
- DELETE: Gegevens verwijderen uit Severa.
- Gebruik voorzichtig, want verwijderde gegevens worden volledig verwijderd
- Oproep antwoordcodes zijn Success, Created en Bad request
Sivutus
Standaard worden er voor elke GET-oproep 20 rijen opgehaald, en het maximum is 1000. De parameters zijn firstRow en rowCount. Aanbevolen voor gebruik bij zware oproepen.
Tekstin haku
De parameter textToSearch kan worden gebruikt voor snelle zoekopdrachten. Bijvoorbeeld, in de GET/users oproep is er een parameter waarmee je kunt zoeken op gebruikersnaam, code, e-mail of trefwoorden. Voor elke route zijn de velden waarop gezocht wordt, gedefinieerd in de technische documentatie.
Lajittelu
Gedefinieerd in veel GET all for routes als queryparameter. Het ondersteunt het geven van meerdere waarden. Voorbeeld:
- ?sortings[0]
- [key]=lastUpdatedDateTime&sortings[0]
- [value]=Desc&sortings[1]
- [key]=createdDateTime&sortings[1]
- [value]=Asc
Changed since
Parameter voor het ophalen van gegevens vanaf een bepaalde datum. Met deze parameter kun je gegevens ophalen die zijn gewijzigd na de opgegeven datum. Bijvoorbeeld, in de GET/users oproep is er een ChangedSince parameter waarmee je gebruikers kunt krijgen die zijn toegevoegd of gewijzigd na deze datum (groter dan of gelijk aan).
Laajuudet (Scopes)
Momenteel is alleen SeveraAll beschikbaar, maar scopes worden toegevoegd naarmate ze worden geïmplementeerd.
Was dit antwoord nuttig? Ja Nee
Feedback versturen