API for vedtak: API-kall

Under viser vi eksempler på API-kall for vedtaks-APIet.

For teknisk dokumentasjon, se: Informasjon om API-design

Opprett vedtak

API

POST

/api/v1/vedtak

Eksempel: request

{
  "metadata": {
    "fraEbyggesaksystem": "VårtSystem",
    "innsendingReferanse": "AR12345678",
    "ftBID": "BYGG-3001",
    "avsenderId": "3817",
    "avsenderNavn": "Midt-Telemark Kommune",
    "ekspedertDato": "2023-02-03T13:57:41.444Z",
    "offentligJournalUrl": "www.kommunenavn.no/offentligjournal"
  },
  "saksnummer": {
    "saksaar": "2023",
    "sakssekvensnummer": "12421",
    "journalpostnummer": "14"
  },
  "milepæl": "VT",
  "saksbehandlingsfrist": "2023-02-03T13:57:41.444Z",
  "utgaaendeDokument": [
    {
      "distribusjon": [
        {
          "distribusjonsMetode": "ftb",
          "dokumentUrl": "https://admbygg.dibk.no/api/download/bf65a6da-d59f-4ecd-9953-831c7303e587/tillatelse.pdf "
        },
        {
          "distribusjonsMetode": "svarut"
        }
      ],
      "dokumentNavn": "Vedtak om gitt tillatelse.pdf",
      "mimeType": "pdf",
      "dokumentStorrelse": "105MB",
      "hoveddokument": true
    },
    {
      "distribusjon": [
        {
          "distribusjonsMetode": "svarut"
        }
      ],
      "dokumentNavn": "Informasjon om klage.pdf",
      "dokumentStorrelse": "45MB",
      "hoveddokument": false
    }
  ],
  "oversiktGodkjenteDokumenter": [
    {
      "dokumentTittel": "Tegning 1. etasje.pdf",
      "versjonsDato": "2022-11-15T13:57:41.444Z",
      "versjonsnummer": "1",
      "vedleggsType": "TegningNyttSnitt"
    },
    {
      "dokumentTittel": "Tegning 2. etasje.pdf",
      "versjonsDato": "2023-01-25T13:57:41.444Z",
      "versjonsnummer": "2",
      "vedleggsType": "TegningNyttSnitt"
    }
  ],
  "vedtakStatus": "1",
  "sjekklisteUtfall": [
    {
      "utfallId": "000-324435sada-344534sad-123234a",
      "utfallType": "SVV",
      "utlostFraSjekkpunkt": {
        "sjekkpunktID": "4.3",
        "sjekkpunktTittel": "Er krav til avfallsplan bekreftet i søknad?",
        "sjekkpunktUrl": "https://ftb-checklist.dibk.no/checklist/ET/12116/details",
        "sjekkpunktEier": "DiBK"
      },
      "beskrivelseAvUtfall": {
        "tittel": "Sluttrapport for bygningsavfall skal leveres ved ferdigattest",
        "beskrivelse": "Sluttrapport for bygningsavfall skal sendes kommunen sammen med søknaden om ferdigattest.",
        "veiledningstekst": "Arbeidet med avfallsplan skal være påbegynt allerede ved søknaden om ettrinn, men skal ikke sendes kommunen før ved ferdigattest.",
        "lovhjemmel": [
          "TEK17 § 9-9",
          "jf. § TEK17 9-6 første ledd"
        ]
      },
      "oppfyllesTilFase": "FA"
    },
    {
      "utfallId": "000-324435sada-344534sad-123234b",
      "utfallType": "MKV",
      "utlostFraSjekkpunkt": {
        "sjekkpunktEier": "Kommunen"
      },
      "beskrivelseAvUtfall": {
        "tittel": "Vannmåler",
        "beskrivelse": "Før bygningen kan tas i bruk, skal det monteres en vannmåler."
      }
    }
  ]
}

Eksempel: response

{
  "url": "/api/v1/Vedtak?id=3b3f3f44-d63c-4cd0-9f9d-a762980ffc08"
}

Hent vedtak

API

GET

/api/v1/vedtak

Eksempel: request

Vedtak kan hentes på to måter:

Bruk av ID-en til vedtaket. ID-en er hentet fra responsen til POST-API-et:

api/v1/Vedtak?id=3b3f3f44-d63c-4cd0-9f9d-a762980ffc08

2. Bruk av innsendingsreferansen til å hente alle vedtak på en gitt innsendingsreferanse:

Eksempel: response

Under er et eksempel på response ved bruk av en ID for vedtak.