Virksomhedsindsats.CompanyContactService (Version 1, 2023-4)

STAR

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

CreateContactRequestDto

1

-    cvrNumber

string

Pattern: [0-9]{8}
MinLength: 1

1

Beskrivelse af CVR-nummer

-    pNumber

string

Pattern: [0-9]{10}
MinLength: 1

1

Beskrivelse af P-nummer

-    contact

ContactCreateDto

1

-    -    title

string

0 - 1

-    -    firstName

string

MinLength: 1

1

-    -    middleName

string

0 - 1

-    -    surName

string

MinLength: 1

1

-    -    description

string

0 - 1

-    -    registrationState

int32

0 - 1

-    -    directPhoneNumber

string

0 - 1

-    -    mobilePhoneNumber

string

0 - 1

-    -    username

string

MinLength: 1

1

-    -    isMainContact

boolean

1

-    -    email

string

MinLength: 1

1

-    -    mainPhoneNumber

string

MinLength: 1

1

response

uuid

1

1014

The submitted message is not valid

The submitted message is not valid

120033

Generel fejl

Generel fejl

120036

Validering fejlede (se detaljer i ‘Detalje.Besked’)

Validering fejlede (se detaljer i ‘Detalje.Besked’)

120204

Virksomheden findes ikke i databasen.

Virksomheden findes ikke i databasen.

120303

Produktionsenheden findes ikke i databasen.

Produktionsenheden findes ikke i databasen.

120405

Den givne kontaktperson findes allerede (username skal være unikt).

Den givne kontaktperson findes allerede (username skal være unikt).

STAR

id [Path]

uuid

1

response

GetContactResponseDto

1

-    contact

ContactExtendedGetDto

0 - 1

-    -    title

string

0 - 1

-    -    firstName

string

MinLength: 1

1

-    -    middleName

string

0 - 1

-    -    surName

string

MinLength: 1

1

-    -    description

string

0 - 1

-    -    registrationState

int32

0 - 1

-    -    directPhoneNumber

string

0 - 1

-    -    mobilePhoneNumber

string

0 - 1

-    -    id

uuid

1

-    -    username

string

MinLength: 1

1

-    -    customerNumber

int32

0 - 1

-    -    isMainContact

boolean

0 - 1

-    -    email

string

0 - 1

-    -    mainPhoneNumber

string

0 - 1

-    -    createdTimestamp

date-time

0 - 1

-    -    lastUpdatedTimestamp

date-time

0 - 1

-    -    unregistrationTimestamp

date-time

0 - 1

-    -    isDisabled

boolean

0 - 1

-    -    cvrNumber

string

0 - 1

-    -    pNumber

string

0 - 1

1014

The submitted message is not valid

The submitted message is not valid

120033

Generel fejl

Generel fejl

STAR

id [Path]

uuid

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

UpdateContactRequestDto

1

-    pNumber

string

Pattern: [0-9]{10}
MinLength: 1

1

Beskrivelse af P-nummer

-    contact

ContactUpdateDto

1

-    -    title

string

0 - 1

-    -    firstName

string

MinLength: 1

1

-    -    middleName

string

0 - 1

-    -    surName

string

MinLength: 1

1

-    -    description

string

0 - 1

-    -    registrationState

int32

0 - 1

-    -    directPhoneNumber

string

0 - 1

-    -    mobilePhoneNumber

string

0 - 1

-    -    isMainContact

boolean

1

-    -    email

string

MinLength: 1

1

-    -    mainPhoneNumber

string

MinLength: 1

1

1014

The submitted message is not valid

The submitted message is not valid

120033

Generel fejl

Generel fejl

120204

Virksomheden findes ikke i databasen.

Virksomheden findes ikke i databasen.

120400

Kontaktpersonen findes ikke i databasen.

Kontaktpersonen findes ikke i databasen.

120036

Validering fejlede (se detaljer i ‘Detalje.Besked’)

Validering fejlede (se detaljer i ‘Detalje.Besked’)

STAR

id [Path]

