...
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.
...
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.
...
Kodeblokk | ||
---|---|---|
| ||
curl -u myUserName:myPassword -H "Accept : application/hal+json" https://admbygg.ft-test-admbygg.dibk.no/api/v1/innsending/AR123456 |
...
Kodeblokk | ||
---|---|---|
| ||
curl -u myUserName:myPassword -H "Accept : application/hal+json" https://admbygg.ft-test-admbygg.dibk.no/api/v1/innsending/AR123456/vedlegg |
...
Kodeblokk | ||
---|---|---|
| ||
curl -u myUserName:myPassword -H "Accept : application/hal+json" https://admbygg.ft-test-admbygg.dibk.no/api/v1/innsending/AR123456/hendelser |
...