Virksomhedsindsats.KontaktpersonService (Version 1 [UDV], 2024-1)

Siden opdateres automatisk til at afspejle koden.

Metoder

CreateKontaktperson (POST /v1/Kontaktperson)

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

 

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

Element

Type

Detaljer

Forekomst

Beskrivelse

X-ActiveOrganisation [Header]

ActiveOrganisationDto

 

1

Impersoneret myndighed

-    organisationType

OrganisationTypeCodeList

 

1

 

-    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

X-RequestUserMetadata [Header]

RequestUserMetadataDto

 

1

Kaldende myndighed

-    requestUserStructure

RequestUserStructureDto

 

1

 

-    -    userFullName

string

Length: 1-140

1

 

-    -    requestUserType

RequestUserTypeCodeList

 

1

 

-    -    userIdentifier

string

Length: 1-255

1

 

-    -    userEmail

email

 

0 - 1

 

-    requestOrganisationStructure

RequestOrganisationStructureDto

 

1

 

-    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

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

CreateKontaktpersonRequestDto

 

1

 

-    kontaktperson

KontaktpersonDto

 

1

 

-    -    fornavne

string

MinLength: 1

1

Fornavn(e)

-    -    efternavn

string

MinLength: 1

1

Efternavn

-    -    titel

string

 

0 - 1

Titel

-    -    telefonnummer

string

Pattern: (\+)?[0-9]{3,20}

0 - 1

Telefonnummer

-    -    emailadresse

email

Kan vi validere denne, hvis den er udfyldt?

0 - 1

E-mailadresse

-    -    cvrNummer

string

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

1

CVR-nummer på virksomheden som kontaktpersonen tilhører

-    -    pNumre

stringCollection

 

0 - 1

P-numre på produktionsenheder som kontaktpersonen tilhører

-    -    -    string

string

Pattern: [0-9]{10}

0 - *

 

-    -    eksternReference

uuid

 

0 - 1

Ekstern system reference

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

int32

 

1

 

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

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.

120303

Produktionsenheden findes ikke i databasen.

Produktionsenheden findes ikke i databasen.

