Under viser vi eksempler på API-kall for dokumentformidler-APIet.
...
Test av utgående dokument er ikke tilgjengelig i Swagger, men fungerer i Postman.
Last opp dokument
API | POST | /api/v1/dokument |
Request
Content-Type: multipart/form-data
...
Payloaden består av to deler; fil: Last opp dokumentet og dokumentMetadata.
fil: Dokumentet som skal formidles.
dokumentMetadata: eksempelDenne delen består av de to modellene for metadata og saksnummer. Eksempel på verdier:
| Kodeblokk |
|---|
{
"metadata": {
"fraEbyggesaksystem": "VårtSystem",
"innsendingReferanse": "AR123456789",
"ftBID": "BYGG-3001",
"avsenderId": "5001",
"avsenderNavn": "Trondheim Kommune",
"ekspedertDato": "2023-01-25T10:37:05.395Z",
"offentligJournalUrl": "https://www.trondheim.kommune.no/innsyn/2023/gnr123/bnr23/"
},
"saksnummer": {
"saksaar": "2023",
"sakssekvensnummer": "12421",
"journalpostnummer": "3"
}
} |
...
Eksempel: response
| Kodeblokk |
|---|
{
"dokumentId": "fbeac477-613c-4a8b-917c-775894e98c7e",
"dokumentUrl": "https://saksbehandlingsdataapi-test.dibk.no/api/v1/dokument/fbeac477-613c-4a8b-917c-775894e98c7e"
} |
Hent dokument
API | GET | /api/v1/dokument/{dokumentId} |
...
Eksempel: request
| Kodeblokk |
|---|
/api/v1/dokument/a197b94e-13f7-4922-b47e-17e42ea6a874 |
...
Eksempel: response
Ved status 200 OK vises dokumentet.
...
Automatisk sletting
Dokumenter lastet opp til dokumentformidleren har en midlertidig levetid. Dette betyr at de slettes automatisk etter 30 dager. Gjøres det en GET-forespørsel på det slettede dokumentet vil APIet respondere med 410 Gone.