Initialisere

Endepunkt for initialisering av en melding.

Endepunkt

POST /correspondence/api/v1/correspondence

Beskrivelse

Dette endepunktet oppretter en melding og legger den i kø for sending. Før du bruker dette endepunktet, må eventuelle tilhørende vedlegg lastes opp på forhånd for å fylle ut feltet “ExistingAttachments”. Dette kan gjøres ved å bruke endepunktet beskrevet her.

Autentisering

Dette API-et krever autentisering, og forespørselen må også inkludere:

• Correspondence write scope altinn:correspondence.write (for eksterne kall)

Se Autentisering og Autorisasjon for mer informasjon.

Request body

Du kan se et eksempel på en request body her

Respons

Responskoder

• 200 OK: Responsen har blitt vellykket initialisert

  Se problemdetaljer i responskroppen for mer informasjon.

• 401 Unauthorized: Indikerer en manglende, ugyldig eller utløpt autorisasjonsheader.

• 403 Forbidden: Indikerer at nødvendig omfang eller plattformtilgangstoken mangler eller er ugyldig.

Innholdstype

• application/json

Response body

Respons body returnerer en liste over meldinger InitializeCorrespondencesResponseExt, med en melding for hver mottaker. Hver melding kan ha flere forskjellige mottakere hvor hver mottaker vil få en unik correspondenceId, status, etc.

Response body egenskaper

correspondenceId

Type: Guid

ID-en til meldingen som har blitt initialisert

status

Type: string

De forskjellige statusene er definert her

Viser statusen til den initialiserte meldingen

recipient

Type: string

Viser mottakeren i formatet 0192:{{recipientOrgNumber}}

notifications

Type: Liste over InitializedCorrespondencesNotificationsExt

En liste over de genererte varslene med sendingsresultat. Hvert varsel vil inkludere følgende egenskaper:

• orderId: ID-en til ordren.
• isReminder: en boolsk verdi som indikerer om varselet er en påminnelse eller ikke.
• status: viser statusen til varselet.