GetKontaktperson (GET /v1/Kontaktperson/{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

 

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

Element

Type

Detaljer

Forekomst

Beskrivelse

id [Path]

int32

 

1

 

X-ActiveOrganisation [Header]

ActiveOrganisationDto

 

1

Impersoneret myndighed

-    organisationType

OrganisationTypeCodeList

 

1

 

-    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

X-RequestUserMetadata [Header]

RequestUserMetadataDto

 

1

Kaldende myndighed

-    requestUserStructure

RequestUserStructureDto

 

1

 

-    -    userFullName

string

Length: 1-140

1

 

-    -    requestUserType

RequestUserTypeCodeList

 

1

 

-    -    userIdentifier

string

Length: 1-255

1

 

-    -    userEmail

email

 

0 - 1

 

-    requestOrganisationStructure

RequestOrganisationStructureDto

 

1

 

-    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

-    registrationDateTime

date-time

 

1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetKontaktpersonResponseDto

 

1

 

-    kontaktperson

GetKontaktpersonDto

 

1

 

-    -    fornavne

string

MinLength: 1

1

Fornavn(e)

-    -    efternavn

string

MinLength: 1

1

Efternavn

-    -    titel

string

 

0 - 1

Titel

-    -    telefonnummer

string

Pattern: (\+)?[0-9]{3,20}

0 - 1

Telefonnummer

-    -    emailadresse

email

Kan vi validere denne, hvis den er udfyldt?

0 - 1

E-mailadresse

-    -    cvrNummer

string

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

1

CVR-nummer på virksomheden som kontaktpersonen tilhører

-    -    pNumre

stringCollection

 

0 - 1

P-numre på produktionsenheder som kontaktpersonen tilhører

-    -    -    string

string

Pattern: [0-9]{10}

0 - *

 

-    -    eksternReference

uuid

 

0 - 1

Ekstern system reference

-    -    id

int32

 

1

Id på kontaktpersonen

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1014

The submitted message is not valid

The submitted message is not valid

UpdateKontaktperson (PUT /v1/Kontaktperson/{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

 

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

Element

Type

Detaljer

Forekomst

Beskrivelse

id [Path]

int32

 

1

 

X-ActiveOrganisation [Header]

ActiveOrganisationDto

 

1

Impersoneret myndighed

-    organisationType

OrganisationTypeCodeList

 

1

 

-    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

X-RequestUserMetadata [Header]

RequestUserMetadataDto

 

1

Kaldende myndighed

-    requestUserStructure

RequestUserStructureDto

 

1

 

-    -    userFullName

string

Length: 1-140

1

 

-    -    requestUserType

RequestUserTypeCodeList

 

1

 

-    -    userIdentifier

string

Length: 1-255

1

 

-    -    userEmail

email

 

0 - 1

 

-    requestOrganisationStructure

RequestOrganisationStructureDto

 

1

 

-    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

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

UpdateKontaktpersonRequestDto

 

1

 

-    kontaktperson

KontaktpersonDto

 

1

 

-    -    fornavne

string

MinLength: 1

1

Fornavn(e)

-    -    efternavn

string

MinLength: 1

1

Efternavn

-    -    titel

string

 

0 - 1

Titel

-    -    telefonnummer

string

Pattern: (\+)?[0-9]{3,20}

0 - 1

Telefonnummer

-    -    emailadresse

email

Kan vi validere denne, hvis den er udfyldt?

0 - 1

E-mailadresse

-    -    cvrNummer

string

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

1

CVR-nummer på virksomheden som kontaktpersonen tilhører

-    -    pNumre

stringCollection

 

0 - 1

P-numre på produktionsenheder som kontaktpersonen tilhører

-    -    -    string

string

Pattern: [0-9]{10}

0 - *

 

-    -    eksternReference

uuid

 

0 - 1

Ekstern system reference

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

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.

120303

Produktionsenheden findes ikke i databasen.

Produktionsenheden findes ikke i databasen.

120400

Kontaktpersonen findes ikke i databasen.

Kontaktpersonen findes ikke i databasen.

DeleteKontaktperson (DELETE /v1/Kontaktperson/{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

 

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

Element

Type

Detaljer

Forekomst

Beskrivelse

id [Path]

int32

 

1

 

X-ActiveOrganisation [Header]

ActiveOrganisationDto

 

1

Impersoneret myndighed

-    organisationType

OrganisationTypeCodeList

 

1

 

-    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

X-RequestUserMetadata [Header]

RequestUserMetadataDto

 

1

Kaldende myndighed

-    requestUserStructure

RequestUserStructureDto

 

1

 

-    -    userFullName

string

Length: 1-140

1

 

-    -    requestUserType

RequestUserTypeCodeList

 

1

 

-    -    userIdentifier

string

Length: 1-255

1

 

-    -    userEmail

email

 

0 - 1

 

-    requestOrganisationStructure

RequestOrganisationStructureDto

 

1

 

-    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

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

Fejlkode

Fejltekst

Beskrivelse

1014

The submitted message is not valid

The submitted message is not valid

120400

Kontaktpersonen findes ikke i databasen.

Kontaktpersonen findes ikke i databasen.

SoegKontaktpersoner (GET /v1/Kontaktperson/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

 

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

Element

Type

Detaljer

Forekomst

Beskrivelse

Navn [Query]

string

 

0 - 1

Del af kontaktpersonens navn

Telefonnummer [Query]

string

 

0 - 1

Del af kontaktpersonens telefonnummer

Emailadresse [Query]

string

 

0 - 1

Del af kontaktpersonens e-mailadresse

CvrNummer [Query]

string

Pattern: [0-9]{8}

0 - 1

CVR-nummer på virksomheden som kontaktpersonen tilhører

PNummer [Query]

string

Pattern: [0-9]{10}

0 - 1

P-nummer på produktionsenheden som kontaktpersonen tilhører

X-ActiveOrganisation [Header]

ActiveOrganisationDto

 

1

Impersoneret myndighed

-    organisationType

OrganisationTypeCodeList

 

1

 

-    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

X-RequestUserMetadata [Header]

RequestUserMetadataDto

 

1

Kaldende myndighed

-    requestUserStructure

RequestUserStructureDto

 

1

 

-    -    userFullName

string

Length: 1-140

1

 

-    -    requestUserType

RequestUserTypeCodeList

 

1

 

-    -    userIdentifier

string

Length: 1-255

1

 

-    -    userEmail

email

 

0 - 1

 

-    requestOrganisationStructure

RequestOrganisationStructureDto

 

1

 

-    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

-    registrationDateTime

date-time

 

1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

SoegKontaktpersonerResponseDto

 

1

 

-    kontaktpersoner

GetKontaktpersonDtoCollection

 

1

Søgeresultater

-    -    GetKontaktpersonDto

GetKontaktpersonDto

 

0 - *

 

-    -    -    fornavne

string

MinLength: 1

1

Fornavn(e)

-    -    -    efternavn

string

MinLength: 1

1

Efternavn

-    -    -    titel

string

 

0 - 1

Titel

-    -    -    telefonnummer

string

Pattern: (\+)?[0-9]{3,20}

0 - 1

Telefonnummer

-    -    -    emailadresse

email

Kan vi validere denne, hvis den er udfyldt?

0 - 1

E-mailadresse

-    -    -    cvrNummer

string

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

1

CVR-nummer på virksomheden som kontaktpersonen tilhører

-    -    -    pNumre

stringCollection

Pattern: [0-9]{10}

0 - 1

P-numre på produktionsenheder som kontaktpersonen tilhører

-    -    -    -    string

string

 

0 - *

 

-    -    -    eksternReference

uuid

 

0 - 1

Ekstern system reference

-    -    -    id

int32

 

1

Id på kontaktpersonen

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

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