Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Scope

Ikke defineretvirksomhedsindsats.virksomhed.read

Input

ElementTypeDetaljerForekomstBeskrivelse
cvrNummer [Path]stringPattern: [0-9]{8}1X-ActiveOrganisation [Header]ActiveOrganisationDto1Impersoneret myndighed-    organisationTypeOrganisationTypeCodeList1-    organisationCode

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetVirksomhedResponseDto1
-    virksomhedVirksomhedDto1Virksomhed.
-    -    cvrNummerstringPattern: \d{1, [0-9]{8}
MinLength: 1
1X-RequestUserMetadata [Header]RequestUserMetadataDto1Kaldende myndighed-    requestUserStructureRequestUserStructureDto1CVR-nummer.
-    -    navnstring0 - 1Navn på virksomheden (fra CVR).
-    -    userFullName    urlstringLength: 0 - 1-1401URL (fra CVR).
-    -    requestUserType    emailadresseRequestUserTypeCodeListstring0 - 1-    -    userIdentifierE-mailadresse (fra CVR).
-    -    telefonnummerstringLength: 0 - 1-2551Telefonnummer (fra CVR).
-    -    userEmail    laasemailVirksomhedslaasTypeCodeList0 - 1
-    -    requestOrganisationStructure    logoRequestOrganisationStructureDtobase64Binary0 - 1Logo i et formaterne: PNG, JPEG (base64).
-    -    organisationType    adresseOrganisationTypeCodeListAdresseDto0 - 1Adresse for virksomhed.
-    -    organisationCode    -    vejnavnstringPattern: \d{1,8}
MinLength: 1
1-    registrationDateTimedate-time1

Output

...

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

...

Scope

Ikke defineret

Input

...

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

...

Scope

Ikke defineret

Input

...

ElementTypeDetaljerForekomstBeskrivelse
responseGetVirksomhedResponseDto1-    virksomhedVirksomhedDto1Virksomhed0 - 1Vejnavn (fra CVR).
-    -    -    husnummerstring0 - 1Husnummer (fra CVR).
-    -    -    etagestring0 - 1Etagebetegnelse (fra CVR).
-    -    cvrNummer    -    sidedoerstringPattern: [0 - 9]{8}
MinLength: 1
1CVR-nummerSide-/dørbetegnelse (fra CVR).
-    -    -    navn    bynavnstring0 - 1Navn på virksomheden Bynavn (fra CVR).
-    -    -    url    postnummerstringPattern: [0-9]{4}0 - 1URL Postnummer (fra CVR).
-    -    -    emailadressestring    kommunenummerint32Pattern: [0-9]{3}0 - 1E-mailadresse Kommunenummer (fra CVR).
-    -    -    telefonnummer    landekodestring0 - 1Telefonnummer (Pattern: [a-z,A-Z]{2}|[a-z,A-Z]{3}|[0-9]{3}|[0-9]{4}0 - 1Landekode (fra CVR).
-    -    laas    lukketVirksomhedslaasTypeCodeListboolean0 - 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

...

Scope

Ikke defineret

Input

...

Output

...

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

...

Scope

Ikke defineret

Input

...

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

Scope

virksomhedsindsats.virksomhed.read

Input

ElementTypeDetaljerForekomstBeskrivelse
cvrNummer [Path]stringPattern: [0-9]{8}1

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

Scope

virksomhedsindsats.virksomhed.write

Input

ElementTypeDetaljerForekomstBeskrivelse
responseGetLaasehistorikResponseDtocvrNummer [Path]stringPattern: [0-9]{8}1
x-    historikresultaterLaasehistorikDtoCollectionrequestId [Header]string1Lå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.

...

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

Sætter lås på en virksomhedSletter 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

Scope

Ikke defineretvirksomhedsindsats.virksomhed.write

Input

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

virksomhedsindsats.virksomhed.laas.read

Input

ElementTypeDetaljerForekomstBeskrivelse
cvrNummer [Path]stringPattern: [0-9]{8}1

Output

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

Output

...

-    -    -    oprettetTidspunktdate-time1Tidspunkt for ændringen.

Fejlkoder

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

...

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

Sletter 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 defineretvirksomhedsindsats.virksomhed.laas.write

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
1X-RequestUserMetadata [Header]RequestUserMetadataDto1Kaldende myndighed-    requestUserStructureRequestUserStructureDto1-    -    userFullName]stringPattern: [0-9]{8}1
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-1405001-    -    requestUserTypeRequestUserTypeCodeList1-    -    userIdentifierstringLength: 1-2551-    -    userEmailemail0 - 1-    requestOrganisationStructureRequestOrganisationStructureDto1-    -    organisationTypeOrganisationTypeCodeList1-    -    organisationCodestringPattern: \d{1,8}
MinLength: 1
1-    registrationDateTimedate-time1x-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

...

Scope

Ikke defineret

Input

Inkluder virksomheder med angivne låsetyper.
Som standard inkluderes låste virksomheder ikke.Inkluder lukkede virksomheder i søgeresultatet.
Som standard inkluderes lukkede virksomheder ikke.
ElementTypeDetaljerForekomstBeskrivelse
navn [Query]stringMinLength: 30 - 1Del af virksomhedens navn.
inkluderLaase [Query]VirksomhedslaasTypeCodeListCollection0 - 1-    VirksomhedslaasTypeCodeListVirksomhedslaasTypeCodeList0 - *inkluderLukkede [Query]boolean0 - 1X-ActiveOrganisation [Header]ActiveOrganisationDto1Impersoneret myndighed-    organisationTypeOrganisationTypeCodeList1-    organisationCodestringPattern: \d{1,8}
MinLength: 1
1X-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Å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

virksomhedsindsats.virksomhed.laas.write

Input

ElementTypeDetaljerForekomstBeskrivelse
cvrNummer [Path]stringPattern: [0-9]{8}1
aarsag [Query]stringMaxLength: 5001Årsag til at ændringen er lavet.
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

virksomhedsindsats.virksomhed.read

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.
sidestoerrelse [Query]int32MinInclusive: 1
MaxInclusive: 1000
0 - 1Det maksimale antal returnerede søgeresultater.
Angives denne ikke sættes sidestørrelsen til 100.
sidenummer [Query]int32MinInclusive: 0
MaxInclusive: 2147483647
0 - 1Sidenummer definerer hvilken side i resultatsættet, der returneres.
Angives denne ikke, returneres første side.

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).
-    -    -    adresseAdresseDto0 - 1Adresse 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).

...