Dialog

Referanseinformasjon om dialogaggregatroten

Select environment: Help

This dropdown lets you select which Dialogporten environment the content of this page should be based on. If unsure, use the default "Staging (TT02)", as this is the environment you would normally test against when integrating Dialogporten.

For bleeding edge, select "Dev", as this contains the most recent unreleased changes to the Dialogporten API. Select "Local dev" if you want to test changes to Dialogporten itself running locally.

Dialogentitet for sluttbrukere

Detaljer

Dette er entiteten som returneres i sluttbruker-API-et når man henter detaljer for én dialog.

Søk

Dette er entiteten som returneres i sluttbruker-API-et når man søker etter dialoger.

Dialogentitet for tjenesteeiere

Detaljer

Dette er entiteten som returneres i tjenesteeier-API-et når man henter detaljer for én dialog.

Søk

Dette er entiteten som returneres i tjenesteeier-API-et når man søker etter dialoger.

Opprett (POST)

Dette er entiteten som forventes som input i tjenesteeier-API-et når man oppretter en ny dialog.

Oppdater (PUT)

Dette er entiteten som forventes som input i tjenesteeier-API-et når man oppdaterer en dialog.

Oppdater (PATCH)

Dialogporten støtter RFC 6902 JSON Patch. Et patch-dokument må konstrueres basert på PUT-entiteten beskrevet ovenfor.

Merk at listene over forsendelser og aktiviteter er uforanderlige, så replace- og remove-operasjoner aksepteres ikke på disse egenskapene.

Eksempel

Dette setter status, oppdaterer dialogsammendraget, fjerner alle GUI-handlinger (knapper) og legger til et vedlegg.

[
    {
        "op": "replace",
        "path": "/status",
        "value": "Completed"
    },
    {
        "op": "replace",
        "path": "/content/summary/value/1/value",
        "value": "Din innsending er mottatt og godkjent."
    },
    {
        "op": "replace",
        "path": "/guiActions",
        "value": []
    },
    {
        "op": "add",
        "path": "/attachments/-",
        "value": {
            "displayName": [
                {
                    "value": "Vedtaksbrev",
                    "languageCode": "nb"
                }
            ],
            "urls": [
                {
                    "url": "https://mintjenesteplattform/sak-1234/vedtak.pdf",
                    "mediaType": "application/pdf",
                    "consumerType": "Gui"
                }
            ]
        }
    }
]

Merk at lokaliseringer, dvs. /content/summary, inneholder en liste med par av languageCode og oversatt tekst. For å ha konsistent indeksering sorteres lokaliseringene leksikografisk etter languageCode. Det betyr at dersom man har oversettelser for norsk nynorsk (nn), norsk bokmål (nb) og engelsk (en), vil rekkefølgen alltid være en, nb, nn, noe som betyr at indeks 1 alltid vil peke på nb, uavhengig av rekkefølgen lokaliseringen ble lagt til i.

Se også