Virksomhedsindsats.VirksomhedService (Version 1 [UDV], 2024-1)
Siden opdateres automatisk til at afspejle koden.
Metoder
- 1 GetVirksomhed (GET /v1/Virksomhed/{cvrNummer})
- 2 GetLogo (GET /v1/Virksomhed/logo/{cvrNummer})
- 3 SetLogo (PUT /v1/Virksomhed/logo/{cvrNummer})
- 4 DeleteLogo (DELETE /v1/Virksomhed/logo/{cvrNummer})
- 5 GetLaasehistorik (GET /v1/Virksomhed/laasehistorik/{cvrNummer})
- 6 SetLaas (PUT /v1/Virksomhed/laas/{cvrNummer})
- 7 DeleteLaas (DELETE /v1/Virksomhed/laas/{cvrNummer})
- 8 SoegVirksomheder (GET /v1/Virksomhed/soeg)
GetVirksomhed (GET /v1/Virksomhed/{cvrNummer})
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
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 |
|
X-ActiveOrganisation [Header] | ActiveOrganisationDto |
| 1 | Impersoneret myndighed |
- organisationType |
| 1 |
| |
- organisationCode | string | Pattern: \d{1,8} | 1 |
|
X-RequestUserMetadata [Header] | RequestUserMetadataDto |
| 1 | Kaldende myndighed |
- requestUserStructure | RequestUserStructureDto |
| 1 |
|
- - userFullName | string | Length: 1-140 | 1 |
|
- - requestUserType |
| 1 |
| |
- - userIdentifier | string | Length: 1-255 | 1 |
|
- - userEmail |
| 0 - 1 |
| |
- requestOrganisationStructure | RequestOrganisationStructureDto |
| 1 |
|
- - organisationType |
| 1 |
| |
- - organisationCode | string | Pattern: \d{1,8} | 1 |
|
- registrationDateTime | date-time |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetVirksomhedResponseDto |
| 1 |
|
- virksomhed | VirksomhedDto |
| 1 |
|
- - cvrNummer | string | Pattern: [0-9]{8} | 1 | CVR-nummer |
- - navn | string |
| 0 - 1 | Navn på virksomheden (fra CVR) |
- - hjemmeside | string |
| 0 - 1 | Hjemmeside (fra CVR) |
string |
| 0 - 1 | E-mailadresse (fra CVR) | |
- - telefonnummer | string |
| 0 - 1 | Telefonnummer (fra CVR) |
- - laas |
| 0 - 1 | Angivelse af, hvorvidt Virksomhed er Konfliktramt eller Spærret Ved ingen angivelse er virksomhed ikke under begrænsning. | |
- - logo | base64Binary |
| 0 - 1 | Logo i et formaterne: PNG, JPEG (base64) Billedtype kan findes som den første del af den base64 encodede fil |
- - adresse | AdresseDto |
| 1 |
|
- - - vejnavn | string |
| 0 - 1 | Vejnavn (fra CVR) |
- - - husnummer | string |
| 0 - 1 | Husnummer (fra CVR) |
- - - etage | string |
| 0 - 1 | Etagebetegnelse (fra CVR) |
- - - doer | string |
| 0 - 1 | Dørbetegnelse (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) |
- - slettet | boolean |
| 1 | Om virksomheden er slettet (fra CVR) |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120204 | Virksomheden findes ikke i databasen. | Virksomheden findes ikke i databasen. |
GetLogo (GET /v1/Virksomhed/logo/{cvrNummer})
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
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 |
|
X-ActiveOrganisation [Header] | ActiveOrganisationDto |
| 1 | Impersoneret myndighed |
- organisationType |
| 1 |
| |
- organisationCode | string | Pattern: \d{1,8} | 1 |
|
X-RequestUserMetadata [Header] | RequestUserMetadataDto |
| 1 | Kaldende myndighed |
- requestUserStructure | RequestUserStructureDto |
| 1 |
|
- - userFullName | string | Length: 1-140 | 1 |
|
- - requestUserType |
| 1 |
| |
- - userIdentifier | string | Length: 1-255 | 1 |
|
- - userEmail |
| 0 - 1 |
| |
- requestOrganisationStructure | RequestOrganisationStructureDto |
| 1 |
|
- - organisationType |
| 1 |
| |
- - organisationCode | string | Pattern: \d{1,8} | 1 |
|
- registrationDateTime | date-time |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetLogoResponseDto |
| 1 |
|
- logo | base64Binary | MinLength: 1 | 1 | Logo i et formaterne: PNG, JPEG (base64) Billedtype kan findes som den første del af den base64 encodede fil |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120204 | Virksomheden findes ikke i databasen. | Virksomheden findes ikke i databasen. |
SetLogo (PUT /v1/Virksomhed/logo/{cvrNummer})
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
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 |
|
X-ActiveOrganisation [Header] | ActiveOrganisationDto |
| 1 | Impersoneret myndighed |
- organisationType |
| 1 |
| |
- organisationCode | string | Pattern: \d{1,8} | 1 |
|
X-RequestUserMetadata [Header] | RequestUserMetadataDto |
| 1 | Kaldende myndighed |
- requestUserStructure | RequestUserStructureDto |
| 1 |
|
- - userFullName | string | Length: 1-140 | 1 |
|
- - requestUserType |
| 1 |
| |
- - userIdentifier | string | Length: 1-255 | 1 |
|
- - userEmail |
| 0 - 1 |
| |
- requestOrganisationStructure | RequestOrganisationStructureDto |
| 1 |
|
- - organisationType |
| 1 |
| |
- - organisationCode | string | Pattern: \d{1,8} | 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) Billedtype kan findes som den første del af den base64 encodede fil |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120204 | Virksomheden findes ikke i databasen. | Virksomheden findes ikke i databasen. |
DeleteLogo (DELETE /v1/Virksomhed/logo/{cvrNummer})
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
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 |
|
X-ActiveOrganisation [Header] | ActiveOrganisationDto |
| 1 | Impersoneret myndighed |
- organisationType |
| 1 |
| |
- organisationCode | string | Pattern: \d{1,8} | 1 |
|
X-RequestUserMetadata [Header] | RequestUserMetadataDto |
| 1 | Kaldende myndighed |
- requestUserStructure | RequestUserStructureDto |
| 1 |
|
- - userFullName | string | Length: 1-140 | 1 |
|
- - requestUserType |
| 1 |
| |
- - userIdentifier | string | Length: 1-255 | 1 |
|
- - userEmail |
| 0 - 1 |
| |
- requestOrganisationStructure | RequestOrganisationStructureDto |
| 1 |
|
- - organisationType |
| 1 |
| |
- - organisationCode | string | Pattern: \d{1,8} | 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 |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120204 | Virksomheden findes ikke i databasen. | Virksomheden findes ikke i databasen. |
120214 | Kunne ikke finde logoet. | Kunne ikke finde logoet. |
GetLaasehistorik (GET /v1/Virksomhed/laasehistorik/{cvrNummer})
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
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 |
|
X-ActiveOrganisation [Header] | ActiveOrganisationDto |
| 1 | Impersoneret myndighed |
- organisationType |
| 1 |
| |
- organisationCode | string | Pattern: \d{1,8} | 1 |
|
X-RequestUserMetadata [Header] | RequestUserMetadataDto |
| 1 | Kaldende myndighed |
- requestUserStructure | RequestUserStructureDto |
| 1 |
|
- - userFullName | string | Length: 1-140 | 1 |
|
- - requestUserType |
| 1 |
| |
- - userIdentifier | string | Length: 1-255 | 1 |
|
- - userEmail |
| 0 - 1 |
| |
- requestOrganisationStructure | RequestOrganisationStructureDto |
| 1 |
|
- - organisationType |
| 1 |
| |
- - organisationCode | string | Pattern: \d{1,8} | 1 |
|
- registrationDateTime | date-time |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetLaasehistorikResponseDto |
| 1 |
|
- historik | LaasehistorikDtoCollection |
| 1 | Låsehistorik for virksomhed |
- - LaasehistorikDto | LaasehistorikDto |
| 0 - * |
|
- - - laas |
| 0 - 1 | Angivelse af, hvorvidt Virksomhed er Konfliktramt eller Spærret Ved ingen angivelse er virksomhed ikke under begrænsning. | |
- - - aarsag | string | MinLength: 1 | 1 | Årsag til at ændringen er lavet |
- - - sagsbehandler | string | MinLength: 1 | 1 | Sagsbehandler, Medarbejder, som lavede ændringen |
- - - oprettetTidspunkt | date-time |
| 1 | Dato og Tidspunkt for ændringen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120204 | Virksomheden findes ikke i databasen. | Virksomheden findes ikke i databasen. |
SetLaas (PUT /v1/Virksomhed/laas/{cvrNummer})
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
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 |
|
X-ActiveOrganisation [Header] | ActiveOrganisationDto |
| 1 | Impersoneret myndighed |
- organisationType |
| 1 |
| |
- organisationCode | string | Pattern: \d{1,8} | 1 |
|
X-RequestUserMetadata [Header] | RequestUserMetadataDto |
| 1 | Kaldende myndighed |
- requestUserStructure | RequestUserStructureDto |
| 1 |
|
- - userFullName | string | Length: 1-140 | 1 |
|
- - requestUserType |
| 1 |
| |
- - userIdentifier | string | Length: 1-255 | 1 |
|
- - userEmail |
| 0 - 1 |
| |
- requestOrganisationStructure | RequestOrganisationStructureDto |
| 1 |
|
- - organisationType |
| 1 |
| |
- - organisationCode | string | Pattern: \d{1,8} | 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 |
| 1 | Angivelse af, hvorvidt Virksomhed er Konfliktramt eller Spærret Ved ingen angivelse er virksomhed ikke under begrænsning. | |
- aarsag | string | MinLength: 1 | 1 | Årsag til at ændringen er lavet |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120204 | Virksomheden findes ikke i databasen. | Virksomheden findes ikke i databasen. |
DeleteLaas (DELETE /v1/Virksomhed/laas/{cvrNummer})
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
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
cvrNummer [Path] | string | Pattern: [0-9]{8} | 1 |
|
Aarsag [Query] | string |
| 1 | Årsag til at ændringen er lavet |
X-ActiveOrganisation [Header] | ActiveOrganisationDto |
| 1 | Impersoneret myndighed |
- organisationType |
| 1 |
| |
- organisationCode | string | Pattern: \d{1,8} | 1 |
|
X-RequestUserMetadata [Header] | RequestUserMetadataDto |
| 1 | Kaldende myndighed |
- requestUserStructure | RequestUserStructureDto |
| 1 |
|
- - userFullName | string | Length: 1-140 | 1 |
|
- - requestUserType |
| 1 |
| |
- - userIdentifier | string | Length: 1-255 | 1 |
|
- - userEmail |
| 0 - 1 |
| |
- requestOrganisationStructure | RequestOrganisationStructureDto |
| 1 |
|
- - organisationType |
| 1 |
| |
- - organisationCode | string | Pattern: \d{1,8} | 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 |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120204 | Virksomheden findes ikke i databasen. | Virksomheden findes ikke i databasen. |
SoegVirksomheder (GET /v1/Virksomhed/soeg)
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
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
Name [Query] | string |
| 0 - 1 | Del af virksomhedens navn |
Laase [Query] | VirksomhedslaasTypeCodeListCollection |
| 0 - 1 | Liste af låsetyper. Ved tom liste hentes kun virksomheder uden lås |
- VirksomhedslaasTypeCodeList |
| 0 - * |
| |
InkluderSlettede [Query] | boolean |
| 0 - 1 | Inkluder slettede virksomheder i søgeresultatet |
X-ActiveOrganisation [Header] | ActiveOrganisationDto |
| 1 | Impersoneret myndighed |
- organisationType |
| 1 |
| |
- organisationCode | string | Pattern: \d{1,8} | 1 |
|
X-RequestUserMetadata [Header] | RequestUserMetadataDto |
| 1 | Kaldende myndighed |
- requestUserStructure | RequestUserStructureDto |
| 1 |
|
- - userFullName | string | Length: 1-140 | 1 |
|
- - requestUserType |
| 1 |
| |
- - userIdentifier | string | Length: 1-255 | 1 |
|
- - userEmail |
| 0 - 1 |
| |
- requestOrganisationStructure | RequestOrganisationStructureDto |
| 1 |
|
- - organisationType |
| 1 |
| |
- - organisationCode | string | Pattern: \d{1,8} | 1 |
|
- registrationDateTime | date-time |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | SoegVirksomhederResponseDto |
| 1 |
|
- virksomheder | VirksomhedDtoCollection |
| 1 | Søgeresultater |
- - VirksomhedDto | VirksomhedDto |
| 0 - * |
|
- - - cvrNummer | string | Pattern: [0-9]{8} | 1 | CVR-nummer |
- - - navn | string |
| 0 - 1 | Navn på virksomheden (fra CVR) |
- - - hjemmeside | string |
| 0 - 1 | Hjemmeside (fra CVR) |
string |
| 0 - 1 | E-mailadresse (fra CVR) | |
- - - telefonnummer | string |
| 0 - 1 | Telefonnummer (fra CVR) |
- - - laas |
| 0 - 1 | Angivelse af, hvorvidt Virksomhed er Konfliktramt eller Spærret Ved ingen angivelse er virksomhed ikke under begrænsning. | |
- - - logo | base64Binary |
| 0 - 1 | Logo i et formaterne: PNG, JPEG (base64) Billedtype kan findes som den første del af den base64 encodede fil |
- - - adresse | AdresseDto |
| 1 |
|
- - - - vejnavn | string |
| 0 - 1 | Vejnavn (fra CVR) |
- - - - husnummer | string |
| 0 - 1 | Husnummer (fra CVR) |
- - - - etage | string |
| 0 - 1 | Etagebetegnelse (fra CVR) |
- - - - doer | string |
| 0 - 1 | Dørbetegnelse (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) |
- - - slettet | boolean |
| 1 | Om virksomheden er slettet (fra CVR) |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
XxXxXxXx | Validering på emailadresse fejlede | Validering på emailadresse fejlede |