Replikering

Replikerings-API'et gør det muligt at etablere og vedligeholde en lokal kopi af data fra DAWA. Se replikerings-guiden for information om hvordan replikerings-API'et anvendes. Se databeskrivelser for information hvilke data der udstilles på replikerings-API'et. DAWA tilbyder endvidere en reference-implementation af en replikeringsklient.

Udtræk

Modtag et komplet dataudtræk for en given entitet. Entitet-parameteren (kræves) angiver hvilken entitet, der modtages et udtræk for. Databeskrivelser for en liste af entiteter og hvilke data de forskellige entiter indeholder.

GET https://api.dataforsyningen.dk/replikering/udtraek

Parametre

NavnBeskrivelse
entitetModtag et udtræk for den angivne entitet. Parameteren skal angives, man kan således kun hente udtræk for én entitet ad gangen. Eksempel: Hvis værdien 'adgangsadresse' angives modtages et udtræk af adgangsadresser. Se databeskrivelser for mulige værdier.
txidHent udtrækket med det angivne Transaktions-ID. Alle ændringer som er udført på data i den angivne og tidligere transaktioner vil være med i udtrækket, og alle ændringer gennemført i senere transaktioner vil ikke være med. Et udtræk med et givent transaktions-ID er således et snapshot af data dannet præcis efter udførelsen af transaktionen med den angivne transaktions-ID.
sekvensnummerHent udtrækket med det angivne sekvensnummer. Alle ændringer til og med dette sekvensnummer er med i udtrækket, og alle senere ændringer er ikke med. Det anbefales at nye klienter anvender txid parameteren i stedet.
callbackOutput leveres i JSONP format. Se Dataformater.
formatOutput leveres i andet format end JSON. Se Dataformater.
noformatParameteren angiver, at whitespaceformatering skal udelades
ndjsonOutput leveres i Newline Delimited JSON

Hændelser

Modtag hændelser om ændringer til en given entitet. Entitet-parameteren (kræves) angiver hvilken entitet, der modtages hændelser for. Databeskrivelser for en liste af entiteter og hvilke data de forskellige entiter indeholder. DAWA stiller hændelser til rådighed i minimum et år efter hændelsen blev dannet. Forsøg på at hente hændelser ældre end et år kan resultere i en fejl 400.

GET https://api.dataforsyningen.dk/replikering/haendelser

Parametre

NavnBeskrivelse
entitetModtag hændelser for den pågældende entitet (type). Parameteren skal angives, man kan således kun modtage hændelser for én entitet ad gangen. Eksempel: Hvis værdien 'adgangsadresse' angives modtages hændelser for adgangsadresser. Se databeskrivelser for mulige værdier.
txidfraFind hændelser med Transaktions-ID større end eller lig den angivne værdi.Andvendes typisk sammen med txidtil parameteren
txidtilFind hændelser med Transaktions-ID mindre end eller lig den angivne værdi.
sekvensnummerfraHeltal. Returner hændelser med sekvensnummer større eller lig det angivne
sekvensnummertilHeltal. Returner hændelser med sekvensnummer mindre eller lig det angivne
tidspunktfraReturnerer hændelser hvor tidspunktet for hændelsen er senere eller lig det angivne tidspunkt. Eksempel: 2014-05-23T08:39:36.181Z. Det anbefales at anvende sekvensnumre fremfor tidspunkter til fremsøgning af hændelser.
tidspunkttilReturnerer hændelser hvor tidspunktet for hændelsen er tidligere eller lig det angivne tidspunkt. Eksempel: 2014-05-23T08:39:36.181Z. Det anbefales at anvende sekvensnumre fremfor tidspunkter til fremsøgning af hændelser.
callbackOutput leveres i JSONP format. Se Dataformater.
formatOutput leveres i andet format end JSON. Se Dataformater.
noformatParameteren angiver, at whitespaceformatering skal udelades
ndjsonOutput leveres i Newline Delimited JSON

Transaktioner

Modtag metadata om udførte transaktioner, herunder transaktions-ID (txid) samt hvilke entiteter der er ændrede af transaktionen.

GET https://api.dataforsyningen.dk/replikering/transaktioner

Parametre

NavnBeskrivelse
txidModtag transaktion med bestemt transaktionsid
txidfraFind transaktioner med txid større end eller lig den angivne værdi. Anvendes typisk sammen med txidtil parameteren.
txidtilFind transaktioner med txid mindre end eller lig den angivne værdi.
callbackOutput leveres i JSONP format. Se Dataformater.
formatOutput leveres i andet format end JSON. Se Dataformater.
noformatParameteren angiver, at whitespaceformatering skal udelades
ndjsonOutput leveres i Newline Delimited JSON
sideAngiver hvilken siden som skal leveres. Se Paginering.
per_sideAntal resultater per side. Se Paginering.

Seneste transaktion

Modtag metadata om den senest udførte transaktion herunder transaktions-ID.

GET https://api.dataforsyningen.dk/replikering/senestetransaktion

Parametre

NavnBeskrivelse
callbackOutput leveres i JSONP format. Se Dataformater.
formatOutput leveres i andet format end JSON. Se Dataformater.
noformatParameteren angiver, at whitespaceformatering skal udelades
ndjsonOutput leveres i Newline Delimited JSON

Datamodel (maskinlæsbar)

Modtag maskin-læsbar datamodel for alle de data, som udstilles på replikerings-API'et.

GET https://api.dataforsyningen.dk/replikering/datamodel