| Table of Contents | ||||
|---|---|---|---|---|
|
...
[Navngivning af metoder adskiller sig fra Datafordelerens retningslinjer (se datafordeler.dk), idet specifikationerne for CPR's tjenester er udarbejdet før udgivelse af retningslinjerne.]
Eksempel på count: count.json
PersonFull.json, PersonMedium.json og PersonSmall.json er hentet fra CPR's demodata (test04) den 14. februar 2020. Der er ikke garanti for, at eksemplerne over tid vil matche JSON schermes.
...
Anvendelse af query params (parametre)
Query params anvender GET parametre anvendes i en HTTP GET request, og indgår således i HTTP requestens query string som field-value pairs.
Ønskes alle oplysninger på én person med pnr = 1111111111 anvendes PersonFullListSimple med query param pnr.personnumer.eq:
...
Ønskes alle oplysninger på flere personer, som indentificeres ved anvendelse af personnummer, anvendes:
| Code Block | ||
|---|---|---|
| ||
https://.../CprPersonFullSimple/1/rest/PersonFullListSimple?pnr.personnummer.wi=1111111111|2222222222|3333333333 |
...
CPR's tjenester på Datafordeleren understøtter understøtter ikke, at det samme query param field anvendes flere gange i samme query string.
...
Hver query param tilføjes endvidere et subfix i form af et operatornavn. Eksempelvis
| Code Block | ||
|---|---|---|
| ||
pnr.personnummer.eq pnr.personnummer.wi |
...
Ikke alle query params vil understøtte alle operatorer. Eksempelvis vil kun query params, hvor value skal kunne kan parses til en integer eller date, kunne anvendes med gt (greather than).
...
Det bemærkes, at retursvaret fra datafordeleren ikke indeholder information om count, page og pagesize. Det er således op til anvenderen selv at holde styr på, hvilken page , der returneres.
Idet count ikke indgår i retursvaret kan det overvejes først at kalde tjenesten med param count=true, hvorved retursvaret kun indeholder count. Derved kan det regnes ud, hvor mange gange tjenesten skal kaldes, således at alle personer, der opfylder søgekriterierne, returneres. Dvs. antal_kald = Math.ceil(count / pagesize). Det bemærkes, at en tjeneste kan kaldes asynkront, hvorved den samlede svartid givetvis vill kunne forbedres.
...
maksimalt returnere en liste med ét objekt/én person (pagesize=1). Bemærk, at der ikke er garanti for, at det er personen med pnr 2222222222 (Bemærk: Første page er tilsyneladende 1, ikke 0 - læs mere herom på datafordeler.dk).
For det første er der ikke garanti for i hvilken rækkefølge en liste af parametre behandles på Datafordeleren. For det andet kan det være, at der ikke findes en person med pnr = 1111111111 , hvorved personen med pnr = 2222222222 (hvis denne person findes) vil fremgå på første page.
...