For innsending brukes Altinn appen sine API endepunkter.
Dokumentasjon rundtdette finner dere her. https://docs.altinn.studio/nb/api/
Under dokumenterer vi det som er spesifikk for denne tjenesten, “Varsel om oppstart av reguleringsplanarbeid v2” - varselplanoppstart
Forskjellige miljøer
Miljø - angitt som {miljø} i videre tekst | Basis url |
---|---|
Lokalt/utviklingsmiljø | |
Testmiljø (tt02) | |
Produksjon |
Autentisering
For test og produksjonsmiljø så må ID-porten eller Maskinporten benyttes, hvor dette veksles inn i et Altinn token:
ID-porten: https://altinn.github.io/docs/api/rest/kom-i-gang/person/
Maskinporten: https://altinn.github.io/docs/api/rest/kom-i-gang/virksomhet/#autentisering-med-virksomhetsbruker-og-maskinporten
Veksle inn i altinn token
Maskinporten
Endepunkt for utveksling av Maskinporten-token mot TT02-miljø:
https://platform.tt02.altinn.no/authentication/api/v1/exchange/maskinportenEndepunkt for utveksling av Maskinporten-token mot prod-miljø:
https://platform.altinn.no/authentication/api/v1/exchange/maskinporten
ID-porten
Endepunkt for utveksling av ID-porten token mot TT02-miljø:
https://platform.tt02.altinn.no/authentication/api/v1/exchange/id-portenEndepunkt for utveksling av ID-porten token mot prod-miljø:
https://platform.altinn.no/authentication/api/v1/exchange/id-porten
Oppretting av Varsel om oppstart av reguleringsplanarbeid
https://docs.altinn.studio/api/apps/instances/
POST {miljø}/dibk/varselplanoppstart/instances Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}
Multipart Request
{ "instance": { "appId" : "dibk/varselplanoppstart", "instanceOwner": { "personNumber": null, "organisationNumber": "811009962" } } "Planvarsel": File // planvarsel.xml "Planomraade": File // VORPAH-planområde.gml }
Insomnia-eksempel:
Respons
{ "id": "50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad", "instanceOwner": { "partyId": "50170275", "organisationNumber": "811009962" }, "appId": "dibk/varselplanoppstart", "org": "dibk", "selfLinks": { "apps": "{miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad", "platform": "{platform}/storage/api/v1/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad" }, "visibleAfter": "2023-12-19T13:42:31.2943939Z", "process": { "started": "2023-12-19T13:42:31.0399643Z", "startEvent": "StartEvent_1", "currentTask": { "flow": 2, "started": "2023-12-19T13:42:31.2457297Z", "elementId": "Task_1", "name": "Utfylling", "altinnTaskType": "data", "flowType": "CompleteCurrentMoveToNext" } }, "status": { "isArchived": false, "isSoftDeleted": false, "isHardDeleted": false, "readStatus": "Read" }, "data": [ { "id": "64c58f8a-c4b9-4dd6-b262-5f8ab987debd", "instanceGuid": "855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad", "dataType": "Planvarsel", "contentType": "application/xml", "blobStoragePath": "dibk/varselplanoppstart/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/64c58f8a-c4b9-4dd6-b262-5f8ab987debd", "selfLinks": { "apps": "{miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/64c58f8a-c4b9-4dd6-b262-5f8ab987debd", "platform": "{platform}/storage/api/v1/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/64c58f8a-c4b9-4dd6-b262-5f8ab987debd" }, "size": 5379, "locked": false, "isRead": true, "tags": [], "fileScanResult": "NotApplicable", "created": "2023-12-19T13:42:31.391966Z", "createdBy": "146870", "lastChanged": "2023-12-19T13:42:31.391966Z", "lastChangedBy": "146870" }, { "id": "a337e0d8-c6d9-444a-ba5a-419f35ce2eaf", "instanceGuid": "855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad", "dataType": "Planomraade", "filename": "VORPAH-planområde.gml", "contentType": "application/gml+xml", "blobStoragePath": "dibk/varselplanoppstart/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/a337e0d8-c6d9-444a-ba5a-419f35ce2eaf", "selfLinks": { "apps": "{miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/a337e0d8-c6d9-444a-ba5a-419f35ce2eaf", "platform": "{platform}/storage/api/v1/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/a337e0d8-c6d9-444a-ba5a-419f35ce2eaf" }, "size": 3984, "locked": false, "isRead": true, "tags": [], "fileScanResult": "NotApplicable", "created": "2023-12-19T13:42:31.4857734Z", "createdBy": "146870", "lastChanged": "2023-12-19T13:42:31.4857734Z", "lastChangedBy": "146870" } ], "created": "2023-12-19T13:42:31.2943939Z", "createdBy": "146870", "lastChanged": "2023-12-19T13:42:31.4857734Z", "lastChangedBy": "146870" }
GET Varsel om oppstart av reguleringsplanarbeid
https://docs.altinn.studio/api/apps/instances/
GET {miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}
Respons
{ "id": "50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad", "instanceOwner": { "partyId": "50170275", "organisationNumber": "811009962" }, "appId": "dibk/varselplanoppstart", "org": "dibk", "selfLinks": { "apps": "{miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad", "platform": "{platform}/storage/api/v1/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad" }, "visibleAfter": "2023-12-19T13:42:31.2943939Z", "process": { "started": "2023-12-19T13:42:31.0399643Z", "startEvent": "StartEvent_1", "currentTask": { "flow": 2, "started": "2023-12-19T13:42:31.2457297Z", "elementId": "Task_1", "name": "Utfylling", "altinnTaskType": "data", "flowType": "CompleteCurrentMoveToNext" } }, "status": { "isArchived": false, "isSoftDeleted": false, "isHardDeleted": false, "readStatus": "Read" }, "data": [ { "id": "64c58f8a-c4b9-4dd6-b262-5f8ab987debd", "instanceGuid": "855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad", "dataType": "Planvarsel", "contentType": "application/xml", "blobStoragePath": "dibk/varselplanoppstart/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/64c58f8a-c4b9-4dd6-b262-5f8ab987debd", "selfLinks": { "apps": "{miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/64c58f8a-c4b9-4dd6-b262-5f8ab987debd", "platform": "{platform}/storage/api/v1/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/64c58f8a-c4b9-4dd6-b262-5f8ab987debd" }, "size": 5379, "locked": false, "isRead": true, "tags": [], "fileScanResult": "NotApplicable", "created": "2023-12-19T13:42:31.391966Z", "createdBy": "146870", "lastChanged": "2023-12-19T13:42:31.391966Z", "lastChangedBy": "146870" }, { "id": "a337e0d8-c6d9-444a-ba5a-419f35ce2eaf", "instanceGuid": "855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad", "dataType": "Planomraade", "filename": "VORPAH-planområde.gml", "contentType": "application/gml+xml", "blobStoragePath": "dibk/varselplanoppstart/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/a337e0d8-c6d9-444a-ba5a-419f35ce2eaf", "selfLinks": { "apps": "{miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/a337e0d8-c6d9-444a-ba5a-419f35ce2eaf", "platform": "{platform}/storage/api/v1/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/a337e0d8-c6d9-444a-ba5a-419f35ce2eaf" }, "size": 3984, "locked": false, "isRead": true, "tags": [], "fileScanResult": "NotApplicable", "created": "2023-12-19T13:42:31.4857734Z", "createdBy": "146870", "lastChanged": "2023-12-19T13:42:31.4857734Z", "lastChangedBy": "146870" } ], "created": "2023-12-19T13:42:31.2943939Z", "createdBy": "146870", "lastChanged": "2023-12-19T13:42:31.5923078Z", "lastChangedBy": "146870" }
Hente ut varsel (Planvarsel
)
https://docs.altinn.studio/api/apps/data-elements/
For dataType = "Planvarsel
"
GET {miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/64c58f8a-c4b9-4dd6-b262-5f8ab987debd Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken], Accept: application/xml }
Respons
<Planvarsel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" dataFormatProvider="KXML" dataFormatId="1" dataFormatVersion="1" xmlns="http://skjema.kxml.no/dibk/planvarsel/0.1"> <forslagsstiller> <partstype> <kodeverdi>Organisasjon</kodeverdi> <kodebeskrivelse>Organisasjon</kodebeskrivelse> </partstype> <organisasjonsnummer>811009962</organisasjonsnummer> <navn>Klavestadhaugen og holmsbu revisjon</navn> <epost>veronika@arkitektum.no</epost> <adresse> <adresselinje1>Sofies Gate 1</adresselinje1> <postnr>0170</postnr> <poststed>Oslo</poststed> <landkode>NO</landkode> </adresse> <telefon>47759931</telefon> </forslagsstiller> <beroerteParter> <beroertpart> <partstype> <kodeverdi>Organisasjon</kodeverdi> <kodebeskrivelse>Organisasjon</kodebeskrivelse> </partstype> <foedselsnummer /> <organisasjonsnummer>910297937</organisasjonsnummer> <navn>Fana og Hafslo Revisjon</navn> <telefon>47759931</telefon> <epost>veronika@arkitektum.no</epost> <adresse> <adresselinje1>Grev Wedels Plass 9</adresselinje1> <postnr>0301</postnr> <poststed>Oslo</poststed> <landkode>NO</landkode> </adresse> <beskrivelseForVarsel /> <systemReferanse>Berørtpart sluttbrukersystem</systemReferanse> <erHoeringsmyndighet>true</erHoeringsmyndighet> <gjelderEiendom> <gjeldereiendom> <bolignummer /> <bygningsnummer /> <eiendomsidentifikasjon> <kommunenummer>5001</kommunenummer> <gaardsnummer>110</gaardsnummer> <bruksnummer>3</bruksnummer> <festenummer>385</festenummer> <seksjonsnummer>36</seksjonsnummer> </eiendomsidentifikasjon> <adresse> <adresselinje1>Storgata 5</adresselinje1> <adresselinje2 /> <adresselinje3 /> <postnr>3502</postnr> <poststed>Hønefoss</poststed> <landkode /> <gatenavn /> <husnr /> <bokstav /> </adresse> <kommunenavn>String</kommunenavn> </gjeldereiendom> </gjelderEiendom> </beroertpart> <beroertpart> <partstype> <kodeverdi>Privatperson</kodeverdi> <kodebeskrivelse>Privatperson</kodebeskrivelse> </partstype> <foedselsnummer>ncX7R6YaiCKMNxmEku/UkLCpivaC140mq4hyGXP3q+1SqDHmh1z9x1+rO0KVcq1o5Si+Q1ISqYhokevrlYXTcJMHQhdGk+zWNlyBN1UM+zPyhVKpFdlMr6ooEj1Ar297/sjvJunTXo4/6qemwDk3h815RKhsDduAMPQEAJgj6n0=</foedselsnummer> <organisasjonsnummer /> <navn>VIGDIS VATER</navn> <telefon>47759931</telefon> <epost>veronika@arkitektum.no</epost> <adresse> <adresselinje1>Grev Wedels Plass 9</adresselinje1> <postnr>0301</postnr> <poststed>Oslo</poststed> <landkode>NO</landkode> </adresse> <beskrivelseForVarsel /> <systemReferanse>Berørtpart sluttbrukersystem</systemReferanse> <erHoeringsmyndighet>false</erHoeringsmyndighet> <gjelderEiendom> <gjeldereiendom> <bolignummer /> <bygningsnummer /> <eiendomsidentifikasjon> <kommunenummer>5001</kommunenummer> <gaardsnummer>110</gaardsnummer> <bruksnummer>3</bruksnummer> <festenummer>385</festenummer> <seksjonsnummer>36</seksjonsnummer> </eiendomsidentifikasjon> <adresse> <adresselinje1>Storgata 5</adresselinje1> <adresselinje2 /> <adresselinje3 /> <postnr>3502</postnr> <poststed>Hønefoss</poststed> <landkode /> <gatenavn /> <husnr /> <bokstav /> </adresse> <kommunenavn>String</kommunenavn> </gjeldereiendom> </gjelderEiendom> </beroertpart> </beroerteParter> <kommunenavn>Oslo</kommunenavn> <eiendomByggested> <eiendom> <eiendomsidentifikasjon> <kommunenummer>3007</kommunenummer> <gaardsnummer>318</gaardsnummer> <bruksnummer>97</bruksnummer> <festenummer>1</festenummer> <seksjonsnummer>1</seksjonsnummer> </eiendomsidentifikasjon> <adresse> <adresselinje1>Testveien 999</adresselinje1> <adresselinje2 /> <adresselinje3 /> <postnr>3502</postnr> <poststed>Hønefoss</poststed> <landkode>NO</landkode> <gatenavn /> <husnr /> <bokstav /> </adresse> <bygningsnummer /> <bolignummer /> <kommunenavn>Oslo</kommunenavn> </eiendom> </eiendomByggested> <signatur> <signaturdato>2001-12-17T09:30:47Z</signaturdato> <signertAv /> <signertPaaVegneAv /> </signatur> <gjeldendePlan> <gjeldendeplan> <navn>Reguleringsplan for Hønefoss</navn> <plantype> <kodeverdi>35</kodeverdi> <kodebeskrivelse>Detaljregulering</kodebeskrivelse> </plantype> </gjeldendeplan> </gjeldendePlan> <plankonsulent> <partstype> <kodeverdi>Organisasjon</kodeverdi> <kodebeskrivelse>Organisasjon</kodebeskrivelse> </partstype> <organisasjonsnummer>910297937</organisasjonsnummer> <navn>Fana og Hafslo AS</navn> <epost>veronika@arkitektum.no</epost> <adresse> <adresselinje1>Sentrum</adresselinje1> <adresselinje2 /> <adresselinje3 /> <postnr>3504</postnr> <poststed>BØ I TELEMARK</poststed> <landkode /> </adresse> <telefon>98839131</telefon> </plankonsulent> <metadata> <ftbId /> <hovedinnsendingsnummer /> <klartForSigneringFraSluttbrukersystem>true</klartForSigneringFraSluttbrukersystem> <fraSluttbrukersystem>Testmotor Ftp</fraSluttbrukersystem> </metadata> <planforslag> <plannavn>OMRÅDEPLAN FOR HIS ALLÉ</plannavn> <arealplanId>09062018-2</arealplanId> <hjemmesidePlanforslag>www.kommunensHjemmeside.no</hjemmesidePlanforslag> <kravKonsekvensUtredning>false</kravKonsekvensUtredning> <planHensikt>String</planHensikt> <fristForInnspill>2024-03-31T09:30:47Z</fristForInnspill> <hjemmesidePlanprogram>www.planprogram.no</hjemmesidePlanprogram> <plantype> <kodeverdi>35</kodeverdi> <kodebeskrivelse>Detaljregulering</kodebeskrivelse> </plantype> <begrunnelseKU>Begrunnelse for hvorfor det ikke er krav om konsekvensutredning.</begrunnelseKU> <kommunensSaksnummer> <saksaar>2021</saksaar> <sakssekvensnummer>8062021</sakssekvensnummer> </kommunensSaksnummer> <saksgangOgMedvirkning>Saksgang og medvirkning...</saksgangOgMedvirkning> </planforslag> </Planvarsel>
Oppdatere et reguleringsplanforslag
https://docs.altinn.studio/api/apps/data-elements/
PUT {miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/64c58f8a-c4b9-4dd6-b262-5f8ab987debd Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken], Content-Type: application/xml } Binary File: oppdatertvarsel.xml
Eksempel på hvordan det ser ut i DiBKs Plandemonstrator & validator:
Vi må benytte testbrukere som er registrert i Altinns TT02-miljø for testing i plandemonstratoren.
Etter at opplasting er fullført vil plandemonstratoren opprette et varsel om oppstart av reguleringsplanarbeid.
Opplasting av vedlegg
Alle datatyper
https://docs.altinn.studio/api/apps/metadata/
Opplasting
Opplasting av vedlegg kan gjennomføres samtidig som opprettelse. Se “Oppretting av Varsel om oppstart av reguleringsplanarbeid”.
Ved opplasting av vedlegg etter at instance er opprettet gjelder følgende: https://docs.altinn.studio/api/apps/data-elements/
Laste opp vedlegg - HTTP POST
Endre eksisterende vedlegg - HTTP PUT
Eksempel på opplasting av Planinitiativ i PDF
For dataType=Planinitiativ
POST {miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data?dataType=Planinitiativ Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken], Content-Disposition: attachment; filename=planinitiativ.pdf, Content-Type: application/pdf }
Slette et vedlegg
https://docs.altinn.studio/api/apps/data-elements/
DELETE {miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/data/a337e0d8-c6d9-444a-ba5a-419f35ce2eaf Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}
Valider innsending av varsel om oppstart av reguleringsplanarbeid
https://docs.altinn.studio/nb/api/apps/validation/
GET {miljø}/dibk/reguleringsplanforslag/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/validate Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}
Fullfør innsending av varsel om oppstart av reguleringsplanarbeid
For å starte distribusjon av varsel om oppstart av reguleringsplanarbeid må instancen settes til complete status.
https://docs.altinn.studio/nb/api/apps/process/#complete-the-process
PUT {miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad/process/completeProcess Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}
Slette et reguleringsplanforslag
Legg til ?hard=true
om en ikke vil benytte søppelkasse funksjonene i altinn.
DELETE {miljø}/dibk/varselplanoppstart/instances/50170275/855c4e4c-42ea-4661-bcb0-cbbcacb5d3ad Headers: {Authorization: bearer [Exchanged ID-porten- eller Maskinportentoken]}
Legg til kommentar