Transmissions i Dialogporten og Arbeidsflate

Hvordan komme i gang med transmissions i Dialogporten og Arbeidsflate

Transmissions

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

Transmissions i arbeidsflate

Eksempel på en dialog med transmission:

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 transmissions. Dette gjøres ved å referere til dialogId i den eksterne referansen.

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

ReferenceValue for en transmission 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 transmission-type

Transmission type 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 transmission-typer er:

Sette dialogstatus og utvidet status

Når du oppretter en transmission (altså når DialogportenDialogId er til stede), kan du valgfritt sette dialogstatus og/eller utvidet status på den opprinnelige dialogen ved å legge til eksterne referanser:

• DialogportenDialogStatus
  • Må være en gyldig Dialogporten-statusverdi
  • Både enum-navn og numerisk verdi godtas
  • Kun én slik referanse er tillatt
• DialogportenDialogExtendedStatus
  • Må være en ikke-tom streng
  • Må være 25 tegn eller færre
  • Kun én slik referanse er tillatt

Begge krever at DialogportenDialogId er til stede (transmission-flyt).

Eksempel med enum-navn:

{
    "correspondence":{
        ...,
        "externalReferences":[
            {
                "referenceValue": "din-dialog-id",
                "referenceType": "DialogportenDialogId"
            },
            {
                "referenceValue": "Sent",
                "referenceType": "DialogportenDialogStatus"
            },
            {
                "referenceValue": "Needs review",
                "referenceType": "DialogportenDialogExtendedStatus"
            }
        ]
    }
}

Gyldige dialogstatusverdier er:

Transmission opprettet

Når en transmission 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"
            }
        ]
    }
}