Formål

Formålet er at udstille en service, der kan benyttes af eksterne systemer til at sende digital post igennem IMS DigitalPost Cloud. Efter afsendelse kan dokumenterne arkiveres. 

 

Log på

For at benytte servicen skal man verificeres som bruger med rettigheder til IMS DigitalPost. Bruger verificeres ved hjælp af en af følgende metoder:

• brugernavn, domænenavn og systemkode
• brugernavn, adgangskode og systemkode

Generelt benyttes metode 1 hvis man er logget på domænet der synkroniseres brugere med. Metode 2 benyttes hvis systemet skal kaldes udefra og kræver der angives en adgangskode på den bruger der skal logge på.

Efter logon returnere servicen en cookie, denne skal bruges til at foretage andre kald til systemet (se eksempel nederst).

Url	Anvendelse	Returnerer
/api/account/login	POST metode til at logge på	200 Ok / 401 Unauthorized
/api/account/logout	GET metode til at logge af	200 Ok

Input metode 1:

{

  "name": "string",

  "domain": "string",

  "systemCode": "string"

}

Input metode 2:

{

  "name": "string",

  "password": "string",

  "systemCode": "string"

}

 

Meddelelser

En Meddelelse defineres her som et dokument med overskrift, modtager og evt. kopister. Meddelelsen sendes enten som digital post eller et dokument til arkivering. Se nærmere beskrivelse i skema.

 

Url	Anvendelse	Returnerer
/api/v1/message	POST metode til at sende en meddelelse	200 Ok / 401 Unauthorized

Feltbeskrivelser

Egenskaber Message	Type	Beskrivelse
SendUsingDigitalpost	Boolean	Bestemmer om en meddelelse skal sendes via Digital Post inden arkivering.
Subject	String	Emne for meddelelsen
Store	String	Arkiveringstype f.eks. IMSArkiv eller Mappe
StoreLocation	String	Arkiveringsplacering
AllowReply	Boolean	Bestemmer om en slut-modtager kan besvare en meddelelse
ReplyRecipient	String	Angiver hvem der skal modtage e-mail svar når en meddelelse besvares. Dette virker kun samme med IMS DigitalPost Modtager
SendDelayed	Boolean	Bestemmer om en meddelelse skal afsendes senere.
SendDateTime	Date (yyyy-mm-dd)	Angiver dato for afsendelse, max 5 dage

 

Egenskaber Message.Document	Type	Beskrivelse
Base64EncodedDocument	String	Hoveddokument
FileName	String	Filnavn på hoveddokument

 

Egenskaber Message.AttachmentList[]	Type	Beskrivelse
Base64EncodedeDocument	String	Meddelsesbilag
FileName	String	Filnavn på bilag

 

Egenskaber Message.Recipient	Type	Beskrivelse
CprCvr	String	Modtagers CPR / CVR -nummer
Pnr	String	Modtagers P-nummer
Email	String	Modtagers e-mail
Name	String	Modtagers navn

 

Egenskaber Message.CcRecipientList[]	Type	Beskrivelse
CprCvr	String	Cc modtagers CPR / CVR -nummer
Pnr	String	Cc modtagers P-nummer
Email	String	Cc modtagers e-mail
Name	String	Cc modtagers navn

 

Input:

{

"type": "object",

 "properties": {

   "sendUsingDigitalPost": {

     "type": "boolean"

   },

   "subject": {

     "type": "string"

   },

   "document": {

     "type": "object",

     "properties": {

       "base64EncodedDocument": {

         "type": "string"

       },

       "fileName": {

         "type": "string"

       }

     },

     "required": [

       "base64EncodedDocument",

       "fileName"

     ]

   },

   "recipient": {

     "type": "object",

     "properties": {

       "cprCvr": {

         "type": "string"

       },

       "pnr": {

         "type": "string"

       },

       "email": {

         "type": "string"

       },

       "name": {

         "type": "string"

       }

     },

     "required": [

       "cprCvr",

       "pnr",

       "email",

       "name"

     ]

   },

   "store": {

     "type": "null"

   },

   "storeLocation": {

     "type": "null"

   },

   "allowReply": {

     "type": "boolean"

   },

   "replyRecipient": {

     "type": "null"

   },

   "sendDelayed": {

     "type": "boolean"

   },

   "sendDateTime": {

     "type": "string"

   },

   "attachmentList": {

     "type": "array",

     "items": {

       "type": "object",

       "properties": {

         "base64EncodedDocument": {

           "type": "string"

         },

         "fileName": {

           "type": "string"

         }

       },

       "required": [

         "base64EncodedDocument",

         "fileName"

       ]

     }

   },

   "ccRecipientList": {

     "type": "array",

     "items": {}

   }

 },

 "required": [

   "sendUsingDigitalPost",

   "subject",

   "document",

   "recipient",

   "store",

   "storeLocation",

   "allowReply",

   "replyRecipient",

   "sendDelayed",

   "sendDateTime",                                                                                                     

   "attachmentList",

   "ccRecipientList"

 ]

}

 Arkivering

Alle forsendelser sendt gennem DPC API, vil automatisk blive arkiveret det dertilhørende IMS Case.