Grensesnittbeskrivelse

REST-tjeneste for innsending av informasjon til Folkeregisteret. Dokument som kan sendes inn er representert i listen over ressurser under. For å sende inn et dokument brukes kommandoen POST mot riktig URL med dokumentet som body i innsendingen. Formatet på meldingen skal være UTF-8.

Tjenestenes endepunkt:
POST {miljø}/folkeregisteret/mottak/api/{ressurs}

Ressurser

Her finner du egen xsd for kryptografisk signatur av meldingene.

Eksempler

Curl-kommando som kan benyttes for å teste tjenesten:

$ curl -k -v -X HEAD --cert datakonsument.cer --key datakonsument.key "https://folkeregisteret-api-ekstern.sits.no/folkeregisteret/mottak/api/rekvisisjon_av_dnummer_v4"

Statuskode 202

Sammen med statuskode 202 kommer en datastruktur som ser slik ut:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <meldingMottatt>
      <folkeregisterReferanse>47956f5b-fa1e-447d-a62d-b6714bc1f120</folkeregisterReferanse>
      <avsendersMeldingsidentifikator>unik-3efaf50b2a19</avsendersMeldingsidentifikator>
    </meldingMottatt>
    

Feilkoder

Hvis statuskode ikke 202 men man får svar fra applikasjonen, så returneres en datastruktur som ser slik ut

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <folkeregisterFeilmelding>
      <httpStatus>403</httpStatus>
      <alvorlighetsgrad>WARNING</alvorlighetsgrad>
      <feilkode>ske.folkeregister.mottak.infrastructure.exceptions.KonsumentManglerTilgangException</feilkode>
      <feilmelding>Produsent har ikke tilgang til å sende inn D_NUMMER_REKVISISJON_V4</feilmelding>
      <tilleggsinformasjon>
      </tilleggsinformasjon>
    </folkeregisterFeilmelding>
    

Miljøer

Multipart

Innsending av Dnr-rekvisisjon med vedlegg på endepunktene ".vedlegg" må gjøres som en multipart-request. I all hovedsak er det en ordinær multipart med xml og vedlegg som hver sine deler av requesten men det er to krav:
1) "Name" i Content-disposition for xml og vedlegg må være 'rekvisisjon' og 'vedlegg'.
2) "Filename" i Content-disposition for vedlegg må matche filnavnet som er angitt i xml i feltet 'multipartnavn' for identifikasjonsdokumentet.

Eks: POST http://folkeregisteret-api-ekstern.sits.no/folkeregisteret/mottak/api/rekvisisjon_av_dnummer_v5.vedlegg HTTP/1.1
Content-Type: multipart/form-data; boundary=ahmbD7nC0ZRm0ME0uKQXJKQHDWASO_Ur
Host: folkeregisteret-api-ekstern.sits.no
Expect: 100-continue
Accept-Encoding: gzip, deflate
Proxy-Connection: Keep-Alive

--ahmbD7nC0ZRm0ME0uKQXJKQHDWASO_Ur
Content-Disposition: form-data; name="rekvisisjon"; filename="et-eller-annet-dnr_rekv.xml"
Content-Type: application/xml; charset=UTF-8
Content-Transfer-Encoding: binary
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
osv. her kommer XML-meldingen

--ahmbD7nC0ZRm0ME0uKQXJKQHDWASO_Ur
Content-Disposition: form-data; name="vedlegg1"; filename="pass2.pdf"
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: binary
her kommer pdf'en