API for innsending av reguleringsplanforslag

Forskjellige miljøer

Miljø - angitt som {miljø} i videre tekst	Basis url
Lokalt/utviklingsmiljø	https://altinn3local.no
Testmiljø (tt02)	https://dibk.apps.tt02.altinn.no
Produksjon	https://dibk.apps.altinn.no

Autentisering

For test og produksjonsmiljø så må ID-porten benyttes, hvor dette veksles inn i et Altinn token. Se https://altinn.github.io/docs/api/rest/kom-i-gang/#autentisering2

Oppretting av nytt reguleringsplanforslag

https://docs.altinn.studio/teknologi/altinnstudio/altinn-api/app-api/instances/#create-instance

POST {miljø}/dibk/reguleringsplanforslag/instances

Request:

{
    "appId" : "dibk/reguleringsplanforslag",
    "instanceOwner": 
    {
        "personNumber": "01017512345",
        "organisationNumber": null
    }
}

Respons:

{
    "id": "12345/12209c8d-86a5-4c54-b256-4682f905f31c",
    "instanceOwner": {
        "partyId": "12345",
        "personNumber": "01017512345"
    },
    "appId": "dibk/reguleringsplanforslag",
    "org": "dibk",
    "selfLinks": {
        "apps": "https://altinn3local.no/dibk/reguleringsplanforslag/instances/12345/12209c8d-86a5-4c54-b256-4682f905f31c",
        "platform": "https://platform.altinn3local.no/storage/api/v1/instances/12345/12209c8d-86a5-4c54-b256-4682f905f31c"
    },
    "process": {
        "started": "2021-01-22T10:15:30.1999709Z",
        "startEvent": "StartEvent_1",
        "currentTask": {
            "flow": 2,
            "started": "2021-01-22T10:15:30.2221966Z",
            "elementId": "Task_1",
            "name": "Utfylling",
            "altinnTaskType": "data"
        }
    },
    "data": [
        {
            "id": "76300110-df37-4f8b-bad8-53de243a4998",
            "instanceGuid": "12209c8d-86a5-4c54-b256-4682f905f31c",
            "dataType": "reguleringsplanforslag",
            "contentType": "application/xml",
            "blobStoragePath": "dibk/reguleringsplanforslag/12209c8d-86a5-4c54-b256-4682f905f31c/data/76300110-df37-4f8b-bad8-53de243a4998",
            "selfLinks": {
                "apps": "https://altinn3local.no/dibk/reguleringsplanforslag/instances/12345/12209c8d-86a5-4c54-b256-4682f905f31c/data/76300110-df37-4f8b-bad8-53de243a4998",
                "platform": "https://platform.altinn3local.no/storage/api/v1/instances/12345/12209c8d-86a5-4c54-b256-4682f905f31c/data/76300110-df37-4f8b-bad8-53de243a4998"
            },
            "size": 664,
            "locked": false,
            "refs": [],
            "isRead": true,
            "created": "2021-01-22T10:15:30.6395289Z",
            "lastChanged": "2021-01-22T10:15:30.6395289Z"
        }
    ],
    "created": "2021-01-22T10:15:30.2530894Z",
    "lastChanged": "2021-01-22T10:15:30.2530894Z"
}

Hente ut et reguleringsplanforslag

https://docs.altinn.studio/teknologi/altinnstudio/altinn-api/app-api/instances/#get-instance

GET {miljø}/dibk/reguleringsplanforslag/instances/12345/12209c8d-86a5-4c54-b256-4682f905f31c

Respons:

{
    "id": "12345/12209c8d-86a5-4c54-b256-4682f905f31c",
    "instanceOwner": {
        "partyId": "12345",
        "personNumber": "01017512345"
    },
    "appId": "dibk/reguleringsplanforslag",
    "org": "dibk",
    "selfLinks": {
        "apps": "https://altinn3local.no/dibk/reguleringsplanforslag/instances/12345/12209c8d-86a5-4c54-b256-4682f905f31c",
        "platform": "https://platform.altinn3local.no/storage/api/v1/instances/12345/12209c8d-86a5-4c54-b256-4682f905f31c"
    },
    "process": {
        "started": "2021-01-22T10:15:30.1999709Z",
        "startEvent": "StartEvent_1",
        "currentTask": {
            "flow": 2,
            "started": "2021-01-22T10:15:30.2221966Z",
            "elementId": "Task_1",
            "name": "Utfylling",
            "altinnTaskType": "data"
        }
    },
    "data": [
        {
            "id": "76300110-df37-4f8b-bad8-53de243a4998",
            "instanceGuid": "12209c8d-86a5-4c54-b256-4682f905f31c",
            "dataType": "reguleringsplanforslag",
            "contentType": "application/xml",
            "blobStoragePath": "dibk/reguleringsplanforslag/12209c8d-86a5-4c54-b256-4682f905f31c/data/76300110-df37-4f8b-bad8-53de243a4998",
            "selfLinks": {
                "apps": "https://altinn3local.no/dibk/reguleringsplanforslag/instances/12345/12209c8d-86a5-4c54-b256-4682f905f31c/data/76300110-df37-4f8b-bad8-53de243a4998",
                "platform": "https://platform.altinn3local.no/storage/api/v1/instances/12345/12209c8d-86a5-4c54-b256-4682f905f31c/data/76300110-df37-4f8b-bad8-53de243a4998"
            },
            "size": 664,
            "locked": false,
            "refs": [],
            "isRead": true,
            "created": "2021-01-22T10:15:30.6395289Z",
            "lastChanged": "2021-01-22T10:15:30.6395289Z"
        }
    ],
    "created": "2021-01-22T10:15:30.2530894Z",
    "lastChanged": "2021-01-22T10:15:30.2530894Z"
}

