Siden opdateres automatisk til at afspejle koden.
Metoder
CreateKontaktperson (POST /v1/Kontaktperson/{id})
Opretter en 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 | |
|---|---|---|---|---|---|---|---|---|
| STAR | X |
Scope
virksomhedsindsats.kontaktperson.write
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| id [Path] | uuid | 0 - 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 | Kontaktperson for en virksomhed. | |
| - - fornavne | string | Length: 1-50 | 1 | Fornavn(e). |
| - - efternavn | string | Length: 1-50 | 1 | Efternavn. |
| - - titel | string | MaxLength: 50 | 0 - 1 | Titel. |
| - - emailadresse | MaxLength: 254 | 0 - 1 | E-mailadresse.
Feltet er påkrævet, hvis Telefonnummer ikke er sat. | |
| - - telefonnummer | tel | MaxLength: 15 | 0 - 1 | Telefonnummer.
Feltet er påkrævet, hvis Emailadresse ikke er sat. |
| - - cvrNummer | string | Pattern: [0-9]{8} MinLength: 1 | 1 | CVR-nummer på virksomheden som kontaktpersonen tilhører. |
| - - pNumre | stringCollection | 1 | P-numre på produktionsenheder som kontaktpersonen tilhører. | |
| - - - string | string | 0 - * | ||
| - - professioneltUuid | uuid | 0 - 1 | UUID fra NemLog-in (i SAML) ved login med en erhvervsidentitet.
Fremtidigt vil det være en del af JWT når man som bruger i JobAG logger ind i JobAG. |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | CreateKontaktpersonResponseDto | 1 | ||
| - id | uuid | 1 | Kontaktperson id. |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
| 120503 | Produktionsenheden blev ikke fundet. | Produktionsenheden blev ikke fundet. |
| 120507 | Produktionsenheden tilhører ikke den angivne virksomhed. | Produktionsenheden tilhører ikke den angivne virksomhed. |
| 120508 | Der skal være angivet et telefonnummer eller en e-mailadresse for en kontaktperson. | Der skal være angivet et telefonnummer eller en e-mailadresse for en kontaktperson. |
| 120518 | Der findes allerede en kontaktperson med det angivne id. | Der findes allerede en kontaktperson med det angivne id. |
| 120519 | Der findes allerede en kontaktperson med det angivne professioneltUuid. | Der findes allerede en kontaktperson med det angivne professioneltUuid. |
GetKontaktperson (GET /v1/Kontaktperson/{id})
Finder en 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 | |
|---|---|---|---|---|---|---|---|---|
| STAR | X |
Scope
virksomhedsindsats.kontaktperson.read
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| id [Path] | uuid | 1 |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetKontaktpersonResponseDto | 1 | ||
| - kontaktperson | KontaktpersonGetDto | 1 | Kontaktperson for en virksomhed. | |
| - - fornavne | string | Length: 1-50 | 1 | Fornavn(e). |
| - - efternavn | string | Length: 1-50 | 1 | Efternavn. |
| - - titel | string | MaxLength: 50 | 0 - 1 | Titel. |
| - - emailadresse | MaxLength: 254 | 0 - 1 | E-mailadresse.
Feltet er påkrævet, hvis Telefonnummer ikke er sat. | |
| - - telefonnummer | tel | MaxLength: 15 | 0 - 1 | Telefonnummer.
Feltet er påkrævet, hvis Emailadresse ikke er sat. |
| - - cvrNummer | string | Pattern: [0-9]{8} MinLength: 1 | 1 | CVR-nummer på virksomheden som kontaktpersonen tilhører. |
| - - pNumre | stringCollection | 1 | P-numre på produktionsenheder som kontaktpersonen tilhører. | |
| - - - string | string | 0 - * | ||
| - - professioneltUuid | uuid | 0 - 1 | UUID fra NemLog-in (i SAML) ved login med en erhvervsidentitet.
Fremtidigt vil det være en del af JWT når man som bruger i JobAG logger ind i JobAG. | |
| - - id | uuid | 1 | Kontaktperson id. |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 120504 | Kontaktpersonen blev ikke fundet. | Kontaktpersonen blev ikke fundet. |
UpdateKontaktperson (PUT /v1/Kontaktperson/{id})
Opdaterer en 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 | |
|---|---|---|---|---|---|---|---|---|
| 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 | UpdateKontaktpersonRequestDto | 1 | ||
| - kontaktperson | KontaktpersonDto | 1 | Kontaktperson for en virksomhed. | |
| - - fornavne | string | Length: 1-50 | 1 | Fornavn(e). |
| - - efternavn | string | Length: 1-50 | 1 | Efternavn. |
| - - titel | string | MaxLength: 50 | 0 - 1 | Titel. |
| - - emailadresse | MaxLength: 254 | 0 - 1 | E-mailadresse.
Feltet er påkrævet, hvis Telefonnummer ikke er sat. | |
| - - telefonnummer | tel | MaxLength: 15 | 0 - 1 | Telefonnummer.
Feltet er påkrævet, hvis Emailadresse ikke er sat. |
| - - cvrNummer | string | Pattern: [0-9]{8} MinLength: 1 | 1 | CVR-nummer på virksomheden som kontaktpersonen tilhører. |
| - - pNumre | stringCollection | 1 | P-numre på produktionsenheder som kontaktpersonen tilhører. | |
| - - - string | string | 0 - * | ||
| - - professioneltUuid | uuid | 0 - 1 | UUID fra NemLog-in (i SAML) ved login med en erhvervsidentitet.
Fremtidigt vil det være en del af JWT når man som bruger i JobAG logger ind i JobAG. |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 120501 | Virksomheden blev ikke fundet. | Virksomheden blev ikke fundet. |
| 120504 | Kontaktpersonen blev ikke fundet. | Kontaktpersonen blev ikke fundet. |
| 120503 | Produktionsenheden blev ikke fundet. | Produktionsenheden blev ikke fundet. |
| 120507 | Produktionsenheden tilhører ikke den angivne virksomhed. | Produktionsenheden tilhører ikke den angivne virksomhed. |
| 120508 | Der skal være angivet et telefonnummer eller en e-mailadresse for en kontaktperson. | Der skal være angivet et telefonnummer eller en e-mailadresse for en kontaktperson. |
| 120519 | Der findes allerede en kontaktperson med det angivne professioneltUuid. | Der findes allerede en kontaktperson med det angivne professioneltUuid. |
| 120900 |
DeleteKontaktperson (DELETE /v1/Kontaktperson/{id})
Sletter en 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 | |
|---|---|---|---|---|---|---|---|---|
| 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 |
|---|---|---|
| 120504 | Kontaktpersonen blev ikke fundet. | Kontaktpersonen blev ikke fundet. |
GetKontaktpersonByProfessioneltUuid (GET /v1/Kontaktperson/professionaluuid/{professioneltUuid})
Finder en kontaktperson ud fra professionelt UUID (NemLog-in).
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 |
|---|---|---|---|---|
| professioneltUuid [Path] | uuid | 1 |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetKontaktpersonByProfessioneltUuidResponseDto | 1 | ||
| - kontaktperson | KontaktpersonGetDto | 1 | Kontaktperson for en virksomhed. | |
| - - fornavne | string | Length: 1-50 | 1 | Fornavn(e). |
| - - efternavn | string | Length: 1-50 | 1 | Efternavn. |
| - - titel | string | MaxLength: 50 | 0 - 1 | Titel. |
| - - emailadresse | MaxLength: 254 | 0 - 1 | E-mailadresse.
Feltet er påkrævet, hvis Telefonnummer ikke er sat. | |
| - - telefonnummer | tel | MaxLength: 15 | 0 - 1 | Telefonnummer.
Feltet er påkrævet, hvis Emailadresse ikke er sat. |
| - - cvrNummer | string | Pattern: [0-9]{8} MinLength: 1 | 1 | CVR-nummer på virksomheden som kontaktpersonen tilhører. |
| - - pNumre | stringCollection | 1 | P-numre på produktionsenheder som kontaktpersonen tilhører. | |
| - - - string | string | 0 - * | ||
| - - professioneltUuid | uuid | 0 - 1 | UUID fra NemLog-in (i SAML) ved login med en erhvervsidentitet.
Fremtidigt vil det være en del af JWT når man som bruger i JobAG logger ind i JobAG. | |
| - - id | uuid | 1 | Kontaktperson id. |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 120504 | Kontaktpersonen blev ikke fundet. | Kontaktpersonen blev ikke fundet. |
SoegKontaktpersoner (GET /v1/Kontaktperson/soeg)
Fremsøger kontaktpersoner ud fra parametre.
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 |
|---|---|---|---|---|
| navn [Query] | string | Length: 3-50 | 0 - 1 | Del af kontaktpersonens navn. |
| telefonnummer [Query] | string | Length: 3-50 | 0 - 1 | Del af kontaktpersonens telefonnummer. |
| emailadresse [Query] | string | Length: 3-254 | 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. |
| sidestoerrelse [Query] | int32 | MinInclusive: 1 MaxInclusive: 1000 | 0 - 1 | Det maksimale antal returnerede søgeresultater.
Angives denne ikke sættes sidestørrelsen til 100. |
| sidenummer [Query] | int32 | MinInclusive: 0 MaxInclusive: 2147483647 | 0 - 1 | Sidenummer definerer hvilken side i resultatsættet, der returneres.
Angives denne ikke, returneres første side. |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | SoegKontaktpersonerResponseDto | 1 | ||
| - soegeresultater | KontaktpersonGetDtoCollection | 1 | Søgeresultater. | |
| - - KontaktpersonGetDto | KontaktpersonGetDto | 0 - * | ||
| - - - fornavne | string | Length: 1-50 | 1 | Fornavn(e). |
| - - - efternavn | string | Length: 1-50 | 1 | Efternavn. |
| - - - titel | string | MaxLength: 50 | 0 - 1 | Titel. |
| - - - emailadresse | MaxLength: 254 | 0 - 1 | E-mailadresse.
Feltet er påkrævet, hvis Telefonnummer ikke er sat. | |
| - - - telefonnummer | tel | MaxLength: 15 | 0 - 1 | Telefonnummer.
Feltet er påkrævet, hvis Emailadresse ikke er sat. |
| - - - cvrNummer | string | Pattern: [0-9]{8} MinLength: 1 | 1 | CVR-nummer på virksomheden som kontaktpersonen tilhører. |
| - - - pNumre | stringCollection | 1 | P-numre på produktionsenheder som kontaktpersonen tilhører. | |
| - - - - string | string | 0 - * | ||
| - - - professioneltUuid | uuid | 0 - 1 | UUID fra NemLog-in (i SAML) ved login med en erhvervsidentitet.
Fremtidigt vil det være en del af JWT når man som bruger i JobAG logger ind i JobAG. | |
| - - - id | uuid | 1 | Kontaktperson id. |
Fejlkoder
Ingen fejlkoder