API for mangler: API-kall

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

For teknisk dokumentasjon, se: Informasjon om API-design

Opprett mangel

API

POST

/api/v1/mangel

Eksempel: request

{
  "metadata": {
    "fraEbyggesaksystem": "VårtSystem",
    "innsendingReferanse": "AR12345678",
    "ftBID": "BYGG-3001",
    "avsenderId": "3817",
    "avsenderNavn": "Midt-Telemark Kommune",
    "ekspedertDato": "2023-01-27T11:17:36.980Z",
    "offentligJournalUrl": "www.kommunenavn.no/offentligjournal"
  },
  "saksnummer": {
    "saksaar": "2023",
    "sakssekvensnummer": "12421",
    "journalpostnummer": "12"
  },
  "milepæl": "MB",
  "saksbehandlingsfrist": "2023-03-27T11:17:36.980Z",
  "utgaaendeDokument": [
    {
      "distribusjon": [
        {
          "distribusjonsMetode": "ftb",
          "dokumentUrl": "https://saksbehandlingsdataapi-test.dibk.no/api/v1/dokument/fbeac477-613c-4a8b-917c-775894e98c7e"
        }
      ],
      "dokumentNavn": "Behov for supplering av søknad.pdf",
      "mimeType": "pdf",
      "dokumentStorrelse": "90MB",
      "hoveddokument": true
    },
    {
      "distribusjon": [
        {
          "distribusjonsMetode": "ftb",
          "dokumentUrl": "https://saksbehandlingsdataapi-test.dibk.no/api/v1/dokument/fbeac477-613c-4a8b-917c-775894e98c7f"
        }
      ],
      "dokumentNavn": "Informasjon om klage.pdf",
      "dokumentStorrelse": "45MB",
      "hoveddokument": false
    }
  ],
  "svarfrist": "2023-02-27T11:17:36.980Z",
  "sjekklisteUtfall": [
    {
      "utfallId": "MSL-3185245",
      "utfallType": "MSL",
      "utlostFraSjekkpunkt": {
        "sjekkpunktID": "11.4",
        "sjekkpunktTittel": "Er det fastsatt korrekt sikkerhetsklasse for flom/stormflo?",
        "sjekkpunktUrl": "https://ftb-checklist.dibk.no/checklist/ET/12430/details",
        "sjekkpunktEier": "DiBK"
      },
      "beskrivelseAvUtfall": {
        "tittel": "Sikkerhetsklasse for storm/stormflo",
        "beskrivelse": "Det må sendes inn en redegjørelse for valgt sikkerhetsklasse for flom og/eller stormflo.",
        "veiledningstekst": "",
        "lovhjemmel": [
          "pbl § 28-1 tredje ledd",
          "TEK17 § 7-2 andre ledd og tredje ledd"
        ]
      },
      "oppfyllesTilFase": "RS"
    },
    {
      "utfallId": "dok-318593",
      "utfallType": "DOK",
      "utlostFraSjekkpunkt": {
        "sjekkpunktID": "11.6",
        "sjekkpunktTittel": "Kan det innhentes ytterligere dokumentasjon på at sikkerheten med hensyns til flom og stormflo likevel er ivaretatt?",
        "sjekkpunktUrl": "https://ftb-checklist.dibk.no/checklist/ET/12428/details",
        "sjekkpunktEier": "DiBK"
      },
      "beskrivelseAvUtfall": {
        "tittel": "Ytterligere dokumentasjon på sikkerheten ved flom og stormflo",
        "beskrivelse": "Kommunen vurderer at flomkartlegging og dokumentasjon fra fagkyndig ikke er tilstrekkelig utredet. Vi ber om ytterligere dokumentasjon på at sikkerheten med hensyn til flom og stormflo likevel er ivaretatt.",
        "veiledningstekst": "Kommunen har ikke hjemmel for å pålegge utredning, men må avslå dersom sikkerhet ikke er tilstrekkelig dokumentert.",
        "lovhjemmel": [
          "TEK17 § 7-2"
        ]
      },
      "oppfyllesTilFase": "ET"
    }
  ]
}

Eksempel: response

{
  "url": "/api/v1/Mangel?id=9cc02fa4-f960-49ec-a53b-7e4f099dd83d"
}

Hent mangel

API

GET

/api/v1/mangel

Eksempel: request

Mangler kan hentes på to måter:

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

api/v1/Mangel?Id=9cc02fa4-f960-49ec-a53b-7e4f099dd83d

2. Bruk av innsendingsreferansen til å hente alle mangler på en gitt innsending:

Eksempel: response

Under er et eksempel på response ved bruk av en innsendingsreferanse hvor det har kommet to mangler på innsendingsreferansen AR12345678.