Status APIet er blitt redesignet til å være mer granulert. Det er basert på en HAL-struktur som skal gjøre at man kan navigere seg fra et startpunkt. Første requesten vil gi en oppsummert status samt en rekke lenker til videre informasjon om innsendingen.
Feltet innsendingstype viser til hva slags type innsending det er. I eksempelet ser man at det gjelder en “distribusjon”. Mulige verdier i feltet er: “Distribusjon”, “ForsendelseTilKommune” og “Notifikasjon”
Swagger
APIet sine endepunkter er tilgjengelige i Swagger her FTPB InnsendingsAPI
Autentisering
Autentisering er basic authentication som for de andre APIene til Fellestjenester Plan og Bygg
Startpunkt
Startpunktet i APIet er https://test-admbygg.dibk.no/api/v1/innsending/{arkivreferanse} Under vises et eksempel på en request og en respns.
Request
curl -u myUserName:myPassword -H "Accept : application/hal+json" https://test-admbygg.dibk.no/api/v1/innsending/AR123456
Response
{
"referanse": "AR123456",
"innsendingsType": "Distribusjon",
"altinnInnsending": "2021-05-06T15:30:08.99",
"status": "Ok",
"antallVedlegg": 3,
"_links": {
"self": {
"href": "/api/v1/innsending/AR123456"
},
"hendelser": {
"href": "/api/v1/innsending/AR123456/hendelser"
},
"vedlegg": {
"href": "/api/v1/innsending/AR123456/vedlegg"
},
"distribusjon": {
"href": "/api/v1/innsending/distribusjoner/AR123456"
}
}
}
Vedlegg
For en innsending logges metadata for vedlegg. En oversikt over disse finnes under ressursen /api/v1/innsending/{arkivreferanse}/vedlegg
Request
curl -u myUserName:myPassword -H "Accept : application/hal+json" https://test-admbygg.dibk.no/api/v1/innsending/AR123456/vedlegg
Response
{
"innsendingsVedlegg": [
{
"filnavn": "Situasjonsplan 52.pdf",
"stoerrelse": 52272,
"vedleggstype": "Situasjonsplan"
},
{
"filnavn": "Tegning ny fasade.pdf",
"stoerrelse": 52272,
"vedleggstype": "TegningNyFasade"
},
{
"filnavn": "Tegning eksisterende fasade.pdf",
"stoerrelse": 52272,
"vedleggstype": "TegningEksisterendeFasade"
}
],
"_links": {
"self": {
"href": "/api/v1/innsending/AR123456/vedlegg"
}
}
}
Hendelser
En innsendings hendelser ved prosessering i FTPB vil er tilgjengelige under ressursen /api/v1/innsending/{arkivreferanse}/hendelser
Denne ressursen viser hendelser i stigende rekkefølge og har paginering. Hver side viser 30 hendelser. Lenkene i under _links peker på gjeldende side, neste og forrige.
Request
curl -u myUserName:myPassword -H "Accept : application/hal+json" https://test-admbygg.dibk.no/api/v1/innsending/AR123456/hendelser
Response
{
"hendelser": [
{
"melding": "Skjema er lagt i kø for behandling til Distribusjonstjeneste.",
"tidspunkt": "2021-05-06T15:31:00.797"
},
{
"melding": "Skjema er hentet fra Altinns tjenestearkiv for DiBK. Med 3 vedlegg og 1 skjema.",
"tidspunkt": "2021-05-06T15:31:01.997"
},
...........
{
"melding": "Dist id 26093bbc-43ca-4601-9365-caa535d62265 - Distribusjon av Svar på nabovarsel til tjeneste 4699/3",
"tidspunkt": "2021-05-06T15:31:09.467"
}
],
"totalResults": 62,
"totalPages": 3,
"page": 1,
"_links": {
"self": {
"href": "/api/v1/innsending/AR123456/hendelser?page=1"
},
"next": {
"href": "/api/v1/innsending/AR123456/hendelser?page=2"
},
"page": {
"href": "/api/v1/innsending/{referanse}/hendelser{?page}",
"templated": true
}
}
}
0 kommentarer