API for kvittering er et enkelt API-kall som brukes til å gi kvittering om at en sending er mottatt og tildelt saksnummer i kommunen. API-et inneholder informasjon søker trenger for å vite at innsendingen er registrert.
...
mottaksdato
hvilke filer som er mottatt
saksnummer
kontaktpunkt dersom det er tildelt
Datamodell
...
API-kall
Under viser vi eksempler på kall for API for kvittering.
For teknisk dokumentasjon, se: Informasjon om API-design
...
Opprett kvittering
...
API
...
POST
...
/api/v1/kvittering
...
Hent kvittering
...
API
...
GET
...
/api/v1/kvittering
Opprett kvittering: Eksempel-request
| Kodeblokk |
|---|
{
"metadata": {
"fraEbyggesaksystem": "VårtSystem",
"innsendingReferanse": "AR12345679",
"ftBID": "BYGG-3001",
"avsenderId": "3817",
"avsenderNavn": "Midt-Telemark Kommune",
"ekspedertDato": "2023-01-25T10:02:44.711Z",
"offentligJournalUrl": "string"
},
"saksnummer": {
"saksaar": "2023",
"sakssekvensnummer": "123",
"journalpostnummer": "1"
},
"avsenderKontaktpunkt": {
"navn": "Byggesaksavdelingen",
"epost": "info@byggesak.no",
"telefon": "35950000",
"mobil": ""
},
"milepæl": "MS",
"saksbehandlingsfrist": "2023-02-25T10:02:44.711Z",
"mottattDato": "2023-01-24T10:02:44.711Z",
"registrertDato": "2023-01-25T10:02:44.711Z",
"mottattDokument": [
{
"dokumentNavn": "Skjema.pdf",
"mimeType": "application/pdf",
"dokumentStorrelse": "123245",
"ekstraMetadata": [
{
"key": "skjemaversjon.dokument",
"value": "5844.43006"
}
]
},
{
"dokumentNavn": "Situasjonsplan-v4.png",
"mimeType": "application/png",
"dokumentStorrelse": "123245678",
"ekstraMetadata": [
{
"key": "vedleggType",
"value": "Situasjonsplan"
}
]
}
]
} |
Eksempel-response
| Kodeblokk |
|---|
{
"kvitteringUrl": "https://saksbehandlingsdataapi-test.dibk.no/api/v1/Kvittering?innsendingReferanse=AR12345679"
} |
Hent kvittering: Eksempel-request
...
Beskrivelse av felter
Under ligger en beskrivelse av feltene for API for kvittering. Vi har også lagt med en kolonne med eksempeldata, for slik å gi et inntrykk av hvordan vi ønsker at API-et skal brukes. Felt i blått er felles datafelt, mens lysgrønne felt er spesielle for API for kvittering.
...