Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device.
Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Som del av konsesjonsavtalen med Direktoratet for Byggkvalitet (DiBK) må søknadssystemene kunne eksportere og importere data til/fra andre leverandører. I Altinn II ble dette gjort via Altinn-meldinger og brukerens innboks.
Med overgangen til Altinn3 er APIene for slik funksjonalitet blitt endret. Det er tjenesten Dialogporten som støtter oppunder brukeres innboks og som vil kunne brukes for å hente ut historiske data. Eksisterende Altinn II tjenester er migrert og tilgjengelige som element i Dialogporten, parallelt med nye Altinn3 data.
Eksempel på integrasjon
Forutsetninger:
Klienten må ha scopet digdir:dialogporten provisjonert, og scopet må inkluderes i autorisasjonsforespørselen slik at det havner i access-tokenet.
For nedlasting av selve søknadsinnholdet (vedlegg) kreves i tillegg altinn:instances.read samt innveksling til Altinn-token. Dette er utenfor scope for søket, men nevnt til slutt.
Tokenet brukes som Authorization: Bearer <access_token> på alle kall.
Miljø og base-URL
Miljø
Base-URL
Miljø
Base-URL
Test (TT02)
https://platform.tt02.altinn.no/dialogporten
Produksjon
https://platform.altinn.no/dialogporten
Endepunkter
Formål
Metode og sti
Formål
Metode og sti
Søke etter dialoger
GET /api/v1/enduser/dialogs
Hente detaljer for én dialog
GET /api/v1/enduser/dialogs/{dialogId}
Søke-endepunktet returnerer en liste med metadata (en slags innholdsfortegnelse). Detalj-endepunktet returnerer full struktur for én dialog, inkludert referanser til vedlegg og forsendelser.
Sentrale søkeparametere
Følgende parametere er de viktigste for uthenting av DiBK-søknader. Parametere av ulik type kombineres med OG. Når samme parameter oppgis med flere verdier, kombineres disse med ELLER.
party
Angir hvilken aktør (person eller organisasjon) dialogen tilhører. Minst én party eller serviceResourcemå oppgis i søket.
Dette er det mest presise filteret for å avgrense til bestemte DiBK-skjema. Flere serviceResource kan oppgis i samme kall (kombineres med ELLER). Se listen over relevante ressurser nedenfor.
Øvrige nyttige parametere
Parameter
Beskrivelse
Parameter
Beskrivelse
status
Status på dialogen, f.eks. Completed, Closed
createdAfter / createdBefore
Avgrens på opprettelsestidspunkt (ISO 8601)
orderBy
Sortering, f.eks. createdat_desc
continuationToken
Brukes for paginering (se under)
Paginering
Søket er paginert med fortsettelsestoken. Dersom det finnes flere sider, er hasNextPage satt til true og continuationToken er satt. Neste side hentes ved å sende denne verdien som continuationToken. Gjenta så lenge hasNextPage er true.
Eksempelkall
Søk på alle DiBK-dialoger for en organisasjon:
GET https://platform.tt02.altinn.no/dialogporten/api/v1/enduser/dialogs
?party=urn:altinn:organization:identifier-no:310928275
&org=dibk
&orderBy=createdat_desc
Authorization: Bearer <access_token>
Søk avgrenset til ett eller flere bestemte skjema:
GET https://platform.tt02.altinn.no/dialogporten/api/v1/enduser/dialogs
?party=urn:altinn:organization:identifier-no:310928275
&serviceResource=urn:altinn:resource:<ressurs-1>
&serviceResource=urn:altinn:resource:<ressurs-2>
Authorization: Bearer <access_token>
Hente detaljer for én dialog:
GET https://platform.tt02.altinn.no/dialogporten/api/v1/enduser/dialogs/{dialogId}
Authorization: Bearer <access_token>
Relevante ressurser (serviceResource)
Liste over serviceResource-verdiene som utgjør de relevante DiBK-skjemaene.
Altinn 2-apper (migrerte skjema)
App-ID
Navn (nb)
serviceResource (URN)
dibk/a2-4373-2
Søknad om tiltak uten ansvarsrett
urn:altinn:resource:app_dibk_a2-4373-2
dibk/a2-4373-3
Søknad om tiltak uten ansvarsrett
urn:altinn:resource:app_dibk_a2-4373-3
dibk/a2-4397-2
Søknad om rammetillatelse
urn:altinn:resource:app_dibk_a2-4397-2
dibk/a2-4397-3
Søknad om rammetillatelse
urn:altinn:resource:app_dibk_a2-4397-3
dibk/a2-4398-4
Gjennomføringsplan
urn:altinn:resource:app_dibk_a2-4398-4
dibk/a2-4398-5
Gjennomføringsplan
urn:altinn:resource:app_dibk_a2-4398-5
dibk/a2-4398-6
Gjennomføringsplan
urn:altinn:resource:app_dibk_a2-4398-6
dibk/a2-4399-5
Søknad om midlertidig brukstillatelse
urn:altinn:resource:app_dibk_a2-4399-5
dibk/a2-4400-1
Ferdigattest
urn:altinn:resource:app_dibk_a2-4400-1
dibk/a2-4400-2
Ferdigattest
urn:altinn:resource:app_dibk_a2-4400-2
dibk/a2-4401-2
Søknad om igangsettingstillatelse
urn:altinn:resource:app_dibk_a2-4401-2
dibk/a2-4402-1
Søknad om endring
urn:altinn:resource:app_dibk_a2-4402-1
dibk/a2-4419-3
Erklæring om ansvarsrett
urn:altinn:resource:app_dibk_a2-4419-3
dibk/a2-4419-4
Erklæring om ansvarsrett
urn:altinn:resource:app_dibk_a2-4419-4
dibk/a2-4528-2
Søknad om tillatelse i ett trinn
urn:altinn:resource:app_dibk_a2-4528-2
dibk/a2-4528-3
Søknad om tillatelse i ett trinn
urn:altinn:resource:app_dibk_a2-4528-3
dibk/a2-4655-3
Distribusjon av nabovarsel
urn:altinn:resource:app_dibk_a2-4655-3
dibk/a2-4655-4
Nabovarsel
urn:altinn:resource:app_dibk_a2-4655-4
dibk/a2-4699-2
Svar på nabovarsel
urn:altinn:resource:app_dibk_a2-4699-2
dibk/a2-4699-3
Svar på nabovarsel
urn:altinn:resource:app_dibk_a2-4699-3
dibk/a2-4762-1
Distribusjonstjeneste for erklæring av ansvarsrett
urn:altinn:resource:app_dibk_a2-4762-1
dibk/a2-4845-1
Søknad om Arbeidstilsynets samtykke
urn:altinn:resource:app_dibk_a2-4845-1
dibk/a2-4965-2
Erklæring om ansvarsrett
urn:altinn:resource:app_dibk_a2-4965-2
dibk/a2-5194-1
Distribusjonstjeneste for kontroll og samsvarserklæring
Søke- og detaljendepunktene returnerer ikke selve søknadsinnholdet, kun referanser til vedlegg og forsendelser. Disse peker på endepunkter utenfor Dialogporten (typisk Altinn 3 Storage). For å laste ned innholdet:
Legg til scopet altinn:instances.read på klienten og inkluder det i tokenet.
Veksle ID-porten-tokenet inn til et Altinn-token via: - TT02: GET https://platform.tt02.altinn.no/authentication/api/v1/exchange - Prod: GET https://platform.altinn.no/authentication/api/v1/exchange
Bruk Altinn-tokenet mot vedleggs-/instans-URL-ene fra dialogdetaljene.