FtPB StatusAPI
StatusAPI gir informasjon om FtPBs fremdrift og prosessering av søknader og skjema. Data blir tilgjengelig først når et skjema er registrert og prosesseringen er påbegynt.
Prosesseringstyper
Forsendelser til kommune/sektormyndighet
Dette gjelder alle forsendelser som går fra en søker og direkte til kommune/sektormyndighet. Dataene som logges for disse er metadata om forsendelsen.
Distribusjon med en eller flere mottakere
Denne prosesseringstypen blir brukt på tjenester der det sendes ut en eller flere skjema som det forventes svar på. Dette gjelder tjenester som:
Nabovarsel (mange mottakere)
AnSaKo (en mottaker)
Tiltakshaverssamtykke (en mottaker)
Varsel om oppstart av reguleringplanarbeid (mange mottakere)
Statuser
Prosesseringsstatus
StatusAPIet vil rapportere med følgende statuser. Dette gjelder for alle skjema som prosesseres og registreres i FtPB. "Endelig status" betyr at status ikke vil komme til å endres.
Status | Beskrivelse | Endelig status |
|---|---|---|
I kø | Innsending er registrert og lagt i kø. | Nei |
Under behandling | Innsending er under behandling/prosessering av FtPB. | Nei |
Ok | Innsending er ferdig behandlet uten feil. | Ja |
Feil | Prosessering av innsending feilet. Den kan ikke startes opp igjen. | Ja |
Feil - strukturvalidering | Innsending har feil i XML datastrukturen. Innsendingen kan ikke gjenopptas. Mer informasjon ligger gjerne "Hendelser". | Ja |
Feil - datavalidering | Innsending har valideringsfeil og kan ikke gjenopptas. Mer informasjon om feilene ligger i "Hendelser". | Ja |
Distribusjonsstatuser
For skjema som er distribusjoner vil hver enkelt distribusjon merkes med status.
Status | Beskrivelse |
|---|---|
error | Feil ved distribusjonen. Denne feilen klarer vi ikke å rette. |
submittedPrefilled | Distribusjonen har blitt sendt til adressat.
|
signed | Svar er registrert mottatt. Svar-data (xml, pdf etc) tilgjengelig i StatusAPI. |
receiptSent | Gjelder kun nabovarsel Altinn2 |
Nedlastinger
StatusAPIet eksponerer data som mottatte svar, signerte erklæringer, kvitteringer med mer. Disse kan brukes av integrerende system for å rapportere tilbake til sine brukere.
Tilgang
Filer som blir tilgjengeliggjort via APIet er i utgangspunktet åpent tilgjengelige. Noen filer har begrenset tilgjengelighet og er beskyttet av autentisering.
Filer med begrenset tilgang er merket med propertyen «BegrensetTilgang»: true. Integrerende system må håndtere autentisering for å hente disse filene.
Versjoner av StatusAPI
StatusAPIet finnes i to versjoner. Undersidene til denne siden dokumenterer hver versjon i detalj.
StatusAPI v1
Det opprinnelige StatusAPIet. APIet leverer alle data i én enkelt respons. Responsen varierer avhengig av om arkivreferansen er en forsendelse til kommune/sektormyndighet eller en distribusjon med én eller flere mottakere.
Alle data returneres i én samlet JSON-respons
Autentisering via Basic Auth
Responsen inneholder felter som arkivreferanse, status, vedtak, hendelser, vilkår, distribusjoner og filnedlastinger
Swagger-dokumentasjon: Status_GetStatus
StatusAPI v2 – HAL/JSON
En redesignet versjon av StatusAPIet basert på HAL-JSON-struktur. APIet er mer granulert og lar konsumenten navigere fra et startpunkt til underressurser via lenker.
HAL-JSON-basert med navigerbare _links i responsene
Startpunkt: /api/v1/innsending/{arkivreferanse} – gir oppsummert status og lenker til vedlegg, hendelser og distribusjoner
Underressurser for vedlegg (/vedlegg), hendelser (/hendelser) og distribusjoner (/distribusjoner)
Paginering av hendelser (30 per side)
Autentisering via Basic Auth
Swagger-dokumentasjon: FTPB InnsendingsAPI