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.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
{
"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": "101",
"journalpostnummer": ""
},
"melding": "Kommunen har splittet saken. Se tilhørende eiendom for sak 2023/101",
"eiendom": [
{
"adresselinje1": "Byggestedsgata 2A",
"gardsnummer": "123",
"bruksnummer": "45",
"seksjonsnummer": "",
"festenummer": "",
"bygningsnummer": "300640501",
"bruksenhetsnummer": ""
}
]
}
Eksempel: response
api/v1/Saksoppdatering?id=ab1b4892-2de0-42f1-ab9a-eb57215e9ed3
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:
api/v1/Saksoppdatering?id=ab1b4892-2de0-42f1-ab9a-eb57215e9ed3
Bruk av innsendingsreferansen til å hente alle saksoppdateringer på en gitt innsendingsreferanse:
api/v1/Saksoppdatering?InnsendingReferanse=AR12345678
Eksempel: response
Under er et eksempel på response ved bruk av en innsendingsreferanse til å hente alle oppdateringer i saken.
[
{
"metadata": {
"fraEbyggesaksystem": "VårtSystem",
"innsendingReferanse": "AR12345678",
"ftBID": "BYGG-3001",
"avsenderId": "3817",
"avsenderNavn": "Midt-Telemark Kommune",
"ekspedertDato": "2023-02-17T10:13:05Z"
},
"saksnummer": {
"saksaar": "2023",
"sakssekvensnummer": "100",
"journalpostnummer": ""
},
"melding": "Kommunen har splittet saken. Se tilhørende tiltakstype for sak 2023/100.",
"utgaaendeDokument": [],
"tiltakstype": [
"nyttbyggboligformal"
],
"eiendom": []
},
{
"metadata": {
"fraEbyggesaksystem": "VårtSystem",
"innsendingReferanse": "AR12345678",
"ftBID": "BYGG-3001",
"avsenderId": "3817",
"avsenderNavn": "Midt-Telemark Kommune",
"ekspedertDato": "2023-02-17T10:13:05Z"
},
"saksnummer": {
"saksaar": "2023",
"sakssekvensnummer": "100",
"journalpostnummer": ""
},
"melding": "Du har fått tildelt ny saksbehandler.",
"utgaaendeDokument": [],
"avsenderKontaktpunkt": {
"navn": "Grete Saksbehandler",
"epost": "post@byggesak.no",
"telefon": "",
"mobil": "99887766"
},
"tiltakstype": [],
"eiendom": []
},
{
"metadata": {
"fraEbyggesaksystem": "VårtSystem",
"innsendingReferanse": "AR12345678",
"ftBID": "BYGG-3001",
"avsenderId": "3817",
"avsenderNavn": "Midt-Telemark Kommune",
"ekspedertDato": "2023-02-17T10:13:05Z"
},
"saksnummer": {
"saksaar": "2023",
"sakssekvensnummer": "100",
"journalpostnummer": ""
},
"melding": "",
"utgaaendeDokument": [
{
"distribusjon": [
{
"distribusjonsMetode": "svarut"
}
],
"dokumentNavn": "Avtale om endret søknadstype.pdf",
"dokumentStorrelse": "30MB",
"hoveddokument": true
}
],
"soknadstype": "RS",
"tiltakstype": [],
"eiendom": []
},
{
"metadata": {
"fraEbyggesaksystem": "VårtSystem",
"innsendingReferanse": "AR12345678",
"ftBID": "BYGG-3001",
"avsenderId": "3817",
"avsenderNavn": "Midt-Telemark Kommune",
"ekspedertDato": "2023-02-17T10:13:05Z"
},
"saksnummer": {
"saksaar": "2023",
"sakssekvensnummer": "101",
"journalpostnummer": ""
},
"melding": "Kommunen har splittet saken. Se tilhørende eiendom for sak 2023/101",
"utgaaendeDokument": [],
"tiltakstype": [],
"eiendom": [
{
"adresselinje1": "Byggestedsgata 2A",
"gardsnummer": "123",
"bruksnummer": "45",
"seksjonsnummer": "",
"festenummer": "",
"bygningsnummer": "300640501",
"bruksenhetsnummer": ""
}
]
}
]
Legg til kommentar