Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Snitfladebeskrivelse og brug

<Beskrivelse af Snitfladerne, samt den logik og de regler, der skal følges for den måde servicen anvendes på, og som servicen selv efterlever.

SendDigitalPost

SendDigitalPost

SendDigitalPost kaldet sætter et Digital Post brev på en kø, som afvikles med jævne mellemrum. Hvis et brev succesfuldt sendes til DPK fjernes det fra køen, men hvis kaldet mod DPK fejler beholdes brevet i køen og forsøges afsendt igen senere og supporten får vha. is-alive kald besked om at der er et brev som er fejlet.

SendDigitalPostRequest

SendDigitalPostRequest
ElementBeskrivelsePåkrævet
message-idUUID version 4 som unikt udpeger genne beskeX
recipient-idID-nummer for modtager af brevet. På nuværende tidspunkt understøttes kun CPR-numreX
recipient-id-sourceOID for ID-nummeret. På nuværende tidspunkt understøttes kun 1.2.208.176.1.2X
templateID for den skabelon der skal udfyldes. Gyldige værdier kan findes i afsnittet Generelle koder, værdier, etc.X
recipient-detailsKey-value liste over modtager-specifikke detaljer der skal erstattes ind i skabelonen
template-detailsKey-value liste over skabelon-specifikke detaljer der skal erstattes ind i skabelonen

...

IdentifierIdentifiers hos DPKObligatoriske substitutions-nøglerValgfri substitutions-nøgler
fgvhr/20241218/BekraeftelseRegistreringFravalg

fgvhr/20241218/digital/BekraeftelseRegistreringFravalg

fgvhr/20241218/physical/BekraeftelseRegistreringFravalg

  • ikrafttraedelsesdato
  • date
fgvhr/20241218/BekraeftelseFortrydelseFravalg

fgvhr/20241218/digital/BekraeftelseFortrydelseFravalg

fgvhr/20241218/physical/BekraeftelseFortrydelseFravalg


  • date 
fgvhr/20241218/PaamindelseRegistreringFravalg

fgvhr/20241218/digital/PaamindelseRegistreringFravalg

fgvhr/20241218/physical/PaamindelseRegistreringFravalg


  • date

Fejlbeskeder

<Beskrivelse af  fejlbeskeder, og i hvilke situationer man kan forvente at se disse i.

...

I fejl-scenarier vises disse fejlkoder:

FejlkodeScenarie
system-validation-errorFejl i sikkerheds-billet valideringen
invalid-oid-error

Hvis der angives en anden recipient-id-source end understøttet. På nuværende tidspunkt understøttes kun 1.2.208.176.1.2 

invalid-uuid-errorHvis message-id ikke er en UUID version 4

Eksempler på request/response

Eksempler på request og response til de operationer der udstilles. De enkelte elementer er beskrevet under snitfladebeskrivelse. Klient proxier kan genereres udfra WSDL'en.

Eksempel på SendDigitalPostRequest/Response

Code Block
languagexml
titleEksempel request/response
collapsetrue
<SendDigitalPostRequest>
  <message-id>7edac017-97a1-4cdc-aa7c-ff2298514aff</message-id>
  <recipient-id>1111111118</recipient-id>
  <recipient-id-source>1.2.208.176.1.2</recipient-id-source>
  <template>fgvhr/20241218/BekraeftelseRegistreringFravalg</template>
  <recipient-details>
    <key>ikrafttraedelsesdato</key>
    <value>2025-05-01</value>
  </recipient-details>
  <template-details>
    <key>date</key>
    <value>2025-04-25</value>
  </template-details>
</SendDigitalPostRequest>

...



<SendDigitalPostResponse>
  <message-id>7edac017-97a1-4cdc-aa7c-ff2298514aff</message-id> 
</SendDigitalPostResponse>

Test

<beskriv Test muligheder, test-systemer og eventuelle testdata>

...