API for innsending av Varsel om oppstart av reguleringsplanarbeid v2
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
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
Respons
Hente ut varsel (Planvarsel)
For dataType = "Planvarsel"
Respons
Oppdatere et reguleringsplanforslag
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
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:
Laste opp vedlegg - HTTP POST
Endre eksisterende vedlegg - HTTP PUT
Eksempel på opplasting av Planinitiativ i PDF
For dataType=Planinitiativ
Slette et vedlegg
Valider innsending av varsel om oppstart av reguleringsplanarbeid
Fullfør innsending av varsel om oppstart av reguleringsplanarbeid
For å starte distribusjon av varsel om oppstart av reguleringsplanarbeid må instancen settes til complete status.
Slette et reguleringsplanforslag
Legg til ?hard=true om en ikke vil benytte søppelkasse funksjonene i altinn.