uuid

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

1014

The submitted message is not valid

The submitted message is not valid

120033

Generel fejl

Generel fejl

120400

Kontaktpersonen findes ikke i databasen.

Kontaktpersonen findes ikke i databasen.

STAR

email [Path]

email

1

response

GetContactByEmailResponseDto

1

-    contact

ContactExtendedGetDto

0 - 1

-    -    title

string

0 - 1

-    -    firstName

string

MinLength: 1

1

-    -    middleName

string

0 - 1

-    -    surName

string

MinLength: 1

1

-    -    description

string

0 - 1

-    -    registrationState

int32

0 - 1

-    -    directPhoneNumber

string

0 - 1

-    -    mobilePhoneNumber

string

0 - 1

-    -    id

uuid

1

-    -    username

string

MinLength: 1

1

-    -    customerNumber

int32

0 - 1

-    -    isMainContact

boolean

0 - 1

-    -    email

string

0 - 1

-    -    mainPhoneNumber

string

0 - 1

-    -    createdTimestamp

date-time

0 - 1

-    -    lastUpdatedTimestamp

date-time

0 - 1

-    -    unregistrationTimestamp

date-time

0 - 1

-    -    isDisabled

boolean

0 - 1

-    -    cvrNumber

string

0 - 1

-    -    pNumber

string

0 - 1

1014

The submitted message is not valid

The submitted message is not valid

120033

Generel fejl

Generel fejl

120401

Kunne ikke finde en kontaktperson med den givne emailadresse.

Kunne ikke finde en kontaktperson med den givne emailadresse.

120402

Fandt mere end én kontaktperson med den givne emailadresse.

Fandt mere end én kontaktperson med den givne emailadresse.

STAR

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

SetMainContactRequestDto

1

-    currentMainContactId

uuid

1

-    newMainContactId

uuid

1

1014

The submitted message is not valid

The submitted message is not valid

120033

Generel fejl

Generel fejl

120403

Kontaktpersonerne er ikke fra samme virksomhed.

Kontaktpersonerne er ikke fra samme virksomhed.

120404

Den givne kontaktperson er ikke hovedkontaktperson.

Den givne kontaktperson er ikke hovedkontaktperson.

STAR

Email [Query]

string

0 - 1

PhoneNumber [Query]

string

0 - 1

IncludeLockedCompanies [Query]

boolean

0 - 1

response

SearchContactsResponseDto

1

-    contacts

ContactSearchDtoCollection

1

-    -    ContactSearchDto

ContactSearchDto

0 - *

-    -    -    title

string

0 - 1

-    -    -    firstName

string

MinLength: 1

1

-    -    -    middleName

string

0 - 1

-    -    -    surName

string

MinLength: 1

1

-    -    -    description

string

0 - 1

-    -    -    registrationState

int32

0 - 1

-    -    -    directPhoneNumber

string

0 - 1

-    -    -    mobilePhoneNumber

string

0 - 1

-    -    -    id

uuid

1

-    -    -    username

string

MinLength: 1

1

-    -    -    customerNumber

int32

0 - 1

-    -    -    isMainContact

boolean

0 - 1

-    -    -    email

string

0 - 1

-    -    -    mainPhoneNumber

string

0 - 1

-    -    -    createdTimestamp

date-time

0 - 1

-    -    -    lastUpdatedTimestamp

date-time

0 - 1

-    -    -    unregistrationTimestamp

date-time

0 - 1

-    -    -    isDisabled

boolean

0 - 1

-    -    -    cvrNumber

string

0 - 1

-    -    -    pNumber

string

0 - 1

-    -    -    companyName

string

0 - 1

-    -    -    productionUnitName

string

0 - 1

-    -    -    isProductionUnitLocked

boolean

0 - 1

1014

The submitted message is not valid

The submitted message is not valid

120033

Generel fejl

Generel fejl

120036

Validering fejlede (se detaljer i ‘Detalje.Besked’)

Validering fejlede (se detaljer i ‘Detalje.Besked’)