Virksomhedsindsats.CompanyService (Version 1, 2024-1)

STAR

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

120033

1014

The submitted message is not valid

The submitted message is not valid

120200

120201

120202

120203

120212

STAR

cvr [Path]

string

Pattern: [0-9]{8}

1

IncludeContacts [Query]

boolean

0 - 1

IncludeProductionUnits [Query]

boolean

0 - 1

response

GetCompanyResponseDto

1

-    companyDetails

CompanyDetailsGetDto

0 - 1

-    -    id

int32

1

-    -    mainAddress

string

MinLength: 1

1

-    -    visitAddress

string

0 - 1

-    -    city

string

MinLength: 1

1

-    -    phoneNumber

string

0 - 1

-    -    email

string

0 - 1

-    -    homePage

string

0 - 1

-    -    description

string

0 - 1

-    -    municipalityCode

int32

1

-    -    businessArea

string

0 - 1

-    -    organisationTypeId

int32

0 - 1

-    -    cvr

string

0 - 1

-    -    customerNumber

int32

0 - 1

-    -    companyName

string

0 - 1

-    -    postalCode

string

0 - 1

-    -    countryCode

string

0 - 1

-    -    logoId

int32

0 - 1

-    -    registrationState

int32

1

-    -    isLocked

boolean

1

-    -    lastUpdatedTimestamp

date-time

0 - 1

-    -    unregistrationTimestamp

date-time

0 - 1

-    productionUnits

ProductionUnitDtoCollection

0 - 1

-    -    ProductionUnitDto

ProductionUnitDto

0 - *

-    -    -    productionUnitDetails

ProductionUnitDetailsDto

0 - 1

-    -    -    -    id

int32

1

-    -    -    -    pNumber

string

0 - 1

-    -    -    -    customerNumber

int32

0 - 1

-    -    -    -    name

string

MinLength: 1

1

-    -    -    -    mainAddress

string

0 - 1

-    -    -    -    visitAddress

string

0 - 1

-    -    -    -    postalCode

string

0 - 1

-    -    -    -    city

string

MinLength: 1

1

-    -    -    -    phoneNumber

string

0 - 1

-    -    -    -    email

string

0 - 1

-    -    -    -    homePage

string

0 - 1

-    -    -    -    description

string

0 - 1

-    -    -    -    municipalityCode

int32

0 - 1

-    -    -    -    logoId

int32

0 - 1

-    -    -    -    activityStateId

int32

1

-    -    -    -    isDisabled

boolean

0 - 1

-    -    -    -    createdTimestamp

date-time

0 - 1

-    -    -    -    lastUpdatedTimestamp

date-time

0 - 1

-    -    -    -    unregistrationTimestamp

date-time

0 - 1

-    -    -    contacts

ContactDtoCollection

0 - 1

-    -    -    -    ContactDto

ContactDto

0 - *

-    -    -    -    -    id

uuid

1

-    -    -    -    -    username

string

MinLength: 1

1

-    -    -    -    -    customerNumber

int32

0 - 1

-    -    -    -    -    isMainContact

boolean

0 - 1

-    -    -    -    -    title

string

0 - 1

-    -    -    -    -    firstName

string

MinLength: 1

1

-    -    -    -    -    middleName

string

0 - 1

-    -    -    -    -    surName

string

MinLength: 1

1

-    -    -    -    -    description

string

0 - 1

-    -    -    -    -    email

string

0 - 1

-    -    -    -    -    registrationState

int32

0 - 1

-    -    -    -    -    mainPhoneNumber

string

0 - 1

-    -    -    -    -    directPhoneNumber

string

0 - 1

-    -    -    -    -    mobilePhoneNumber

string

0 - 1

-    -    -    -    -    createdTimestamp

date-time

0 - 1

-    -    -    -    -    lastUpdatedTimestamp

date-time

0 - 1

-    -    -    -    -    unregistrationTimestamp

date-time

0 - 1

-    -    -    -    -    isDisabled

boolean

0 - 1

120033

1014

The submitted message is not valid

The submitted message is not valid

STAR

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

UpdateCompanyRequestDto

