Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Siden opdateres automatisk til at afspejle koden.

Metoder

GetVirksomhed (GET /v2/Virksomhed/{cvrNummer})

Finder en virksomhed.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX
VirksomhedX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
cvrNummer [Path]stringPattern: [0-9]{8}1
X-ActiveOrganisation [Header]ActiveOrganisationDto1Impersoneret myndighed
-    organisationTypeOrganisationTypeCodeList1
-    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
X-RequestUserMetadata [Header]RequestUserMetadataDto1Kaldende myndighed
-    requestUserStructureRequestUserStructureDto1
-    -    userFullNamestringLength: 1-1401
-    -    requestUserTypeRequestUserTypeCodeList1
-    -    userIdentifierstringLength: 1-2551
-    -    userEmailemail0 - 1
-    requestOrganisationStructureRequestOrganisationStructureDto1
-    -    organisationTypeOrganisationTypeCodeList1
-    -    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
-    registrationDateTimedate-time1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetVirksomhedResponseDto1
-    virksomhedVirksomhedDto1Virksomhed.
-    -    cvrNummerstringPattern: [0-9]{8}
MinLength: 1
1CVR-nummer.
-    -    navnstring0 - 1Navn på virksomheden (fra CVR).
-    -    urlstring0 - 1URL (fra CVR).
-    -    emailadressestring0 - 1E-mailadresse (fra CVR).
-    -    telefonnummerstring0 - 1Telefonnummer (fra CVR).
-    -    laasVirksomhedslaasTypeCodeList0 - 1
-    -    logobase64Binary0 - 1Logo i et formaterne: PNG, JPEG (base64).
-    -    adresseAdresseDto1Adresse for virksomhed.
-    -    -    vejnavnstring0 - 1Vejnavn (fra CVR).
-    -    -    husnummerstring0 - 1Husnummer (fra CVR).
-    -    -    etagestring0 - 1Etagebetegnelse (fra CVR).
-    -    -    sidedoerstring0 - 1Side-/dørbetegnelse (fra CVR).
-    -    -    bynavnstring0 - 1Bynavn (fra CVR).
-    -    -    postnummerstringPattern: [0-9]{4}0 - 1Postnummer (fra CVR).
-    -    -    kommunenummerint32Pattern: [0-9]{3}0 - 1Kommunenummer (fra CVR).
-    -    -    landekodestringPattern: [a-z,A-Z]{2}|[a-z,A-Z]{3}|[0-9]{3}|[0-9]{4}0 - 1Landekode (fra CVR).
-    -    lukketboolean1Om virksomheden er lukket (fra CVR).

Fejlkoder

FejlkodeFejltekstBeskrivelse
120501Virksomheden blev ikke fundet.Virksomheden blev ikke fundet.

GetLogo (GET /v2/Virksomhed/{cvrNummer}/logo)

Finder en virksomheds logo.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX
VirksomhedX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
cvrNummer [Path]stringPattern: [0-9]{8}1
X-ActiveOrganisation [Header]ActiveOrganisationDto1Impersoneret myndighed
-    organisationTypeOrganisationTypeCodeList1
-    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
X-RequestUserMetadata [Header]RequestUserMetadataDto1Kaldende myndighed
-    requestUserStructureRequestUserStructureDto1
-    -    userFullNamestringLength: 1-1401
-    -    requestUserTypeRequestUserTypeCodeList1
-    -    userIdentifierstringLength: 1-2551
-    -    userEmailemail0 - 1
-    requestOrganisationStructureRequestOrganisationStructureDto1
-    -    organisationTypeOrganisationTypeCodeList1
-    -    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
-    registrationDateTimedate-time1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetLogoResponseDto1
-    logobase64BinaryMinLength: 11Logo i et formaterne: PNG, JPEG (base64).

Fejlkoder

FejlkodeFejltekstBeskrivelse
120501Virksomheden blev ikke fundet.Virksomheden blev ikke fundet.
120505Logoet blev ikke fundet.Logoet blev ikke fundet.

SetLogo (PUT /v2/Virksomhed/{cvrNummer}/logo)

Sætter en virksomheds logo.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX
VirksomhedX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
cvrNummer [Path]stringPattern: [0-9]{8}1
X-ActiveOrganisation [Header]ActiveOrganisationDto1Impersoneret myndighed
-    organisationTypeOrganisationTypeCodeList1
-    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
X-RequestUserMetadata [Header]RequestUserMetadataDto1Kaldende myndighed
-    requestUserStructureRequestUserStructureDto1
-    -    userFullNamestringLength: 1-1401
-    -    requestUserTypeRequestUserTypeCodeList1
-    -    userIdentifierstringLength: 1-2551
-    -    userEmailemail0 - 1
-    requestOrganisationStructureRequestOrganisationStructureDto1
-    -    organisationTypeOrganisationTypeCodeList1
-    -    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
-    registrationDateTimedate-time1
x-requestId [Header]string1Unikt 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
requestBodySetLogoRequestDto1
-    logobase64BinaryMinLength: 11Logo i et formaterne: PNG, JPEG (base64).

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120501Virksomheden blev ikke fundet.Virksomheden blev ikke fundet.
120509Ugyldig billedtype. Skal være PNG eller JPEG.Ugyldig billedtype. Skal være PNG eller JPEG.
120517Størrelsen på billedet skal være mindre end 200x200px.Størrelsen på billedet skal være mindre end 200x200px.
120510Filstø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

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX
VirksomhedX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
cvrNummer [Path]stringPattern: [0-9]{8}1
X-ActiveOrganisation [Header]ActiveOrganisationDto1Impersoneret myndighed
-    organisationTypeOrganisationTypeCodeList1
-    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
X-RequestUserMetadata [Header]RequestUserMetadataDto1Kaldende myndighed
-    requestUserStructureRequestUserStructureDto1
-    -    userFullNamestringLength: 1-1401
-    -    requestUserTypeRequestUserTypeCodeList1
-    -    userIdentifierstringLength: 1-2551
-    -    userEmailemail0 - 1
-    requestOrganisationStructureRequestOrganisationStructureDto1
-    -    organisationTypeOrganisationTypeCodeList1
-    -    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
-    registrationDateTimedate-time1
x-requestId [Header]string1Unikt 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

FejlkodeFejltekstBeskrivelse
120501Virksomheden blev ikke fundet.Virksomheden blev ikke fundet.
120505Logoet blev ikke fundet.Logoet blev ikke fundet.

GetLaasehistorik (GET /v2/Virksomhed/{cvrNummer}/laasehistorik)

Henter låsehistorik for en virksomhed.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
cvrNummer [Path]stringPattern: [0-9]{8}1
X-ActiveOrganisation [Header]ActiveOrganisationDto1Impersoneret myndighed
-    organisationTypeOrganisationTypeCodeList1
-    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
X-RequestUserMetadata [Header]RequestUserMetadataDto1Kaldende myndighed
-    requestUserStructureRequestUserStructureDto1
-    -    userFullNamestringLength: 1-1401
-    -    requestUserTypeRequestUserTypeCodeList1
-    -    userIdentifierstringLength: 1-2551
-    -    userEmailemail0 - 1
-    requestOrganisationStructureRequestOrganisationStructureDto1
-    -    organisationTypeOrganisationTypeCodeList1
-    -    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
-    registrationDateTimedate-time1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetLaasehistorikResponseDto1
-    historikresultaterLaasehistorikDtoCollection1Låsehistorik for virksomhed.
-    -    LaasehistorikDtoLaasehistorikDto0 - *
-    -    -    laasVirksomhedslaasTypeCodeList0 - 1
-    -    -    aarsagstringLength: 1-5001Årsag til at ændringen er lavet.
-    -    -    brugerstringMinLength: 11Bruger som lavede ændringen.
-    -    -    oprettetTidspunktdate-time1Tidspunkt for ændringen.

Fejlkoder

FejlkodeFejltekstBeskrivelse
120501Virksomheden blev ikke fundet.Virksomheden blev ikke fundet.

SetLaas (PUT /v2/Virksomhed/{cvrNummer}/laas)

Sætter lås på en virksomhed.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
cvrNummer [Path]stringPattern: [0-9]{8}1
X-ActiveOrganisation [Header]ActiveOrganisationDto1Impersoneret myndighed
-    organisationTypeOrganisationTypeCodeList1
-    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
X-RequestUserMetadata [Header]RequestUserMetadataDto1Kaldende myndighed
-    requestUserStructureRequestUserStructureDto1
-    -    userFullNamestringLength: 1-1401
-    -    requestUserTypeRequestUserTypeCodeList1
-    -    userIdentifierstringLength: 1-2551
-    -    userEmailemail0 - 1
-    requestOrganisationStructureRequestOrganisationStructureDto1
-    -    organisationTypeOrganisationTypeCodeList1
-    -    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
-    registrationDateTimedate-time1
x-requestId [Header]string1Unikt 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
requestBodySetLaasRequestDto1
-    laasVirksomhedslaasTypeCodeList1
-    aarsagstringLength: 1-5001Årsag til at ændringen er lavet.

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
120501Virksomheden blev ikke fundet.Virksomheden blev ikke fundet.
2002Invalid CodeList valueInvalid CodeList value

DeleteLaas (DELETE /v2/Virksomhed/{cvrNummer}/laas)

Sletter lås på en virksomhed.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
cvrNummer [Path]stringPattern: [0-9]{8}1
aarsag [Query]stringMaxLength: 5001Årsag til at ændringen er lavet.
X-ActiveOrganisation [Header]ActiveOrganisationDto1Impersoneret myndighed
-    organisationTypeOrganisationTypeCodeList1
-    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
X-RequestUserMetadata [Header]RequestUserMetadataDto1Kaldende myndighed
-    requestUserStructureRequestUserStructureDto1
-    -    userFullNamestringLength: 1-1401
-    -    requestUserTypeRequestUserTypeCodeList1
-    -    userIdentifierstringLength: 1-2551
-    -    userEmailemail0 - 1
-    requestOrganisationStructureRequestOrganisationStructureDto1
-    -    organisationTypeOrganisationTypeCodeList1
-    -    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
-    registrationDateTimedate-time1
x-requestId [Header]string1Unikt 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

FejlkodeFejltekstBeskrivelse
120501Virksomheden blev ikke fundet.Virksomheden blev ikke fundet.
120502Der 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 borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

Ikke defineret

Input

ElementTypeDetaljerForekomstBeskrivelse
navn [Query]stringMinLength: 30 - 1Del af virksomhedens navn.
inkluderLaase [Query]VirksomhedslaasTypeCodeListCollection0 - 1Inkluder virksomheder med angivne låsetyper.

Som standard inkluderes låste virksomheder ikke.
-    VirksomhedslaasTypeCodeListVirksomhedslaasTypeCodeList0 - *
inkluderLukkede [Query]boolean0 - 1Inkluder lukkede virksomheder i søgeresultatet.

Som standard inkluderes lukkede virksomheder ikke.
X-ActiveOrganisation [Header]ActiveOrganisationDto1Impersoneret myndighed
-    organisationTypeOrganisationTypeCodeList1
-    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
X-RequestUserMetadata [Header]RequestUserMetadataDto1Kaldende myndighed
-    requestUserStructureRequestUserStructureDto1
-    -    userFullNamestringLength: 1-1401
-    -    requestUserTypeRequestUserTypeCodeList1
-    -    userIdentifierstringLength: 1-2551
-    -    userEmailemail0 - 1
-    requestOrganisationStructureRequestOrganisationStructureDto1
-    -    organisationTypeOrganisationTypeCodeList1
-    -    organisationCodestringPattern: \d{1,8}
MinLength: 1
1
-    registrationDateTimedate-time1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseSoegVirksomhederResponseDto1
-    soegeresultaterVirksomhedDtoCollection1Søgeresultater.
-    -    VirksomhedDtoVirksomhedDto0 - *
-    -    -    cvrNummerstringPattern: [0-9]{8}
MinLength: 1
1CVR-nummer.
-    -    -    navnstring0 - 1Navn på virksomheden (fra CVR).
-    -    -    urlstring0 - 1URL (fra CVR).
-    -    -    emailadressestring0 - 1E-mailadresse (fra CVR).
-    -    -    telefonnummerstring0 - 1Telefonnummer (fra CVR).
-    -    -    laasVirksomhedslaasTypeCodeList0 - 1
-    -    -    logobase64Binary0 - 1Logo i et formaterne: PNG, JPEG (base64).
-    -    -    adresseAdresseDto1Adresse for virksomhed.
-    -    -    -    vejnavnstring0 - 1Vejnavn (fra CVR).
-    -    -    -    husnummerstring0 - 1Husnummer (fra CVR).
-    -    -    -    etagestring0 - 1Etagebetegnelse (fra CVR).
-    -    -    -    sidedoerstring0 - 1Side-/dørbetegnelse (fra CVR).
-    -    -    -    bynavnstring0 - 1Bynavn (fra CVR).
-    -    -    -    postnummerstringPattern: [0-9]{4}0 - 1Postnummer (fra CVR).
-    -    -    -    kommunenummerint32Pattern: [0-9]{3}0 - 1Kommunenummer (fra CVR).
-    -    -    -    landekodestringPattern: [a-z,A-Z]{2}|[a-z,A-Z]{3}|[0-9]{3}|[0-9]{4}0 - 1Landekode (fra CVR).
-    -    -    lukketboolean1Om virksomheden er lukket (fra CVR).

Fejlkoder

Ingen fejlkoder

  • No labels