Forsendelser i Dialogporten og Arbeidsflate

Slik kommer du i gang med forsendelser i Dialogporten og Arbeidsflate

Forsendelser

En forsendelse kan opprettes gjennom Altinn 3 Melding API for å gruppere flere relaterte instanser innenfor samme dialog.

Forsendelser i arbeidsflate

Eksempel på en dialog med forsendelse:

Her ser du den nederst, markert med type “informasjon”.

Hvordan komme i gang

Når en melding opprettes vil entiteten få tildelt en dialogId som ligger i den eksterne referansen til meldingen. Fremtidige instanser som er relatert til dialogen kan grupperes gjennom forsendelser. Dette gjøres ved å referere til dialogId i den eksterne referansen.

{
    "correspondence":{
        ...,
        "externalReferences":[
            {
                "referenceValue": string,
                "referenceType" ReferenceType
            }
        ]
    }
}

ReferenceValue for en forsendelse må settes til dialogId for dialogen du refererer til. I tillegg må referenceType settes til DialogportenDialogId for å indikere at den nye meldingen er del av en eksisterende dialog.

Sette forsendelsestype

Forsendelsestype er Information (1) dersom den ikke settes på meldingen. Du kan sette den ved å legge til en ekstern referanse med referenceType DialogportenTransmissionType når du initialiserer meldingen. Både enum-navn og numerisk verdi godtas. For eksempel:

{
    "correspondence":{
        ...,
        "externalReferences":[
            {
                "referenceValue": "Information",
                "referenceType": "DialogportenTransmissionType"
            }
        ]
    }
}

Eller ved å bruke den numeriske verdien:

{
    "correspondence":{
        ...,
        "externalReferences":[
            {
                "referenceValue": "1",
                "referenceType": "DialogportenTransmissionType"
            }
        ]
    }
}

Gyldige forsendelsestyper er:

Forsendelse opprettet

Når en forsendelse har blitt opprettet vil de eksterne referansene til den nyopprettede meldingen bestå av en referanse til dialogen som meldingen er relatert til, samt en referanse til en transmissionId som har blitt satt.

Responsen skal være i følgende format:

{
    "correspondence":{
        ...,
        "externalReferences":[
            {
                "referenceValue": dialogId,
                "referenceType": "DialogportenDialogId"
            },
            {
                "referenceValue": transmissionId,
                "referenceType": "DialogportenTransmissionId"
            }
        ]
    }
}