1

-    companyDetails

CompanyDetailsUpdateDto

1

-    -    id

int32

1

-    -    mainAddress

string

MinLength: 1

1

-    -    visitAddress

string

0 - 1

-    -    city

string

MinLength: 1

1

-    -    phoneNumber

string

0 - 1

-    -    email

string

0 - 1

-    -    homePage

string

0 - 1

-    -    description

string

0 - 1

-    -    municipalityCode

int32

1

-    -    businessArea

string

0 - 1

-    -    organisationTypeId

int32

0 - 1

-    -    customerNumber

int32

1

-    -    companyName

string

MinLength: 1

1

-    -    postalCode

string

MinLength: 1

1

120033

1014

The submitted message is not valid

The submitted message is not valid

120036

120204

120205

120206

STAR

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

120033

1014

The submitted message is not valid

The submitted message is not valid

120204

120207

120208

120209

STAR

cvr [Path]

string

Pattern: [0-9]{8}

1

response

GetCompanyStateResponseDto

1

-    companyState

CompanyStateDto

0 - 1

-    -    registrationState

int32

1

-    -    isLocked

boolean

1

-    -    isDeleted

boolean

1

-    -    isDeletedWithinLast24Hours

boolean

1

-    -    isPriviledgedForCvs

boolean

1

120033

1014

The submitted message is not valid

The submitted message is not valid

STAR

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

SetCompanyLogoRequestDto

1

-    logo

CompanyLogoDto

1

-    -    fileName

string

0 - 1

-    -    image

base64Binary

0 - 1

-    -    imageType

string

0 - 1

120033

1014

The submitted message is not valid

The submitted message is not valid

120204

STAR

cvr [Path]

string

Pattern: [0-9]{8}

1

response

GetCompanyLogoResponseDto

1

-    logo

CompanyLogoGetDto

0 - 1

-    -    fileName

string

0 - 1

-    -    image

base64Binary

0 - 1

-    -    imageType

string

0 - 1

-    -    id

int32

1

120033

1014

The submitted message is not valid

The submitted message is not valid

STAR

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

120033

1014

The submitted message is not valid

The submitted message is not valid

120214

STAR

id [Path]

int32

1

response

GetCompanyLogoByIdResponseDto

1

-    logo

CompanyLogoGetDto

0 - 1

-    -    fileName

string

0 - 1

-    -    image

base64Binary

0 - 1

-    -    imageType

string

0 - 1

-    -    id

int32

1

120033

1014

The submitted message is not valid

The submitted message is not valid

STAR

id [Path]

int32

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

120033

1014

The submitted message is not valid

The submitted message is not valid

STAR

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

LockCompanyRequestDto

1

-    caseworkerRid

string

0 - 1

-    caseworkerUuid

uuid

0 - 1

-    reason

string

0 - 1

120033

1014

The submitted message is not valid

The submitted message is not valid

120036

120204

120210

120211

STAR

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

UnlockCompanyRequestDto

1

-    caseworkerRid

string

0 - 1

-    caseworkerUuid

uuid

0 - 1

-    reason

string

0 - 1

120033

1014

The submitted message is not valid

The submitted message is not valid

120036

120204

120210

STAR

cvr [Path]

string

Pattern: [0-9]{8}

1

response

GetCompanyLockHistoryResponseDto

1

-    companyLockHistoryEntries

CompanyLockHistoryEntryDtoCollection

1

-    -    CompanyLockHistoryEntryDto

CompanyLockHistoryEntryDto

0 - *

-    -    -    measure

CompanyLockMeasureTypeCodeList

0 - 1

-    -    -    caseworker

string

0 - 1

-    -    -    reason

string

0 - 1

-    -    -    savedTimestamp

date-time

0 - 1

120033

1014

The submitted message is not valid

The submitted message is not valid

STAR

Cvr [Query]

string

0 - 1

CompanyName [Query]

string

0 - 1

IncludeLockedCompanies [Query]

boolean

0 - 1

response

SearchCompaniesResponseDto

1

-    companies

CompanyDetailsGetDtoCollection

1

-    -    CompanyDetailsGetDto