Virksomhedsindsats.VirksomhedService (Version 2 [UDV UX], 2024-1)

STAR

Virksomhed

cvrNummer [Path]

string

Pattern: [0-9]{8}

1

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

email

0 - 1

-    requestOrganisationStructure

RequestOrganisationStructureDto

1

-    -    organisationType

OrganisationTypeCodeList

1

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

-    registrationDateTime

date-time

1

response

GetVirksomhedResponseDto

1

-    virksomhed

VirksomhedDto

1

Virksomhed.

-    -    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

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).

120501

Virksomheden blev ikke fundet.

Virksomheden blev ikke fundet.

STAR

Virksomhed

cvrNummer [Path]

string

Pattern: [0-9]{8}

1

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

email

0 - 1

-    requestOrganisationStructure

RequestOrganisationStructureDto

1

-    -    organisationType

OrganisationTypeCodeList

1

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

-    registrationDateTime

date-time

1

response

GetLogoResponseDto

1

-    logo

base64Binary

MinLength: 1

1

Logo i et formaterne: PNG, JPEG (base64).

120501

Virksomheden blev ikke fundet.

Virksomheden blev ikke fundet.

120505

Logoet blev ikke fundet.

Logoet blev ikke fundet.

STAR

Virksomhed

cvrNummer [Path]

string

Pattern: [0-9]{8}

1

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

email

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

SetLogoRequestDto

1

-    logo

base64Binary

MinLength: 1

1

Logo i et formaterne: PNG, JPEG (base64).

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.

STAR

Virksomhed

cvrNummer [Path]

string

Pattern: [0-9]{8}

1

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

email

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

120501

Virksomheden blev ikke fundet.

Virksomheden blev ikke fundet.

120505

Logoet blev ikke fundet.

Logoet blev ikke fundet.

STAR

cvrNummer [Path]

string

Pattern: [0-9]{8}

1

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

email

0 - 1

-    requestOrganisationStructure

RequestOrganisationStructureDto

1

-    -    organisationType

OrganisationTypeCodeList

1

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

-    registrationDateTime

date-time

1

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.

-    -    -    oprettetTidspunkt

date-time

1

Tidspunkt for ændringen.

120501

Virksomheden blev ikke fundet.

Virksomheden blev ikke fundet.

STAR

cvrNummer [Path]

string

Pattern: [0-9]{8}

1

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

email

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

-    aarsag

string

Length: 1-500

1

Årsag til at ændringen er lavet.

120501

Virksomheden blev ikke fundet.

Virksomheden blev ikke fundet.

2002

Invalid CodeList value

Invalid CodeList value

STAR

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

string

Length: 1-140

1

-    -    requestUserType

RequestUserTypeCodeList

1

-    -    userIdentifier

string

Length: 1-255

1

-    -    userEmail

email

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

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.

STAR

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.

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

email

0 - 1

-    requestOrganisationStructure

RequestOrganisationStructureDto

1

-    -    organisationType

OrganisationTypeCodeList

1

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

-    registrationDateTime

date-time

1

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

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).