EmployerLastModifiedVersionNumbersByUser: Loket.nl REST itgen_loketnl_employerlastmodifiedversionnumbersbyuser_plural
read only REST
- Catalogus:
LoketNlRest - Schema:
LastModifiedVersionNumbers - Label: itgen_loketnl_employerlastmodifiedversionnumbersbyuser_plural
Lijst met laatst gewijzigde versienummers van werkgevers Activiteitsnaam : GetEmployerLastModifiedVersionNumbersByUser
Wat geeft het versienummer 'laatst gewijzigd' weer
Het volgnummer van een werkgever is een oplopend nummer dat weergeeft of er wijzigingen zijn opgetreden in een van de ONDERLIGGENDE dienstverbanden.
Concreet geeft het het volgnummer weer na de laatste wijziging van een databaserecord dat betrekking heeft op een dienstverband binnen deze werkgever. Wat we als 'onderliggende' dienstverbandgegevens beschouwen, is gebaseerd op een vooraf gedefinieerde set tabellen, en uiteraard het opgegeven id. Deze vooraf gedefinieerde set tabellen is hier
De reikwijdte van deze vooraf gedefinieerde set is het weergeven van 'statische' werknemersgegevens (vaste gegevens), en sluit dus periodegegevens van de loonadministratie (variabele gegevens) uit.
Wanneer gebruiken
Dit eindpunt is het nuttigst voor integraties die Loket-dienstverbandgegevens regelmatig synchroniseren met een ander systeem. Aangezien er geen webhooks beschikbaar zijn, moeten deze integraties in de praktijk regelmatig alle gegevens opvragen om te zien of er wijzigingen in de dienstverbandgegevens zijn. De meest elementaire aanpak, waarbij bij elke synchronisatie alle dienstverbandgegevens worden opgehaald, leidt tot een ENORM aantal aanroepen, in sommige gevallen zelfs miljoenen per dag. Hoewel we best veel aankunnen, is dit niet altijd de gewenste manier voor zowel client als server. Dit eindpunt biedt daarom een alternatieve oplossing om een dergelijke integratie op te zetten.
Gebruik
Bij elke wijziging (inclusief toevoegingen en verwijderingen) wordt het versienummer verhoogd. Dat wil zeggen: het versienummer zal NOOIT in de loop van de tijd dalen. (Let op: dit geldt niet alleen binnen één werkgever (of andere entiteit), maar voor alle wijzigingen in de database). In de praktijk gebruik je dit eindpunt dus om te controleren of versienummers van empLoyer zijn verhoogd, door de filterqueryparameter toe te passen op het versieveld, bijvoorbeeld ?filter=version gt 70429274.
Aanbevolen gebruik
- Voer je reguliere synchronisatie van statische dienstverbandgegevens uit
- Sla het hoogste versienummer op waarvoor je nu alle wijzigingen hebt verwerkt. (Hiervoor kun je de volgende parameter gebruiken
?orderBy=-lastModifiedVersionNumber) - De volgende keer dat u synchronisatie wilt uitvoeren. Roep dit endpoint aan met parameter
?filter=lastModifiedVersionNumber gt {{YourVersionNumber}} - Haal dienstverbandinformatie alleen op voor werkgevers die in die gefilterde lijst zijn opgenomen. (sluit alle andere werkgevers uit, omdat je weet dat er sinds de laatste synchronisatie geen wijzigingen zijn)
Kan alleen gegevens ophalen.
API-bron
- Eindpunt:
/providers/employers/lastmodifiedversionnumbers - Operatie:
get /providers/employers/lastmodifiedversionnumbers
Tabelkolommen
De kolommen van de tabel EmployerLastModifiedVersionNumbersByUser worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype. Voor elke vereiste kolom moet bij het invoegen en bijwerken steeds een nieuwe, niet-lege waarde worden opgegeven.
| Name | Datatype | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
id |
guid |
ID | De unieke identificatie van een object (GUID/UUID) | ||
last |
int64 |
itgen_loketnl_lastmodifiedversionnumber | Het versienummer geeft de laatste versie weer van alle vooraf gedefinieerde onderliggende tabellen van deze werkgever/dit dienstverband. |
Release Notes
Wat is er per release veranderd in de tabellen, kolommen, attributen en mogelijkheden van de driver: