Tjeneste-API, Signeringstjenesten
- Tor Oskar Ova Johnsen
- Helga Jerven
- Veslemøy Søbak
Owned by Tor Oskar Ova Johnsen
Tjeneste API-et brukes til å opprette erklæringer for signering i Signeringstjenesten for ansvarlige foretak sitt system.
Samme endepunkt brukes til å opprette alle typer erklæring, og erklæringene er identifisert av datamodell ID-er på lignende måte til Altinn sitt REST API. Denne oppbyggingen vil også følge oppbyggingen av innsendinger til valideringstjenesten.
Oppdaterte datafyllverdier for de forskjellige feltene og miljø ligger her: https://dibk.atlassian.net/wiki/spaces/FB/pages/2529001473
Oppretting av erklæring
API | POST | /api/v1/SkjemaInnsending |
Autentisering
I første omgang blir API-et beskyttet av samme Basic Authentication som Status API-et. Senere kommer vi til å bruke Maskinporten for autentisering. Inntil videre er API-et åpent under utviklingsperioden. Vi varsler på bloggen når vi legger på Basic Authentication.
Request
{
"dataFormatId": "string",
"dataFormatVersion": "string",
"formDataXml": "string",
"formMetadata": {
"signeringsfrist": "2021-09-30T21:49:00.400Z"
}
}
Eksempel for ansvarsrett
Request
{
"dataFormatId": "ErklaeringAnsvarsrett",
"dataFormatVersion": "1",
"formDataXml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><ErklaeringAnsvarsrett xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" dataFormatProvider=\"ANSAKO\" dataFormatId=\"ErklaeringAnsvarsrett\" dataFormatVersion=\"1\" xmlns=\"http://skjema.kxml.no/dibk/ansakoAnsvarsrett/v1.0\"><fraSluttbrukersystem>Fellestjenester bygg testmotor</fraSluttbrukersystem><hovedinnsendingsnummer>44556677</hovedinnsendingsnummer><eiendomByggested><eiendom><eiendomsidentifikasjon><kommunenummer>9999</kommunenummer><gaardsnummer>462</gaardsnummer><bruksnummer>65</bruksnummer><festenummer>0</festenummer><seksjonsnummer>0</seksjonsnummer></eiendomsidentifikasjon><adresse><adresselinje1>Bøgata 1</adresselinje1><adresselinje2 xsi:nil=\"true\" /><adresselinje3 xsi:nil=\"true\" /><postnr>3800</postnr><poststed>Bø i Telemark</poststed><landkode>NO</landkode><gatenavn xsi:nil=\"true\" /><husnr xsi:nil=\"true\" /><bokstav xsi:nil=\"true\" /></adresse><bygningsnummer>80466985</bygningsnummer><bolignummer>H0102</bolignummer></eiendom></eiendomByggested><kommunensSaksnummer><saksaar>2016</saksaar><sakssekvensnummer>231</sakssekvensnummer></kommunensSaksnummer><ansvarsrett><foretak><partstype><kodeverdi>Foretak</kodeverdi><kodebeskrivelse>Foretak</kodebeskrivelse></partstype><foedselsnummer xsi:nil=\"true\" /><kontaktperson><navn>Jens Jensen</navn><telefonnummer>12345678</telefonnummer><mobilnummer>98765432</mobilnummer><epost>tor@arkitektum.no</epost></kontaktperson><organisasjonsnummer>974760223</organisasjonsnummer><navn>Nordmann Bygg og Anlegg AS</navn><adresse><adresselinje1>Bøgata 16</adresselinje1><adresselinje2 xsi:nil=\"true\" /><adresselinje3 xsi:nil=\"true\" /><postnr>3802</postnr><poststed>Bø i Telemark</poststed><landkode>NO</landkode></adresse><telefonnummer>12345678</telefonnummer><mobilnummer>98765432</mobilnummer><epost>tor@arkitektum.no</epost><signaturdato>2016-12-05</signaturdato><harSentralGodkjenning>true</harSentralGodkjenning></foretak><ansvarsomraader><ansvarsomraade><beskrivelseAvAnsvarsomraade>Overordnet ansvar for kontroll</beskrivelseAvAnsvarsomraade><dekkesOmraadeAvSentralGodkjenning>false</dekkesOmraadeAvSentralGodkjenning><funksjon><kodeverdi>KONTROLL</kodeverdi><kodebeskrivelse>Ansvarlig kontroll</kodebeskrivelse></funksjon><samsvarKontrollVedFerdigattest>true</samsvarKontrollVedFerdigattest><samsvarKontrollVedIgangsettingstillatelse>true</samsvarKontrollVedIgangsettingstillatelse><samsvarKontrollVedMidlertidigBrukstillatelse>true</samsvarKontrollVedMidlertidigBrukstillatelse><samsvarKontrollVedRammetillatelse>false</samsvarKontrollVedRammetillatelse><tiltaksklasse><kodeverdi>2</kodeverdi><kodebeskrivelse>Tiltaksklasse 2</kodebeskrivelse></tiltaksklasse><soeknadssystemetsReferanse>20afb7d0-4ac5-4622-9e85-6978bd002cc1</soeknadssystemetsReferanse></ansvarsomraade><ansvarsomraade><beskrivelseAvAnsvarsomraade>Overordnet ansvar for utførelse (bygning, anlegg eller konstruksjon, tekniske installasjoner)</beskrivelseAvAnsvarsomraade><dekkesOmraadeAvSentralGodkjenning>false</dekkesOmraadeAvSentralGodkjenning><funksjon><kodeverdi>UTF</kodeverdi><kodebeskrivelse>Ansvarlig utførelse</kodebeskrivelse></funksjon><samsvarKontrollVedFerdigattest>true</samsvarKontrollVedFerdigattest><samsvarKontrollVedIgangsettingstillatelse>true</samsvarKontrollVedIgangsettingstillatelse><samsvarKontrollVedMidlertidigBrukstillatelse>false</samsvarKontrollVedMidlertidigBrukstillatelse><samsvarKontrollVedRammetillatelse>false</samsvarKontrollVedRammetillatelse><tiltaksklasse><kodeverdi>2</kodeverdi><kodebeskrivelse>Tiltaksklasse 2</kodebeskrivelse></tiltaksklasse><soeknadssystemetsReferanse>c39bee8c-eab4-4fd7-8da0-dfbca23e56a1</soeknadssystemetsReferanse></ansvarsomraade><ansvarsomraade><beskrivelseAvAnsvarsomraade>Andre</beskrivelseAvAnsvarsomraade><dekkesOmraadeAvSentralGodkjenning>false</dekkesOmraadeAvSentralGodkjenning><funksjon><kodeverdi>SØK</kodeverdi><kodebeskrivelse>Ansvarlig søker</kodebeskrivelse></funksjon><samsvarKontrollVedFerdigattest>false</samsvarKontrollVedFerdigattest><samsvarKontrollVedIgangsettingstillatelse>false</samsvarKontrollVedIgangsettingstillatelse><samsvarKontrollVedMidlertidigBrukstillatelse>false</samsvarKontrollVedMidlertidigBrukstillatelse><samsvarKontrollVedRammetillatelse>false</samsvarKontrollVedRammetillatelse><tiltaksklasse><kodeverdi>2</kodeverdi><kodebeskrivelse>Tiltaksklasse 2</kodebeskrivelse></tiltaksklasse><soeknadssystemetsReferanse>26257cf3-41ab-4337-8ca9-9fe925ed4c56</soeknadssystemetsReferanse></ansvarsomraade><ansvarsomraade><beskrivelseAvAnsvarsomraade>Overordnet ansvar for prosjektering (bygning, anlegg eller konstruksjon, tekniske installasjoner)</beskrivelseAvAnsvarsomraade><dekkesOmraadeAvSentralGodkjenning>false</dekkesOmraadeAvSentralGodkjenning><funksjon><kodeverdi>PRO</kodeverdi><kodebeskrivelse>Ansvarlig prosjektering</kodebeskrivelse></funksjon><samsvarKontrollVedFerdigattest>true</samsvarKontrollVedFerdigattest><samsvarKontrollVedIgangsettingstillatelse>true</samsvarKontrollVedIgangsettingstillatelse><samsvarKontrollVedMidlertidigBrukstillatelse>true</samsvarKontrollVedMidlertidigBrukstillatelse><samsvarKontrollVedRammetillatelse>true</samsvarKontrollVedRammetillatelse><tiltaksklasse><kodeverdi>2</kodeverdi><kodebeskrivelse>Tiltaksklasse 2</kodebeskrivelse></tiltaksklasse><soeknadssystemetsReferanse>6efad928-359d-40ee-b21c-2177ccb2f4ce</soeknadssystemetsReferanse></ansvarsomraade><ansvarsomraade><beskrivelseAvAnsvarsomraade>Overordnet ansvar for prosjektering (bygning, anlegg eller konstruksjon, tekniske installasjoner)</beskrivelseAvAnsvarsomraade><dekkesOmraadeAvSentralGodkjenning>true</dekkesOmraadeAvSentralGodkjenning><funksjon><kodeverdi>PRO</kodeverdi><kodebeskrivelse>Ansvarlig prosjektering</kodebeskrivelse></funksjon><samsvarKontrollVedFerdigattest>true</samsvarKontrollVedFerdigattest><samsvarKontrollVedIgangsettingstillatelse>true</samsvarKontrollVedIgangsettingstillatelse><samsvarKontrollVedMidlertidigBrukstillatelse>true</samsvarKontrollVedMidlertidigBrukstillatelse><samsvarKontrollVedRammetillatelse>true</samsvarKontrollVedRammetillatelse><tiltaksklasse><kodeverdi>2</kodeverdi><kodebeskrivelse>Tiltaksklasse 2</kodebeskrivelse></tiltaksklasse><soeknadssystemetsReferanse>83922f95-4f2a-40e7-bbcd-bac5c41a5758</soeknadssystemetsReferanse></ansvarsomraade></ansvarsomraader><erklaeringAnsvarligProsjekterende>true</erklaeringAnsvarligProsjekterende><erklaeringAnsvarligUtfoerende>true</erklaeringAnsvarligUtfoerende><erklaeringAnsvarligKontrollerende>true</erklaeringAnsvarligKontrollerende></ansvarsrett><ansvarligSoeker><partstype><kodeverdi>Foretak</kodeverdi><kodebeskrivelse>Foretak</kodebeskrivelse></partstype><foedselsnummer xsi:nil=\"true\" /><kontaktperson><navn>Siv. Ing. Borge</navn><telefonnummer>12345678</telefonnummer><mobilnummer>98765432</mobilnummer><epost>tor@arkitektum.no</epost></kontaktperson><organisasjonsnummer>910297937</organisasjonsnummer><navn>FANA OG HAFSLO REVISJON</navn><adresse><adresselinje1>Bøgata 16</adresselinje1><adresselinje2 xsi:nil=\"true\" /><adresselinje3 xsi:nil=\"true\" /><postnr>3802</postnr><poststed>Bø i Telemark</poststed><landkode>NO</landkode></adresse><telefonnummer>11223344</telefonnummer><mobilnummer>99887766</mobilnummer><epost>tor@arkitektum.no</epost></ansvarligSoeker><signatur><signaturdato>2016-09-08T00:00:00</signaturdato><signertAv /><signertPaaVegneAv /><signeringssteg /></signatur><prosjektnavn xsi:nil=\"true\" /></ErklaeringAnsvarsrett>",
"formMetadata": {
"signeringsfrist": "2021-09-30T21:49:00.400Z"
}
}https://signeringstjenesten-api.ft-test.dibk.no/api/v1/SkjemaInnsending
Response
{
"formType": "ansvarsrett",
"referanseId": "c8a78aa6-1b52-4137-9795-a0e4e446f04a",
"dataFormatId": "ErklaeringAnsvarsrett",
"dataFormatVersion": "1",
"formMetadata": {
"signeringsfrist": "2021-09-30T21:49:00.4Z"
},
"ansvarsomraadeReferanser": [
{
"soeknadsystemetsReferanse": "20afb7d0-4ac5-4622-9e85-6978bd002cc1",
"beskrivelseAvAnsvarsomraade": "Overordnet ansvar for kontroll"
},
{
"soeknadsystemetsReferanse": "c39bee8c-eab4-4fd7-8da0-dfbca23e56a1",
"beskrivelseAvAnsvarsomraade": "Overordnet ansvar for utførelse (bygning, anlegg eller konstruksjon, tekniske installasjoner)"
},
{
"soeknadsystemetsReferanse": "26257cf3-41ab-4337-8ca9-9fe925ed4c56",
"beskrivelseAvAnsvarsomraade": "Andre"
},
{
"soeknadsystemetsReferanse": "6efad928-359d-40ee-b21c-2177ccb2f4ce",
"beskrivelseAvAnsvarsomraade": "Overordnet ansvar for prosjektering (bygning, anlegg eller konstruksjon, tekniske installasjoner)"
},
{
"soeknadsystemetsReferanse": "83922f95-4f2a-40e7-bbcd-bac5c41a5758",
"beskrivelseAvAnsvarsomraade": "Overordnet ansvar for prosjektering (bygning, anlegg eller konstruksjon, tekniske installasjoner)"
}
],
"_links": {
"utfylling_av_skjema": {
"href": "https://dibk-ftpb-broop-frontend.azurewebsites.net/skjema/c8a78aa6-1b52-4137-9795-a0e4e446f04a"
}
}
}Responsen returnerer innsendte metadata, legger ut en liste av ansvarsområder og ID-er som er funnet i innsendingen og legger ut lenken til utfylling av skjema.
Eksempel samsvarserklæring
Request
https://signeringstjenesten-api.ft-test.dibk.no/api/v1/SkjemaInnsending
Response
Eksempel kontrollerklæring
Request
https://signeringstjenesten-api.ft-test.dibk.no/api/v1/SkjemaInnsending
Response
Notater om innsending
Kombinere ansvarsretter i samme signering
Første versjon av Signeringstjenesten for ansvarlige foretak kombinerer alle ansvarsområdene som ligger i samme skjemainnsending i samme signeringsoppdrag. Det er ikke mulig å trekke fra eller legge til ansvarsområder fra en signering i denne versjonen. Vi beregner å kunne legge til funksjonalitet på dette området i senere versjoner.
Krav til soeknadsystemetsReferanse
I signeringstjenesten bruker vi denne ID-en aktivt i systemet. Se regler her: Valideringsregler, Signeringstjenesten v.1
Sentral godkjenning
Feltet harSentralGodkjenning kan settes til true, false eller null. Hvis det er true eller false, bruker vi denne verdien i systemet. Hvis søknadssystemet setter feltet til null, slår signeringstjenesten opp i SG-registeret for organisasjonsnummeret til foretaket.
Organisasjonsnummer som kan testes mot i SG registeret ligger her: