Home > Modules > Overzichten > OData Api

 

OData Api

Algemeen

De OData Api van Aeolus is de 'toegangspoort' naar de onderliggende database.
OData is een openstandaard, waardoor het mogelijk wordt om met andere applicaties/tools dan Aeolus de data te bevragen.
Aeolus Data ondersteunt versie 4.0 en de definitie van de Api is te bevragen d.m.v. OpenApi of via de metadata van OData.

Door middel van een http OData call kunnen de gegevens geraadpleegd worden.
Aeolus ondersteunt de meest voorkomende OData functies, zoals select, filter, count, top, skip. etc.
Het bevragen van alle data uit een element kan het beste gedaan worden met paginering,
bijv. https://..../ActueleDossiers?$top=10&$skip=20.

Voor uitgebreide informatie over de OData standaard, kun je terecht op odata.org.

De Api aanroepen

Let op! Het uitvragen van de api is beperkt tot 5000 records per request. Paging zal dus noodzakelijk zijn.

Voor het uitvragen van de KlantenNaw tabel dient het volgende request gemaakt te worden:
GET https://gateway.hene.nl/overzichten/KlantenNaw?$top=5000&$skip=0
Een volgend request zal dan zijn:
GET https://gateway.hene.nl/overzichten/KlantenNaw?$top=5000&$skip=5000

Let op! Zorg dat de headers van het request de volgende waardes bevatten:

tenantid Een unieke Id uitgegeven door Horlings & Eerbeek
Authorization 'Bearer' + accestoken

Resultaat

Het resultaat zal in JSON zijn en onderstaande opmaak hebben:
{
"@odata.context": "https://gateway.hene.nl/overzichten/$metadata#KlantenNaw",
"value": [
{
"KlantId": "",
"Bsn": "",
"Achternaam": "",
"Geboortedatum": "1983-03-02",
"VolledigeNaam": "",
"Geslacht": "Mannelijk",
"LaatsteActieBijwerken": "Gewijzigd",
"LaatstBijgewerkt": "2023-05-17 12:30:03"
}
]
}

Alleen de gewijzigde gegevens ophalen sinds de laatste keer dat je de call hebt gemaakt.

Alle tabellen bevatten de kolommen LaatsteActieBijwerken en LaatstBijgewerkt.
Vanuit de productiedatabases worden de gegevens voor de overzichten bijgewerkt. Deze 2 kolommen geven de laatste status aan van die verwerking.
LaatsteActieBijwerken kent de waardes:
  • Toegevoegd
  • Gewijzigd
  • Verwijderd
En het veld LaatstBijgwerkt geeft de datum en tijd weer van die laatste actie.
Je kan dus alle wijzigingen ophalen sinds de laatste keer dat je de Api hebt uitgevraagd. Deze datum dien je zelf vast te leggen.
Achter de url kan dan onderstaande filter worden toegevoegd
&$filter= LaatstBijgewerkt gt 2023-05-17