API for endret saksnummer: API-kall

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

For teknisk dokumentasjon, se: Informasjon om API-design

Opprett endring av saksnummer

API

POST

/api/v1/SaksnummerEndringer

Eksempel: request

{
  "metadata": {
    "fraEbyggesaksystem": "VårtSystem",
    "innsendingReferanse": "AR12345678",
    "ftBID": "BYGG-3001",
    "avsenderId": "3817",
    "avsenderNavn": "Midt-Telemark Kommune",
    "ekspedertDato": "2023-02-17T09:49:17.033Z",
    "offentligJournalUrl": "www.kommunenavn.no/offentligjournal"
  },
  "melding": "Saken blir splittet i én sak per tiltakstype. Oppdaterte tiltakstyper sendes med API for saksoppdatering",
  "typeOppdatering": "splitting",
  "opprinneligSaksnummer": [
    {
      "saksaar": "2023",
      "sakssekvensnummer": "100",
      "journalpostnummer": ""
    }
  ],
  "tilSaksnummer": [
    {
      "saksaar": "2023",
      "sakssekvensnummer": "100",
      "journalpostnummer": ""
    },
    {
      "saksaar": "2023",
      "sakssekvensnummer": "101",
      "journalpostnummer": ""
    }
  ]
}

Eksempel: response

{
  "url": "api/v1/SaksnummerEndringer?id=f3c2f8c6-5421-409b-aa36-7fb7cb046afd"
}

Hent endring av saksnummer

API

GET

/api/v1/SaksnummerEndringer

Eksempel: request

Vedtak kan hentes på to måter:

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

api/v1/SaksnummerEndringer?Id=f3c2f8c6-5421-409b-aa36-7fb7cb046afd

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

Eksempel: response

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