Hente ut skjema(prosjektinformasjon)

For dataType = "reguleringsplanforslag"

GET {miljø}/dibk/reguleringsplanforslag/instances/12345/12209c8d-86a5-4c54-b256-4682f905f31c/data/76300110-df37-4f8b-bad8-53de243a4998
Accept: application/xml

Respons:

<ReguleringsplanforslagType xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" dataFormatProvider="SERES" dataFormatId="6826" dataFormatVersion="45995">
    <forslagsstiller>
        <kontaktperson>
            <navn>Ola Nordmann</navn>
        </kontaktperson>
        <foedselsnummer>01017512345</foedselsnummer>
        <adresse>
            <adresselinje1>Blåbæreveien 7</adresselinje1>
            <postnr>8450</postnr>
            <poststed>Stokmarknes</poststed>
        </adresse>
        <telefonnummer>12345678</telefonnummer>
        <mobilnummer>87654321</mobilnummer>
    </forslagsstiller>
</ReguleringsplanforslagType>

Oppdatere et reguleringsplanforslag

PUT {miljø}/dibk/reguleringsplanforslag/instances/12345/12209c8d-86a5-4c54-b256-4682f905f31c/data/76300110-df37-4f8b-bad8-53de243a4998
Content-Type: application/xml

Request:

<ReguleringsplanforslagType xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" dataFormatProvider="SERES" dataFormatId="6826" dataFormatVersion="45995">
    <forslagsstiller>
        <kontaktperson>
            <navn>Ola Nordmann</navn>
        </kontaktperson>
        <foedselsnummer>01017512345</foedselsnummer>
        <adresse>
            <adresselinje1>Blåbæreveien 7</adresselinje1>
            <postnr>8450</postnr>
            <poststed>Stokmarknes</poststed>
        </adresse>
        <telefonnummer>123456</telefonnummer>
        <mobilnummer>87654321</mobilnummer>
    </forslagsstiller>
    <arealplanId>
        <administrativEnhet>
            <kommunenummer>9998</kommunenummer>
        </administrativEnhet>
        <planidentifikasjon>12123</planidentifikasjon>
    </arealplanId>
    <plantype>
        <kodeverdi>35</kodeverdi>
        <kodebeskrivelse>Detaljregulering</kodebeskrivelse>
    </plantype>
    <plannavn>OMRÅDEPLAN FOR HIS ALLÉ</plannavn>
    <lovreferanse>
        <kodeverdi>6</kodeverdi>
        <kodebeskrivelse>PBL2008</kodebeskrivelse>
    </lovreferanse>
</ReguleringsplanforslagType>

Eksempel på hvordan det ser ut i Altinn 3 testmotor:

Opplasting av vedlegg

https://docs.altinn.studio/teknologi/altinnstudio/altinn-api/app-api/data-elements/#uploading-an-attachment

Planbestemmelse i xml

For dataType=vedleggXmlBestemmelse

POST {miljø}/dibk/reguleringsplanforslag/instances/12345/309ea8b3-6414-44ca-a07c-836c364e790d/data?dataType=vedleggXmlBestemmelse
Content-Disposition: attachment; filename=planbestemmelse.xml
Content-Type: text/xml

Plankart i gml

For dataType=vedleggGmlPlankart

POST {miljø}/dibk/reguleringsplanforslag/instances/12345/309ea8b3-6414-44ca-a07c-836c364e790d/data?dataType=vedleggGmlPlankart 
Content-Disposition: attachment; filename=plankart-2d.gml
Content-Type: application/octet-stream

Eksempel på disse vedlegg lastet opp i Altinn 3 testmotor:

Andre datatyper for opplasting:

dataType	Beskrivelse
InnsendingReguleringsplanforslag	Skjema for oversendelse av planforslaget
planinitiativ	Plankart i GML format
planprogram
planbeskrivelse
planbestemmelse
planbestemmelseXml
plankart
plankartGml2d
plankartGml3d
planpakke
varslingsbrev
varslingsliste
uttalelseSamling
uttalelseKommentarer
illustrasjon
rosAnalyse
konsekvensutredning
stedsanalyse
grunnforholdGeoteknikk
grunnforholdForurensetGrunn
trafikkutredning
stoyutredning
arkeologiskeUndersokelser
rammeplanVAO
biologiskMangfold
valideringsrapport
annet

Oppdatere et vedlegg

PUT {miljø}/dibk/reguleringsplanforslag/instances/12345/309ea8b3-6414-44ca-a07c-836c364e790d/data/07fee8a4-570c-4cda-b6b7-7a50bb85eb9d
Content-Disposition: attachment; filename=planbestemmelse.xml
Content-Type:text/xml

Slette et vedlegg

DELETE {miljø}/dibk/reguleringsplanforslag/instances/12345/309ea8b3-6414-44ca-a07c-836c364e790d/data/07fee8a4-570c-4cda-b6b7-7a50bb85eb9d

Sende inn et reguleringsplanforslag

Hvis alle valideringsregler som resulterer i feil er ok, så forsøker kallet å flytte innsendingen til status innsendt. Kallet vil vente på bekreftelse fra blant annet SvarUt på at forsendelsen er mottat og under overføring til aktuell kommune.

PUT {miljø}/dibk/reguleringsplanforslag/instances/12345/309ea8b3-6414-44ca-a07c-836c364e790d/process/completeProcess

Slette et reguleringsplanforslag

Legg til ?hard=true om en ikke vil benytte søppelkasse funksjonene i altinn.

DELETE {miljø}/dibk/reguleringsplanforslag/instances/12345/309ea8b3-6414-44ca-a07c-836c364e790d