:Versjon 1.1.1

Tjenestene i APIet

HTTP-verb Endepunkt Beskrivelse

GET

/

Rot. Lister lenker til øvrige tjenester.

GET

/konkursvarsler

Henter alle konkursvarsler.

GET

/konkursvarsler/{uuid}

Returnerer konkursvarslet til UUIDen man ønsker oppslag på.

GET

/konkursvarsler/oppdatert/{registreringstidspunkt}

Henter alle konkursvarsler etter et gitt registreringstidspunkt.

Endepunkter i testmiljø og produksjonsmiljø

Miljø Endepunkter IP

test

https://konkursvarsel.ppe-vcert.brreg.no

195.43.63.219

Produksjon

https://konkursvarsel.vcert.brreg.no

195.43.63.220

Kodeliste

Type konkursvarsel

Konkursvarsel Beskrivelse

aapning

Åpning av konkurs, tvangsavvikling eller tvangsoppløsning

oppheving

Endring som følge av en anke på åpning (aapning)

sletting

Sletting av en åpning (aapning)

avslutning

Avslutning av en konkurs, tvangsavvikling eller tvangsoppløsning

Konkursgrunnlag

Konkursgrunnlag Beskrivelse

B

Konkursåpning Begjæring

O

Konkursåpning Oppbud

T

Tvangsavvikling, Tvangsoppløsning

Avviklingskode

Avviklingskode Beskrivelse

TVDL

Tvangsoppløst på grunn av manglende daglig leder

TVRE

Tvangsoppløst på grunn av manglende revisor

TVRR

Tvangsoppløst på grunn av manglende innsendt årsoppgjør

TVST

Tvangsoppløst på grunn av manglende styre

TVBA

Tvangsoppløst da organisasjonsformen BA (selskap med begrenset ansvar) ikke har meldt omdanning til SA (samvirkeforetak)

TVOV

Tvangsavviklet da selskapet ikke har meldt endelig oppløsning til Foretaksregisteret innen ett år fra kunngjøring om oppløsning

Avslutningskode

Avslutningskode Beskrivelse

M

Manglende midler §135

U

Utlodning §128

T

Tilbakelevering §136

A

Tvangsakkord §125

Hent alle konkursvarsler

Denne metoden henter alle konkursvarsler.

HTTP request

GET /konkursvarsler HTTP/1.1
Host: konkursvarsel.ppe-vcert.brreg.no

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 3523

