...
Element | Type | Detaljer | Forekomst | Beskrivelse | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 | X-ActiveOrganisation [Header] | ActiveOrganisationDto | 1 | Impersoneret myndighed | - organisationType | OrganisationTypeCodeList | 1 | - organisationCode
Output
Element | Type | Detaljer | Forekomst | Beskrivelse | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
response | GetVirksomhedResponseDto | 1 | |||||||||||||||||||||
- virksomhed | VirksomhedDto | 1 | Virksomhed. | ||||||||||||||||||||
- - cvrNummer | string | Pattern: \d{1, [0-9]{8} MinLength: 1 | 1 | X-RequestUserMetadata [Header] | RequestUserMetadataDto | 1 | Kaldende myndighed | - requestUserStructure | RequestUserStructureDto | 1 | - - userFullName | string | Length: 1-140 | 1 | - - requestUserType | RequestUserTypeCodeList | 1 | - - userIdentifier | string | Length: 1-255 | 1 | - - userEmail | emailCVR-nummer. |
- - navn | string | 0 - 1 | Navn på virksomheden (fra CVR). | ||||||||||||||||||||
- - url | string | 0 - 1 | URL (fra CVR). | ||||||||||||||||||||
- - emailadresse | string | 0 - 1 | E-mailadresse (fra CVR). | ||||||||||||||||||||
- - telefonnummer | string | 0 - 1 | Telefonnummer (fra CVR). | ||||||||||||||||||||
- - laas | VirksomhedslaasTypeCodeList | 0 - 1 | |||||||||||||||||||||
- - requestOrganisationStructure logo | RequestOrganisationStructureDtobase64Binary | 0 - 1 | Logo i et formaterne: PNG, JPEG (base64). | ||||||||||||||||||||
- - organisationType adresse | OrganisationTypeCodeListAdresseDto | 0 - 1 | Adresse for virksomhed. | ||||||||||||||||||||
- - organisationCode - vejnavn | string | Pattern: \d{1,8} MinLength: 1 | 1 | - registrationDateTime | date-time | 1 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
response | GetVirksomhedResponseDto | 1 | - virksomhed | VirksomhedDto | 1 | Virksomhed0 - 1 | Vejnavn (fra CVR). | ||||||||||
- - - husnummer | string | 0 - 1 | Husnummer (fra CVR). | ||||||||||||||
- - cvrNummer - etage | string | Pattern: [0 - 9]{8} MinLength: 1 | 1 | CVR-nummerEtagebetegnelse (fra CVR). | |||||||||||||
- - - navn sidedoer | string | 0 - 1 | Navn på virksomheden Side-/dørbetegnelse (fra CVR). | ||||||||||||||
- - url - bynavn | string | 0 - 1 | URL Bynavn (fra CVR). | ||||||||||||||
- - - emailadresse postnummer | string | Pattern: [0-9]{4} | 0 - 1 | E-mailadresse Postnummer (fra CVR). | |||||||||||||
- - telefonnummerstring - kommunenummer | int32 | Pattern: [0-9]{3} | 0 - 1 | Telefonnummer Kommunenummer (fra CVR). | |||||||||||||
- - laas | VirksomhedslaasTypeCodeList | 0 - 1 | - - logo landekode | base64Binary | 0 - 1 | Logo i et formaterne: PNG, JPEG (base64). | - - adresse | AdresseDto | 0 - 1 | Adresse for virksomhed. | - - - vejnavn | string | 0 - 1 | Vejnavn string | Pattern: [a-z,A-Z]{2}|[a-z,A-Z]{3}|[0-9]{3}|[0-9]{4} | 0 - 1 | Landekode (fra CVR). |
- - - husnummer lukket | stringboolean | 0 - 1 | Husnummer Om virksomheden er lukket (fra CVR). | - - - etage | string | 0 - 1 | Etagebetegnelse (fra CVR). | - - - sidedoer | string | 0 - 1 | Side-/dørbetegnelse (fra CVR). | - - - bynavn | string | 0 - 1 | Bynavn (fra CVR). | - - - postnummer |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
GetLogo (GET /v2/Virksomhed/{cvrNummer}/logo)
Finder en virksomheds logo.
Tilladte organisationer
Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
virksomhedsindsats.virksomhed.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{48} | 0 - 1 | Postnummer (fra CVR). |
- - - kommunenummer | int32 | Pattern: [0-9]{3} | 0 - 1 | Kommunenummer (fra CVR). |
- - - landekode | string | Pattern: [a-z,A-Z]{2}|[a-z,A-Z]{3}|[0-9]{3}|[0-9]{4} | 0 - 1 | Landekode (fra CVR). | - - lukket | boolean | 1 | Om virksomheden er lukket (fra CVR). |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
GetLogo (GET /v2/Virksomhed/{cvrNummer}/logo)
Finder en virksomheds logo.
Tilladte organisationer
...
Scope
virksomhedsindsats.virksomhed.read
Input
...
Output
...
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
120505 | Logoet blev ikke fundet. | Logoet blev ikke fundet. |
SetLogo (PUT /v2/Virksomhed/{cvrNummer}/logo)
Sætter en virksomheds logo.
Tilladte organisationer
...
Scope
virksomhedsindsats.virksomhed.write
Input
...
...
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
120509 | Ugyldig billedtype. Skal være PNG eller JPEG. | Ugyldig billedtype. Skal være PNG eller JPEG. |
120517 | Størrelsen på billedet skal være mindre end 200x200px. | Størrelsen på billedet skal være mindre end 200x200px. |
120510 | Filstørrelsen på billedet skal være mindre end 100kB. | Filstørrelsen på billedet skal være mindre end 100kB. |
DeleteLogo (DELETE /v2/Virksomhed/{cvrNummer}/logo)
Sletter en virksomheds logo.
Tilladte organisationer
...
Scope
virksomhedsindsats.virksomhed.write
Input
...
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
120505 | Logoet blev ikke fundet. | Logoet blev ikke fundet. |
GetLaasehistorik (GET /v2/Virksomhed/{cvrNummer}/laasehistorik)
Henter låsehistorik for en virksomhed.
Tilladte organisationer
...
Scope
virksomhedsindsats.virksomhed.laas.read
Input
...
Output
...
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
...
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetLogoResponseDto | 1 | ||
- logo | base64Binary | MinLength: 1 | 1 | Logo i et formaterne: PNG, JPEG (base64). |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
120505 | Logoet blev ikke fundet. | Logoet blev ikke fundet. |
SetLogo (PUT /v2/Virksomhed/{cvrNummer}/logo)
Sætter en virksomheds logo.
Tilladte organisationer
Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
virksomhedsindsats.virksomhed.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 | |
x-requestId [Header] | string | 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars | |
requestBody | SetLogoRequestDto | 1 | ||
- logo | base64Binary | MinLength: 1 | 1 | Logo i et formaterne: PNG, JPEG (base64). |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
120509 | Ugyldig billedtype. Skal være PNG eller JPEG. | Ugyldig billedtype. Skal være PNG eller JPEG. |
120517 | Størrelsen på billedet skal være mindre end 200x200px. | Størrelsen på billedet skal være mindre end 200x200px. |
120510 | Filstørrelsen på billedet skal være mindre end 100kB. | Filstørrelsen på billedet skal være mindre end 100kB. |
DeleteLogo (DELETE /v2/Virksomhed/{cvrNummer}/
...
logo)
Sætter lås på en virksomhedSletter en virksomheds logo.
Tilladte organisationer
Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
virksomhedsindsats.virksomhed.laas.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Xx-ActiveOrganisation requestId [Header] | ActiveOrganisationDto | 1 | Impersoneret myndighed | - organisationType | OrganisationTypeCodeList | 1 | - organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | X-RequestUserMetadata [Header] | RequestUserMetadataDto | 1 | Kaldende myndighed | - requestUserStructure | RequestUserStructureDto | 1 | - - userFullName | string | Length: 1-140 | 1 | - - requestUserType | RequestUserTypeCodeList | 1 | - - userIdentifier | string | Length: 1-255 | 1 | - - userEmail | 0 - 1 | - requestOrganisationStructure | RequestOrganisationStructureDto | 1 | - - organisationType | OrganisationTypeCodeList | 1 | - - organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | - registrationDateTime | date-time | 1 | x-requestId [Header] | string | 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars | requestBody | SetLaasRequestDto | 1 | - laas | VirksomhedslaasTypeCodeList | 1 | string | 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
120505 | Logoet blev ikke fundet. | Logoet blev ikke fundet. |
GetLaasehistorik (GET /v2/Virksomhed/{cvrNummer}/laasehistorik)
Henter låsehistorik for en virksomhed.
Tilladte organisationer
Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
virksomhedsindsats.virksomhed.laas.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetLaasehistorikResponseDto | 1 | ||
- historikresultater | LaasehistorikDtoCollection | 1 | Låsehistorik for virksomhed. | |
- - LaasehistorikDto | LaasehistorikDto | 0 - * | ||
- - - laas | VirksomhedslaasTypeCodeList | 0 - 1 | ||
- - - aarsag | string | Length: 1-500 | 1 | Årsag til at ændringen er lavet. |
- - - bruger | string | MinLength: 1 | 1 | Bruger som lavede ændringen. |
Output
...
- - - oprettetTidspunkt | date-time | 1 | Tidspunkt for ændringen. |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
2002 | Invalid CodeList value | Invalid CodeList value |
...
ikke fundet. |
SetLaas (PUT /v2/Virksomhed/{cvrNummer}/laas)
Sletter Sætter lås på en virksomhed.
Tilladte organisationer
Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
virksomhedsindsats.virksomhed.laas.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 | |||||||||||||||||||||||||||
aarsag [Query] | string | MaxLength: 500 | 1 | Årsag til at ændringen er lavet. | ||||||||||||||||||||||||||
X-ActiveOrganisation [Header] | ActiveOrganisationDto | 1 | Impersoneret myndighed | - organisationType | OrganisationTypeCodeList | 1 | - organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | X-RequestUserMetadata [Header] | RequestUserMetadataDto | 1 | Kaldende myndighed | - requestUserStructure | RequestUserStructureDto | 1 | - - userFullName[Path] | string | Pattern: [0-9]{8} | 1 | |||||||||
x-requestId [Header] | string | 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars | |||||||||||||||||||||||||||
requestBody | SetLaasRequestDto | 1 | ||||||||||||||||||||||||||||
- laas | VirksomhedslaasTypeCodeList | 1 | ||||||||||||||||||||||||||||
- aarsag | string | Length: 1-140500 | 1 | - - requestUserType | RequestUserTypeCodeList | 1 | - - userIdentifier | string | Length: 1-255 | 1 | - - userEmail | 0 - 1 | - requestOrganisationStructure | RequestOrganisationStructureDto | 1 | - - organisationType | OrganisationTypeCodeList | 1 | - - organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | - registrationDateTime | date-time | 1 | x-requestId [Header] | string | 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
120502 | Der er ikke en lås på virksomheden. | Der er ikke en lås på virksomheden. |
SoegVirksomheder (GET /v2/Virksomhed/soeg)
Fremsøger virksomheder ud fra parametre. Returnerer maks 100 søgeresultater.
Tilladte organisationer
...
Scope
virksomhedsindsats.virksomhed.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
navn [Query] | string | MinLength: 3 | 0 - 1 | Del af virksomhedens navn. | |||||||||||||||||||||||||||||||||||||||||||||||||
inkluderLaase [Query] | VirksomhedslaasTypeCodeListCollection | 0 - 1 | Inkluder virksomheder med angivne låsetyper.- VirksomhedslaasTypeCodeList | VirksomhedslaasTypeCodeList | 0 - * | inkluderLukkede [Query] | boolean | 0 - 1 | Inkluder lukkede virksomheder i søgeresultatet.X-ActiveOrganisation [Header] | ActiveOrganisationDto | 1 | Impersoneret myndighed | - organisationType | OrganisationTypeCodeList | 1 | - organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | X-RequestUserMetadata [Header] | RequestUserMetadataDto | 1 | Kaldende myndighed | - requestUserStructure | RequestUserStructureDto | 1 | - - userFullName | string | Length: 1-140 | 1 | - - requestUserType | RequestUserTypeCodeList | 1 | - - userIdentifier | string | Length: 1-255 | 1 | - - userEmail | 0 - 1 | - requestOrganisationStructure | RequestOrganisationStructureDto | 1 | - - organisationType | OrganisationTypeCodeList | 1 | - - organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | - registrationDateTime | date-time | 1Årsag til at ændringen er lavet. |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
2002 | Invalid CodeList value | Invalid CodeList value |
DeleteLaas (DELETE /v2/Virksomhed/{cvrNummer}/laas)
Sletter lås på en virksomhed.
Tilladte organisationer
Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
virksomhedsindsats.virksomhed.laas.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 | |
aarsag [Query] | string | MaxLength: 500 | 1 | Årsag til at ændringen er lavet. |
x-requestId [Header] | string | 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
120502 | Der er ikke en lås på virksomheden. | Der er ikke en lås på virksomheden. |
SoegVirksomheder (GET /v2/Virksomhed/soeg)
Fremsøger virksomheder ud fra parametre. Returnerer maks 100 søgeresultater.
Tilladte organisationer
Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere | |
---|---|---|---|---|---|---|---|---|
STAR | X |
Scope
virksomhedsindsats.virksomhed.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
navn [Query] | string | MinLength: 3 | 0 - 1 | Del af virksomhedens navn. |
inkluderLaase [Query] | VirksomhedslaasTypeCodeListCollection | 0 - 1 | Inkluder virksomheder med angivne låsetyper. Som standard inkluderes låste virksomheder ikke. | |
- VirksomhedslaasTypeCodeList | VirksomhedslaasTypeCodeList | 0 - * | ||
inkluderLukkede [Query] | boolean | 0 - 1 | Inkluder lukkede virksomheder i søgeresultatet. Som standard inkluderes lukkede virksomheder ikke. | |
sidestoerrelse [Query] | int32 | MinInclusive: 1 MaxInclusive: 1000 | 0 - 1 | Det maksimale antal returnerede søgeresultater. Angives denne ikke sættes sidestørrelsen til 100. |
sidenummer [Query] | int32 | MinInclusive: 0 MaxInclusive: 2147483647 | 0 - 1 | Sidenummer definerer hvilken side i resultatsættet, der returneres. Angives denne ikke, returneres første side. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | SoegVirksomhederResponseDto | 1 | ||
- soegeresultater | VirksomhedDtoCollection | 1 | Søgeresultater. | |
- - VirksomhedDto | VirksomhedDto | 0 - * | ||
- - - cvrNummer | string | Pattern: [0-9]{8} MinLength: 1 | 1 | CVR-nummer. |
- - - navn | string | 0 - 1 | Navn på virksomheden (fra CVR). | |
- - - url | string | 0 - 1 | URL (fra CVR). | |
- - - emailadresse | string | 0 - 1 | E-mailadresse (fra CVR). | |
- - - telefonnummer | string | 0 - 1 | Telefonnummer (fra CVR). | |
- - - laas | VirksomhedslaasTypeCodeList | 0 - 1 | ||
- - - logo | base64Binary | 0 - 1 | Logo i et formaterne: PNG, JPEG (base64). | |
- - - adresse | AdresseDto | 0 - 1 | Adresse for virksomhed. | |
- - - - vejnavn | string | 0 - 1 | Vejnavn (fra CVR). | |
- - - - husnummer | string | 0 - 1 | Husnummer (fra CVR). | |
- - - - etage | string | 0 - 1 | Etagebetegnelse (fra CVR). | |
- - - - sidedoer | string | 0 - 1 | Side-/dørbetegnelse (fra CVR). | |
- - - - bynavn | string | 0 - 1 | Bynavn (fra CVR). | |
- - - - postnummer | string | Pattern: [0-9]{4} | 0 - 1 | Postnummer (fra CVR). |
- - - - kommunenummer | int32 | Pattern: [0-9]{3} | 0 - 1 | Kommunenummer (fra CVR). |
- - - - landekode | string | Pattern: [a-z,A-Z]{2}|[a-z,A-Z]{3}|[0-9]{3}|[0-9]{4} | 0 - 1 | Landekode (fra CVR). |
- - - lukket | boolean | 1 | Om virksomheden er lukket (fra CVR). |
...