...

Status APIet er blitt redesignet til å være mer granulert. Det er basert på en HAL-struktur (HAL-JSON) 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.

...

APIet sine endepunkter er tilgjengelige i Swagger her FTPB InnsendingsAPI

HAL-JSON og Swagger

Swagger generer dokumentasjonen automatisk og baserer seg på hvilke klasser og typer som er angitt i kontrakten. P.t. brukes et rammeverk for serialiseringen til HAL-JSON struktur. På grunn av dynamikken i forbindelse med serialisering er ikke kontrakten definert klart nok til at Swagger klarer å lage en god nok dokumentasjon for grensesnittet. I all hovedsak gjelder dette i de tilfellene der et endepunkt responderer med en liste av ressurser.

Eksempel:

Følgende ressurs responderer med en liste av distribusjonsdetaljer. Denne listen er elementer som man også vil finne dersom man angir identifikatoren i URLen: /api/v1/innsending/distribusjoner/{arkivreferanse}/distribusjonsdetaljer/{id}

I HAL-JSON vil samles resultatene under propertyen _embedded i responsen. Man kan se på dette som at datatypen som er anngitt i ResourceList vil gjelde for de dataene som ligger under _embedded.

ResourceList er forøvrig kun en beskrivelse av datatypen i _embedded og ikke en faktisk del av responsen.

...

Autentisering

Autentisering er basic authentication som for de andre APIene til Fellestjenester Plan og Bygg

...

Startpunktet i APIet er https://admbygg.ft-test-admbygg.dibk.no/api/v1/innsending/{arkivreferanse} Under vises et eksempel på en request og en respns.

...

curl -u myUserName:myPassword
 -H "Accept : application/hal+json"
 https://admbygg.ft-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"
		}
	}
}

...

curl -u myUserName:myPassword
 -H "Accept : application/hal+json"
  https://admbygg.ft-test-admbygg.dibk.no/api/v1/innsending/AR123456/vedlegg

...

curl -u myUserName:myPassword
 -H "Accept : application/hal+json"
  https://admbygg.ft-test-admbygg.dibk.no/api/v1/innsending/AR123456/hendelser

...