{
  "_embedded" : {
    "konkursvarsler" : [ {
      "uuid" : "ae9849b7-e60f-484f-b666-4f07537286f4",
      "type" : "aapning",
      "registreringstidspunkt" : "2018-06-08T11:34:23.111Z",
      "kjennelsesdato" : "2018-06-08",
      "debitor" : "910425463",
      "_links" : {
        "self" : {
          "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/ae9849b7-e60f-484f-b666-4f07537286f4"
        }
      }
    }, {
      "uuid" : "557c234f-8ccd-42b1-ad46-df5700a0ccec",
      "type" : "oppheving",
      "registreringstidspunkt" : "2018-07-08T11:54:23.222Z",
      "kjennelsesdato" : "2018-07-08",
      "aapningsId" : "ae9849b7-e60f-484f-b666-4f07537286f4",
      "debitor" : "910425463",
      "_links" : {
        "self" : {
          "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/557c234f-8ccd-42b1-ad46-df5700a0ccec"
        }
      }
    }, {
      "uuid" : "f0712a43-1269-4cc4-8cd7-b59e23b24dd6",
      "type" : "aapning",
      "registreringstidspunkt" : "2018-10-10T11:54:23.333Z",
      "kjennelsesdato" : "2018-10-10",
      "debitor" : "19020101140",
      "innehaverAv" : [ "[910313851]" ],
      "_links" : {
        "self" : {
          "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/f0712a43-1269-4cc4-8cd7-b59e23b24dd6"
        }
      }
    }, {
      "uuid" : "ce7cccfd-91b1-41a7-9b30-5fe4055765c9",
      "type" : "sletting",
      "registreringstidspunkt" : "2018-10-10T12:54:23.333Z",
      "kjennelsesdato" : "2018-10-10",
      "aapningsId" : "f0712a43-1269-4cc4-8cd7-b59e23b24dd6",
      "debitor" : "19020101140",
      "innehaverAv" : [ "[910313851]" ],
      "_links" : {
        "self" : {
          "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/ce7cccfd-91b1-41a7-9b30-5fe4055765c9"
        }
      }
    }, {
      "uuid" : "5044fa57-4703-4a06-990e-f7dcdf9705cb",
      "type" : "aapning",
      "registreringstidspunkt" : "2018-07-09T11:34:23.111Z",
      "kjennelsesdato" : "2018-07-09",
      "debitor" : "910425463",
      "_links" : {
        "self" : {
          "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/5044fa57-4703-4a06-990e-f7dcdf9705cb"
        }
      }
    }, {
      "uuid" : "0f564e43-3985-4787-956f-d3b43d01e05a",
      "type" : "avslutning",
      "avslutningskode" : "T",
      "registreringstidspunkt" : "2018-08-09T11:34:23.111Z",
      "kjennelsesdato" : "2018-08-09",
      "innstillingsdato" : "2018-09-09",
      "aapningsId" : "5044fa57-4703-4a06-990e-f7dcdf9705cb",
      "debitor" : "910425463",
      "_links" : {
        "self" : {
          "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/0f564e43-3985-4787-956f-d3b43d01e05a"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler?page=0&size=2&sort=registreringstidspunkt,asc"
    },
    "self" : {
      "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler?page=0&size=2&sort=registreringstidspunkt,asc"
    },
    "next" : {
      "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler?page=1&size=2&sort=registreringstidspunkt,asc"
    },
    "last" : {
      "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler?page=1&size=2&sort=registreringstidspunkt,asc"
    }
  },
  "page" : {
    "size" : 2,
    "totalElements" : 3,
    "totalPages" : 2,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.konkursvarsler.[].uuid

String

Unik id til konkursvarslet, kan brukes til å gjøre et oppslag på konkursvarslet

_embedded.konkursvarsler.[].type

String

Beskriver hvilken type konkursvarsel dette er : aapning, oppheving, sletting eller avslutning

_embedded.konkursvarsler.[].avslutningskode

String

Kode som angir avslutningsårsak

_embedded.konkursvarsler.[].registreringstidspunkt

String

Dato (ISO-8601): YYYY-MM-DDThh:mm:ss.sssZ. Tidspunkt for registrering i Konkursregisteret

_embedded.konkursvarsler.[].kjennelsesdato

String

Dato (ISO-8601): YYYY-MM-DD. Dato for kjennelse av åpningen

_embedded.konkursvarsler.[].innstillingsdato

String

Dato (ISO-8601): YYYY-MM-DD. Dato for avsluttet konkurs, tvangsavvikling eller tvangsoppløsning

_embedded.konkursvarsler.[].aapningsId

String

Hvis sletting, oppheving eller avslutning, uuid som referes til åpningen av konkursvarslet

_embedded.konkursvarsler.[].debitor

String

Organisasjonsnummeret/Fødselsnummeret/Dnr til debitor

_embedded.konkursvarsler.[].innehaverAv

Array

Hvis debitor er en person , en liste over enheter personen er innehaver av kan være enheter av typen ENK og TVAM

_embedded.konkursvarsler.[]._links.self.href

String

Lenke med utfyllende informasjon om åpningen

_links.first.href

String

Lenke som referer til første side

_links.self.href

String

Lenke som referer til denne siden

_links.next.href

String

Lenke som referer til neste side

_links.last.href

String

Lenke som referer til siste siden

page.size

Number

Antall varsler på denne siden

page.totalElements

Number

Totalt antall varsler

page.totalPages

Number

Antall sider

page.number

Number

Sidenummer på den siden man er på

Hent konkursvarslet til UUIDen til en person

Denne metoden returnerer konkursvarslet til UUIDen man ønsker oppslag på.

HTTP request

GET /konkursvarsler/19a58e23-bfc7-4efc-ac79-6db45fcd1f76 HTTP/1.1
Accept: application/json
Host: konkursvarsel.ppe-vcert.brreg.no

Path parameters

Table 1. /konkursvarsler/{uuid}
Parameter Description

uuid

uuid til konkursvarslet

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1534

{
  "uuid" : "19a58e23-bfc7-4efc-ac79-6db45fcd1f76",
  "type" : "aapning",
  "registreringstidspunkt" : "2018-10-10T11:54:23.333Z",
  "kjennelsesdato" : "2018-10-10",
  "konkursbonr" : "5467546",
  "konkursgrunnlag" : "T",
  "avviklingskode" : "TVRE",
  "fristdag" : "2017-03-04",
  "fordringsfrist" : "2017-03-04",
  "saksnr" : "654764374",
  "debitor" : {
    "navn" : "Cornelius Fosshaug",
    "adresse" : {
      "postnummer" : "7041",
      "poststed" : "Trondheim",
      "gateadresse" : "Julius veg 24",
      "kommune" : "Trondheim",
      "kommunenummer" : "5001",
      "land" : "Norge",
      "landkode" : "NO"
    },
    "fnr" : "19020101140",
    "innehaverAv" : [ "910313851" ]
  },
  "tingrett" : {
    "organisasjonsnr" : "974737418",
    "navn" : "Bergen tingrett"
  },
  "skiftesamling" : {
    "avholdes" : "2018-10-18T11:40:00Z",
    "sted" : "Oslo byfogdembete, rettssal 621, Oslo tinghus, C.J. Hambrosplass 4, 0031 Oslo"
  },
  "bostyrer" : {
    "tittel" : "ADV",
    "navn" : "Mads Næss",
    "telefon" : "33333333",
    "telefax" : "44444444",
    "epost" : "bbbb@brreg.no",
    "adresse" : {
      "postnummer" : "0032",
      "poststed" : "Oslo",
      "gateadresse" : "Osloveien 4",
      "kommune" : "Oslo",
      "kommunenummer" : "0301",
      "land" : "Norge",
      "landkode" : "NO"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/19a58e23-bfc7-4efc-ac79-6db45fcd1f76"
    }
  }
}

Response fields

Path Type Description

uuid

String

Unik id til konkursvarslet

type

String

Beskriver hvilken type konkursvarsel dette er : aapning, oppheving, sletting eller avslutning

registreringstidspunkt

String

Dato (ISO-8601): YYYY-MM-DDThh:mm:ss.sssZ. Tidspunkt for registrering i Konkursregisteret

kjennelsesdato

String

Dato (ISO-8601): YYYY-MM-DD. Dato for kjennelse av åpning

konkursbonr

String

Organisasjonsnummeret for konkursboet

konkursgrunnlag

String

Beskriver grunnlaget for åpningen

avviklingskode

String

Vises kun når konkursgrunnlaget er T

fristdag

String

Dato (ISO-8601): YYYY-MM-DD. Fristdag for åpning

fordringsfrist

String

Dato (ISO-8601): YYYY-MM-DD. Fordringsfrist for åpning

saksnr

String

Saksnr til tingretten

debitor.navn

String

Navnet på debitor som kan være et selskap eller en person

debitor.fnr

String

Fødselsnummer til debitor

debitor.innehaverAv

Array

Enheter som debitor er innehaver av

debitor.adresse.postnummer

String

Postnummeret til debitor

debitor.adresse.poststed

String

Poststed til debitor

debitor.adresse.gateadresse

String

Adressen til debitor

debitor.adresse.kommune

String

Kommune adressen er registrert i

debitor.adresse.kommunenummer

String

Kommunenummer til kommunen

debitor.adresse.land

String

Landet adressen ligger i

debitor.adresse.landkode

String

Landskode for landet

tingrett.organisasjonsnr

String

Organisasjonsnummer til tingretten

tingrett.navn

String

Navnet på tingretten

skiftesamling.avholdes

String

Dato (ISO-8601): YYYY-MM-DDThh:mm:ssZ. Tidspunktet for skiftesamlingen

skiftesamling.sted

String

Sted for skiftesamlingen

bostyrer.tittel

String

Bostyrer sin tittel

bostyrer.navn

String

Navnet på bostyrer

bostyrer.telefon

String

Telefonnummeret til bostyrer

bostyrer.telefax

String

Telefaxnummeret til bostyrer

bostyrer.epost

String

Epostadressen til bostyrer

bostyrer.adresse.postnummer

String

Postnummeret til bostyrer

bostyrer.adresse.poststed

String

Poststed til bostyrer

bostyrer.adresse.gateadresse

String

Adresse til bostyrer

bostyrer.adresse.kommune

String

Kommuneadresse til bostyrer

bostyrer.adresse.kommunenummer

String

Kommunenummeret til kommunen

bostyrer.adresse.land

String

Landet adressen befinner seg i

bostyrer.adresse.landkode

String

Landkode til landet

_links.self.href

String

Lenke til dette konkursvarslet

Hent konkursvarslet til UUIDen til en enhet

Denne metoden returnerer konkursvarslet til UUIDen man ønsker oppslag på.

HTTP request

GET /konkursvarsler/9b167131-0353-40fb-8819-94c175dfa22a HTTP/1.1
Accept: application/json
Host: konkursvarsel.ppe-vcert.brreg.no

Path parameters

Table 1. /konkursvarsler/{uuid}
Parameter Description

uuid

uuid til konkursvarslet

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1617

{
  "uuid" : "9b167131-0353-40fb-8819-94c175dfa22a",
  "type" : "avslutning",
  "avslutningskode" : "T",
  "registreringstidspunkt" : "2018-08-09T11:34:23.111Z",
  "kjennelsesdato" : "2018-08-09",
  "innstillingsdato" : "2018-09-09",
  "aapningsId" : "703e6fca-d2df-4dd3-8f49-9a4eb499c223",
  "konkursbonr" : "920955314",
  "konkursgrunnlag" : "T",
  "avviklingskode" : "TVRE",
  "fristdag" : "2018-07-10",
  "fordringsfrist" : "2018-07-10",
  "saksnr" : "654764374",
  "debitor" : {
    "navn" : "Din Frisør SA ",
    "adresse" : {
      "postnummer" : "7092",
      "poststed" : "Tiller",
      "gateadresse" : "Julianus 20",
      "kommune" : "Trondheim",
      "kommunenummer" : "5001",
      "land" : "Norge",
      "landkode" : "NO"
    },
    "orgnr" : "910425463"
  },
  "tingrett" : {
    "organisasjonsnr" : "974737418",
    "navn" : "Bergen tingrett"
  },
  "skiftesamling" : {
    "avholdes" : "2018-10-18T11:40:00Z",
    "sted" : "Oslo byfogdembete, rettssal 621, Oslo tinghus, C.J. Hambrosplass 4, 0031 Oslo"
  },
  "bostyrer" : {
    "tittel" : "ADV",
    "navn" : "Mads Næss",
    "telefon" : "33333333",
    "telefax" : "44444444",
    "epost" : "bbbb@brreg.no",
    "adresse" : {
      "postnummer" : "0032",
      "poststed" : "Oslo",
      "gateadresse" : "Osloveien 4",
      "kommune" : "Oslo",
      "kommunenummer" : "0301",
      "land" : "Norge",
      "landkode" : "NO"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/9b167131-0353-40fb-8819-94c175dfa22a"
    }
  }
}

Response fields

Path Type Description

uuid

String

Unik id til konkursvarslet

type

String

Beskriver hvilken type konkursvarsel dette er : aapning, oppheving, sletting eller avslutning

avslutningskode

String

Kode som angir avslutningsårsak

registreringstidspunkt

String

Dato (ISO-8601): YYYY-MM-DDThh:mm:ss.sssZ. Tidspunkt for registrering i Konkursregisteret

kjennelsesdato

String

Dato (ISO-8601): YYYY-MM-DD. Dato for kjennelse av åpning

innstillingsdato

String

Dato (ISO-8601): YYYY-MM-DD. Dato for avsluttet konkurs, tvangsavvikling eller tvangsoppløsning

aapningsId

String

Hvis sletting eller oppheving, uuid som referes til åpningen av konkursvarslet

konkursbonr

String

Organisasjonsnummeret for konkursboet

konkursgrunnlag

String

Beskriver grunnlaget for åpningen

avviklingskode

String

Vises kun når konkursgrunnlaget er T

fristdag

String

Dato (ISO-8601): YYYY-MM-DD. Fristdag for åpning

fordringsfrist

String

Dato (ISO-8601): YYYY-MM-DD. Fordringsfrist for åpning

saksnr

String

Saksnr til tingretten

debitor.navn

String

Navnet på debitor som kan være et selskap eller en person

debitor.adresse.postnummer

String

Postnummeret til debitor

debitor.adresse.poststed

String

Poststed til debitor

debitor.adresse.gateadresse

String

Adressen til debitor

debitor.adresse.kommune

String

Kommune adressen er registrert i

debitor.adresse.kommunenummer

String

Kommunenummer til kommunen

debitor.adresse.land

String

Landet adressen ligger i

debitor.adresse.landkode

String

Landskode for landet

debitor.orgnr

String

Organisasjonsnummer til debitor

tingrett.organisasjonsnr

String

Organisasjonsnummer til tingretten

tingrett.navn

String

Navnet på tingretten

skiftesamling.avholdes

String

Tidspunktet for skiftesamlingen

skiftesamling.sted

String

Sted for skiftesamlingen

bostyrer.tittel

String

Bostyrer sin tittel

bostyrer.navn

String

Navnet på bostyrer

bostyrer.telefon

String

Telefonnummeret til bostyrer

bostyrer.telefax

String

Telefaxnummeret til bostyrer

bostyrer.epost

String

Epostadressen til bostyrer

bostyrer.adresse.postnummer

String

Postnummeret til bostyrer

bostyrer.adresse.poststed

String

Poststed til bostyrer

bostyrer.adresse.gateadresse

String

Adresse til bostyrer

bostyrer.adresse.kommune

String

Kommuneadresse til bostyrer

bostyrer.adresse.kommunenummer

String

Kommunenummeret til kommunen

bostyrer.adresse.land

String

Landet adressen befinner seg i

bostyrer.adresse.landkode

String

Landkode til landet

_links.self.href

String

Lenke til dette konkursvarslet

Hent konkursvarsler etter et gitt registreringstidspunkt

Denne metoden henter alle konkursvarsler etter et gitt registreringstidspunkt. Metoden tar registreringstidspunkt som parameter, og henter konkursvarsler der registrering er utført etter oppgitt tidspunkt.

Note

Publisering av konkursvarsel vil skje etter registreringstidspunkt. For å garantere at man får med alle konkurvarsler, bør siste registreringstidspunkt benyttes i neste spørring.

HTTP request

GET /konkursvarsler/oppdatert/2018-07-08T11:54:23.222Z HTTP/1.1
Accept: application/json
Host: konkursvarsel.ppe-vcert.brreg.no

Path parameters

Table 1. /konkursvarsler/oppdatert/{registreringstidspunkt}
Parameter Description

registreringstidspunkt

Tidspunkt for registrering i Konkursregisteret

HTTP response

HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/json;charset=UTF-8
Content-Length: 2257

{
  "_embedded" : {
    "konkursvarsler" : [ {
      "uuid" : "63efb001-8ca0-4309-ab56-cece3562d187",
      "type" : "aapning",
      "registreringstidspunkt" : "2018-10-10T11:54:23.333Z",
      "kjennelsesdato" : "2018-10-10",
      "debitor" : "19020101140",
      "innehaverAv" : [ "[910313851]" ],
      "_links" : {
        "self" : {
          "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/63efb001-8ca0-4309-ab56-cece3562d187"
        }
      }
    }, {
      "uuid" : "de7d6c1d-fa6d-43bd-8ba9-8b34add41086",
      "type" : "sletting",
      "registreringstidspunkt" : "2018-10-10T12:54:23.333Z",
      "kjennelsesdato" : "2018-10-10",
      "aapningsId" : "63efb001-8ca0-4309-ab56-cece3562d187",
      "debitor" : "19020101140",
      "innehaverAv" : [ "[910313851]" ],
      "_links" : {
        "self" : {
          "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/de7d6c1d-fa6d-43bd-8ba9-8b34add41086"
        }
      }
    }, {
      "uuid" : "83f3b014-cf3c-4f10-853f-a7e5da21ba37",
      "type" : "aapning",
      "registreringstidspunkt" : "2018-07-09T11:34:23.111Z",
      "kjennelsesdato" : "2018-07-09",
      "debitor" : "910425463",
      "_links" : {
        "self" : {
          "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/83f3b014-cf3c-4f10-853f-a7e5da21ba37"
        }
      }
    }, {
      "uuid" : "71fef28d-2088-4291-a18a-6d48d9c3508d",
      "type" : "avslutning",
      "avslutningskode" : "T",
      "registreringstidspunkt" : "2018-08-09T11:34:23.111Z",
      "kjennelsesdato" : "2018-08-09",
      "innstillingsdato" : "2018-09-09",
      "aapningsId" : "83f3b014-cf3c-4f10-853f-a7e5da21ba37",
      "debitor" : "910425463",
      "_links" : {
        "self" : {
          "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/71fef28d-2088-4291-a18a-6d48d9c3508d"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler/oppdatert/2018-07-08T11:54:23.222Z?page=0&size=1&sort=registreringstidspunkt,asc"
    }
  },
  "page" : {
    "size" : 1,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.konkursvarsler.[].uuid

String

Unik id til konkursvarslet, kan brukes til å gjøre et oppslag på konkursvarslet

_embedded.konkursvarsler.[].type

String

Beskriver hvilken type konkursvarsel dette er : aapning, oppheving, sletting eller avslutning

_embedded.konkursvarsler.[].avslutningskode

String

Kode som angir avslutningsårsak

_embedded.konkursvarsler.[].registreringstidspunkt

String

Dato (ISO-8601): YYYY-MM-DDThh:mm:ss.sssZ. Tidspunkt for registrering i Konkursregisteret

_embedded.konkursvarsler.[].kjennelsesdato

String

Dato (ISO-8601): YYYY-MM-DD. Dato for kjennelse av åpningen

_embedded.konkursvarsler.[].innstillingsdato

String

Dato (ISO-8601): YYYY-MM-DD. Dato for avsluttet konkurs, tvangsavvikling eller tvangsoppløsning

_embedded.konkursvarsler.[].aapningsId

String

Hvis sletting, oppheving eller avslutning, uuid som referes til åpningen av konkursvarslet

_embedded.konkursvarsler.[].debitor

String

Organisasjonsnummeret/Fødselsnummeret/Dnr til debitor

_embedded.konkursvarsler.[].innehaverAv

Array

Hvis debitor er en person , en liste over enheter personen er innehaver av kan være enheter av typen ENK og TVAM

_embedded.konkursvarsler.[]._links.self.href

String

Lenke med utfyllende informasjon om åpningen

_links.self.href

String

Lenke som referer til denne siden

page.size

Number

Antall varsler på denne siden

page.totalElements

Number

Totalt antall varsler

page.totalPages

Number

Antall sider på denne lenken

page.number

Number

Sidenummer på den siden man er på

Feilbehandling av registreringstidspunkt

Ved feil format på registreringstidspunkt ved filtrering, vil man få denne responsen.

HTTP request

GET /konkursvarsler/oppdatert/2018-11-06T09:15:50.840 HTTP/1.1
Accept: application/json
Host: konkursvarsel.ppe-vcert.brreg.no

HTTP response

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
Content-Length: 146

{
  "status" : 400,
  "error" : "Bad Request",
  "message" : "Registreringstidspunkt må være på dette formatet: yyyy-MM-ddTHH:mm:SS.sssZ"
}

Response fields

Path Type Description

status

Number

HTTP-feilkodestatus

error

String

HTTP-feilkodebeskrivelse

message

String

Utfyllende beskrivelse av feilresponsen

Feilbehandling av UUID

Ved å søke på en UUID som ikke eksisterer, vil man få denne responsen.

HTTP request

GET /konkursvarsler/hghxfcth HTTP/1.1
Accept: application/json
Host: konkursvarsel.ppe-vcert.brreg.no

HTTP response

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
Content-Length: 85

{
  "status" : 404,
  "error" : "Not Found",
  "message" : "UUIDen finnes ikke"
}

Response fields

Path Type Description

status

Number

HTTP-feilkodestatus

error

String

HTTP-feilkodebeskrivelse

message

String

Utfyllende beskrivelse av feilresponsen

Paginering

Det er mulig å filtrere og bla gjennom resultatsettet via page+size og registreringstidspunkt som parametre. Page+size kan ha noe begrensninger for filtrering hvis man kommer opp i veldig mange konkursvarsler.

F.eks så kan man sette size til 10 hvis man ønsker denne sidestørrelse. Dette gjøres ved en forespørsel på konkursvarlser?page=0&size=10. Da er 10 størrelsen på hver side, og man kan bla gjennom eller filtrere sidene ved å sette page til det sidetallet man ønsker. Maks sidestørrelse er på 2000, altså size=2000.

Vi anbefaler å bruke page+size til å navigere, mens tidspunkt brukes til å filtrere ønsket visning av konkursvarsler.

Sikkerhetsmekanismer

Informasjon om nødvendige sikkerhetsmekanismer: autentisering og autorisasjon.

Autentisering

For å benytte tjenesten trengs et X.509 virksomhetssertifikat fra en registrert tilbyder. Nasjonal kommunikasjonsmyndighet har en oversikt over tilbyderne.

  • En må benytte testvirksomhetssertifikat i test og prodvirksomhetssertifikat i prod

  • En må ha den private nøkkelen som hører til sertifikatet. Den private nøkkelen skal aldri deles med noen

Note
 Det er bare hovedenheter som kan få utstedt virksomhetssertifikat. Det betyr at en underenhet som skal gjøre oppslag på konkursvarsler er nødt å bruke virksomhetssertifikatet til hovedenheten.

Autorisering

Tjenesten autoriserer tilgang til konkursvarsler ut fra organisasjonsnummeret i virksomhetssertifikatet.

Autorisering med organisasjonsnummer

Tilgang til konkursvarsler administreres av Konkursregistreret

REST klientsertifikat-autentisering

Det kreves at en utfører standard klientsertifikat-autentisering. De fleste vanlige HTTP-verktøy har støtte for dette. Eksempel med curl:

$ curl -k -v --cert virksomhet.cer --key virksomhet.key "https://konkursvarsel.ppe-vcert.brreg.no/konkursvarsler" > resultat.json