Dialog
Reference information about the dialog aggregate root
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.
Dialog entity for end-users
Details
This is the entity returned in the end-user API when fetching details for a single dialog
Search
This is the entity returned in the end-user API when searching for dialogs
Dialog entity for service owners
Details
This is the entity returned in the service owner API when fetching details for a single dialog
Search
This is the entity returned in the service owner API when searching for dialogs
Create (POST)
This is the entity expected as input in the service owner API when creating a new dialog
Update (PUT)
This is the entity expected as input in the service owner API when updating a new dialog
Update (PATCH)
Dialogporten supports RFC 6902 JSON Patch. A patch document must be constructed based on the PUT entity described above.
Note that the list of transmissions and activities are immutable; so replace/remove operations are not accepted on those properties.
Example
This sets the status, updates the dialog summary, removes all GUI actions (buttons) and adds a attachment
[
{
"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"
}
]
}
}
]
languageCode
. This means that when having eg. translations for norwegian nynorsk (nn
), norwegian bokmål (nb
) and english (en
), the order will always be en
, nb
, nn
, meaning that index 1 will always point to nb
regardless of the order of which the localization was added.See also