Indledning
Denne side skitserer de forventede snitflader (metoder) som udstilles på den kommende NSP ddtv-service. Den endelige snitfladebeskrivelse vil blive offentliggjort sammen med servicen på NSP Test-miljøerne som en del af leverancebeskrivelsen hørende til servicen.
Siden indledes med at definere nogle datatyper, som bruges af flere metoder nedenfor.
Fælles datatyper
PersonID
Element | Beskrivelse | Type | Obligatorisk |
|---|---|---|---|
id | Angiver borgerens ID (CPR-nummer uden bindestreg). | string | Ja |
classification | Typen af ID. Gyldige værder er: 'CPR' | string | Ja |
Bemærk, person-id'et er type-klassificeret, så der i fremtiden kan understøttes flere person-id typer, f.eks. eCPR, EU person id, etc.
ddtvStatus
Element | Beskrivelse | Type | Obligatorisk |
|---|---|---|---|
id | 0 - Borger ikke oprettet 1 - Borger oprettet, ønsker selv at angive tandlæge senere 3 - Borger oprettet, tandlæge valgt, tandlæge kontaktes ikke 7 - Borger oprettet, tandlæge valgt, tandlæge kontaktes 11 - Borger oprettet, tandlæge valgt, tandlæge har accepteret 17 - Borger oprettet, ønsker ikke at deltage \{Bit 0: Borger oprettet, 0: nej / 1: ja \} \{Bit 1: Tandlæge valgt, 0: nej / 1: ja \} \{Bit 2: Tandlæge må kontaktes, 0: nej / 1: ja \} \{Bit 3: Tandlæge har accepteret, 0: nej / 1: ja \} | int | Ja |
description | Tekst repræsentation af statusen | string | Ja |
Metoder
ddtvCheckStatus(...)
Returnerer statusinformation for en borgers tandlægevalg.
Input:
| Element/Parameter | Type | Beskrivelse | evt. note |
|---|---|---|---|
| personID | PersonID | CPR nummer på den der ønskes status for | I normaltilfældet vil personID være lig ID'et i IDWS Identititokenet, hvor der efterspørges status for personen selv. Hvis den kaldende person gør brug af fuldmagt eller forældremyndighed, vil personID være på hhv. fuldmagtsgiver eller barnet. Elementet er type-klassificeret, så der på sigt kan understøttes andre person-id typer (se datatypebeskrivelsen ovenfor) |
Output:
| Element | Type | Beskrivelse | evt. note |
|---|---|---|---|
| status | ddtvStatus |