API for saksoppdatering: API-kall

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

For teknisk dokumentasjon, se: Informasjon om API-design

Opprett saksoppdatering

API

POST

/api/v1/Saksoppdatering

Eksempel: request for endret kontaktpunkt

{
  "metadata": {
    "fraEbyggesaksystem": "VårtSystem",
    "innsendingReferanse": "AR12345678",
    "ftBID": "BYGG-3001",
    "avsenderId": "3817",
    "avsenderNavn": "Midt-Telemark Kommune",
    "ekspedertDato": "2023-02-17T10:13:05.243Z",
    "offentligJournalUrl": "www.kommunenavn.no/offentligjournal"
  },
  "saksnummer": {
    "saksaar": "2023",
    "sakssekvensnummer": "100",
    "journalpostnummer": ""
  },
  "melding": "Du har fått tildelt ny saksbehandler.",
  "avsenderKontaktpunkt": {
    "navn": "Grete Saksbehandler",
    "epost": "post@byggesak.no",
    "telefon": "",
    "mobil": "99887766"
  }
}

Eksempel: request for endret søknadstype

{
  "metadata": {
    "fraEbyggesaksystem": "VårtSystem",
    "innsendingReferanse": "AR12345678",
    "ftBID": "BYGG-3001",
    "avsenderId": "3817",
    "avsenderNavn": "Midt-Telemark Kommune",
    "ekspedertDato": "2023-02-17T10:13:05.243Z",
    "offentligJournalUrl": "www.kommunenavn.no/offentligjournal"
  },
  "saksnummer": {
    "saksaar": "2023",
    "sakssekvensnummer": "100",
    "journalpostnummer": ""
  },
  "melding": "",
  "utgaaendeDokument": [
    {
      "distribusjon": [
        {
          "distribusjonsMetode": "svarut"
        }
      ],
      "dokumentNavn": "Avtale om endret søknadstype",
      "mimeType": "pdf",
      "dokumentStorrelse": "30MB",
      "hoveddokument": true
    }
  ],
  "soknadstype": "RS"
}

Eksempel: request for endret tiltakstype

{
  "metadata": {
    "fraEbyggesaksystem": "VårtSystem",
    "innsendingReferanse": "AR12345678",
    "ftBID": "BYGG-3001",
    "avsenderId": "3817",
    "avsenderNavn": "Midt-Telemark Kommune",
    "ekspedertDato": "2023-02-17T10:13:05.243Z",
    "offentligJournalUrl": "www.kommunenavn.no/offentligjournal"
  },
  "saksnummer": {
    "saksaar": "2023",
    "sakssekvensnummer": "100",
    "journalpostnummer": ""
  },
  "melding": "Kommunen har splittet saken. Se tilhørende tiltakstype for sak 2023/100.",
  "tiltakstype": [
    "nyttbyggboligformal"
  ]
}

Eksempel: request for endret eiendomsopplysninger

Eksempel: response

Hent saksoppdatering

API

GET

/api/v1/Saksoppdatering

Eksempel: request

Vedtak kan hentes på to måter:

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

Bruk av innsendingsreferansen til å hente alle saksoppdateringer på en gitt innsendingsreferanse:

Eksempel: response

Under er et eksempel på response ved bruk av en innsendingsreferanse til å hente alle oppdateringer i saken.