Virksomhedsindsats.CompanyContactService (Version 1, 2023-4)
- WikiUploader
Siden opdateres automatisk til at afspejle koden.
Metoder
- 1 CreateContact (POST /v1/CompanyContact)
- 2 GetContact (GET /v1/CompanyContact/{id})
- 3 UpdateContact (PUT /v1/CompanyContact/{id})
- 4 DeleteContact (DELETE /v1/CompanyContact/{id})
- 5 GetContactByEmail (GET /v1/CompanyContact/by-email/{email})
- 6 SetMainContact (PUT /v1/CompanyContact/main-contact)
- 7 SearchContacts (GET /v1/CompanyContact/search)
CreateContact (POST /v1/CompanyContact)
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
virksomhedsindsats.kontaktperson.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
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} | 1 | Beskrivelse af CVR-nummer |
- pNumber | string | Pattern: [0-9]{10} | 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 |
|
string | MinLength: 1 | 1 |
| |
- - mainPhoneNumber | string | MinLength: 1 | 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | uuid |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120033 |
|
|
120036 |
|
|
120204 |
|
|
120303 |
|
|
120405 |
|
|
GetContact (GET /v1/CompanyContact/{id})
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
virksomhedsindsats.kontaktperson.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
id [Path] | uuid |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
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 |
|
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 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120033 |
|
|
UpdateContact (PUT /v1/CompanyContact/{id})
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
virksomhedsindsats.kontaktperson.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
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} | 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 |
|
string | MinLength: 1 | 1 |
| |
- - mainPhoneNumber | string | MinLength: 1 | 1 |
|
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120033 |
|
|
120204 |
|
|
120400 |
|
|
120036 |
|
|
DeleteContact (DELETE /v1/CompanyContact/{id})
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
virksomhedsindsats.kontaktperson.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
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 |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120033 |
|
|
120400 |
|
|
GetContactByEmail (GET /v1/CompanyContact/by-email/{email})
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
virksomhedsindsats.kontaktperson.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
email [Path] |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
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 |
|
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 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120033 |
|
|
120401 |
|
|
120402 |
|
|
SetMainContact (PUT /v1/CompanyContact/main-contact)
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
virksomhedsindsats.kontaktperson.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
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 |
|
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120033 |
|
|
120403 |
|
|
120404 |
|
|
SearchContacts (GET /v1/CompanyContact/search)
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
virksomhedsindsats.kontaktperson.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
Email [Query] | string |
| 0 - 1 |
|
PhoneNumber [Query] | string |
| 0 - 1 |
|
IncludeLockedCompanies [Query] | boolean |
| 0 - 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
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 |
|
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 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | The submitted message is not valid | The submitted message is not valid |
120033 |
|
|
120036 |
|
|