Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Siden opdateres automatisk til at afspejle koden.

Metoder

CreateKontaktperson (POST /v1/Kontaktperson)

Opretter en kontaktperson.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.kontaktperson.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-requestId [Header]string1Unikt 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
requestBodyCreateKontaktpersonRequestDto1
-    kontaktpersonKontaktpersonDto1Kontaktperson for en virksomhed.
-    -    fornavnestringLength: 1-501Fornavn(e).
-    -    efternavnstringLength: 1-501Efternavn.
-    -    titelstringMaxLength: 500 - 1Titel.
-    -    emailadresseemailMaxLength: 2540 - 1E-mailadresse.
Feltet er påkrævet, hvis Telefonnummer ikke er sat.
-    -    telefonnummertelMaxLength: 150 - 1Telefonnummer.
Feltet er påkrævet, hvis Emailadresse ikke er sat.
-    -    cvrNummerstringPattern: [0-9]{8}
MinLength: 1
1CVR-nummer på virksomheden som kontaktpersonen tilhører.
-    -    pNumrestringCollection1P-numre på produktionsenheder som kontaktpersonen tilhører.
-    -    -    stringstring0 - *
-    -    professioneltUuiduuid0 - 1UUID 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.
-    iduuid0 - 1Kontaktperson id.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseCreateKontaktpersonResponseDto1
-    iduuid1Kontaktperson id.

Fejlkoder

FejlkodeFejltekstBeskrivelse
120500Virksomheden blev ikke fundet.Virksomheden blev ikke fundet.
120502Produktionsenheden blev ikke fundet.Produktionsenheden blev ikke fundet.
120504Produktionsenheden tilhører ikke den angivne virksomhed.Produktionsenheden tilhører ikke den angivne virksomhed.
120509Der 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.
120801Der findes allerede en kontaktperson med det angivne 'id'.Der findes allerede en kontaktperson med det angivne 'id'.
120802Der 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 borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.kontaktperson.read

Input

ElementTypeDetaljerForekomstBeskrivelse
id [Path]uuid1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetKontaktpersonResponseDto1
-    kontaktpersonKontaktpersonGetDto1Kontaktperson for en virksomhed.
-    -    fornavnestringLength: 1-501Fornavn(e).
-    -    efternavnstringLength: 1-501Efternavn.
-    -    titelstringMaxLength: 500 - 1Titel.
-    -    emailadresseemailMaxLength: 2540 - 1E-mailadresse.
Feltet er påkrævet, hvis Telefonnummer ikke er sat.
-    -    telefonnummertelMaxLength: 150 - 1Telefonnummer.
Feltet er påkrævet, hvis Emailadresse ikke er sat.
-    -    cvrNummerstringPattern: [0-9]{8}
MinLength: 1
1CVR-nummer på virksomheden som kontaktpersonen tilhører.
-    -    pNumrestringCollection1P-numre på produktionsenheder som kontaktpersonen tilhører.
-    -    -    stringstring0 - *
-    -    professioneltUuiduuid0 - 1UUID 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.
-    -    iduuid1Kontaktperson id.
-    -    oprettetTidspunktdate-time1Tidspunkt for oprettelse.
-    -    opdateretTidspunktdate-time1Tidspunkt for seneste opdatering.

Fejlkoder

FejlkodeFejltekstBeskrivelse
120800Kontaktpersonen blev ikke fundet.Kontaktpersonen blev ikke fundet.

UpdateKontaktperson (PUT /v1/Kontaktperson/{id})

Opdaterer en kontaktperson.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.kontaktperson.write

Input

ElementTypeDetaljerForekomstBeskrivelse
id [Path]uuid1
x-requestId [Header]string1Unikt 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
requestBodyUpdateKontaktpersonRequestDto1
-    kontaktpersonKontaktpersonDto1Kontaktperson for en virksomhed.
-    -    fornavnestringLength: 1-501Fornavn(e).
-    -    efternavnstringLength: 1-501Efternavn.
-    -    titelstringMaxLength: 500 - 1Titel.
-    -    emailadresseemailMaxLength: 2540 - 1E-mailadresse.
Feltet er påkrævet, hvis Telefonnummer ikke er sat.
-    -    telefonnummertelMaxLength: 150 - 1Telefonnummer.
Feltet er påkrævet, hvis Emailadresse ikke er sat.
-    -    cvrNummerstringPattern: [0-9]{8}
MinLength: 1
1CVR-nummer på virksomheden som kontaktpersonen tilhører.
-    -    pNumrestringCollection1P-numre på produktionsenheder som kontaktpersonen tilhører.
-    -    -    stringstring0 - *
-    -    professioneltUuiduuid0 - 1UUID 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

FejlkodeFejltekstBeskrivelse
120500Virksomheden blev ikke fundet.Virksomheden blev ikke fundet.
120800Kontaktpersonen blev ikke fundet.Kontaktpersonen blev ikke fundet.
120502Produktionsenheden blev ikke fundet.Produktionsenheden blev ikke fundet.
120504Produktionsenheden tilhører ikke den angivne virksomhed.Produktionsenheden tilhører ikke den angivne virksomhed.
120509Der 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.
120802Der findes allerede en kontaktperson med det angivne 'professioneltUuid'.Der findes allerede en kontaktperson med det angivne 'professioneltUuid'.
120803CVR-nummeret, som kontaktpersonen er tilknyttet til, kan ikke ændres.CVR-nummeret, som kontaktpersonen er tilknyttet til, kan ikke ændres.

DeleteKontaktperson (DELETE /v1/Kontaktperson/{id})

Sletter en kontaktperson.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.kontaktperson.write

Input

ElementTypeDetaljerForekomstBeskrivelse
id [Path]uuid1
x-requestId [Header]string1Unikt 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

FejlkodeFejltekstBeskrivelse
120800Kontaktpersonen 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 borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.kontaktperson.read

Input

ElementTypeDetaljerForekomstBeskrivelse
professioneltUuid [Path]uuid1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetKontaktpersonByProfessioneltUuidResponseDto1
-    kontaktpersonKontaktpersonGetDto1Kontaktperson for en virksomhed.
-    -    fornavnestringLength: 1-501Fornavn(e).
-    -    efternavnstringLength: 1-501Efternavn.
-    -    titelstringMaxLength: 500 - 1Titel.
-    -    emailadresseemailMaxLength: 2540 - 1E-mailadresse.
Feltet er påkrævet, hvis Telefonnummer ikke er sat.
-    -    telefonnummertelMaxLength: 150 - 1Telefonnummer.
Feltet er påkrævet, hvis Emailadresse ikke er sat.
-    -    cvrNummerstringPattern: [0-9]{8}
MinLength: 1
1CVR-nummer på virksomheden som kontaktpersonen tilhører.
-    -    pNumrestringCollection1P-numre på produktionsenheder som kontaktpersonen tilhører.
-    -    -    stringstring0 - *
-    -    professioneltUuiduuid0 - 1UUID 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.
-    -    iduuid1Kontaktperson id.
-    -    oprettetTidspunktdate-time1Tidspunkt for oprettelse.
-    -    opdateretTidspunktdate-time1Tidspunkt for seneste opdatering.

Fejlkoder

FejlkodeFejltekstBeskrivelse
120800Kontaktpersonen blev ikke fundet.Kontaktpersonen blev ikke fundet.

SoegKontaktpersoner (GET /v1/Kontaktperson/soeg)

Fremsøger kontaktpersoner ud fra parametre.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
STARX

Scope

virksomhedsindsats.kontaktperson.read

Input

ElementTypeDetaljerForekomstBeskrivelse
navn [Query]stringLength: 3-500 - 1Del af kontaktpersonens navn.
telefonnummer [Query]stringLength: 3-500 - 1Del af kontaktpersonens telefonnummer.
emailadresse [Query]stringLength: 3-2540 - 1Del af kontaktpersonens e-mailadresse.
cvrNummer [Query]stringPattern: [0-9]{8}0 - 1CVR-nummer på virksomheden som kontaktpersonen tilhører.
pNummer [Query]stringPattern: [0-9]{10}0 - 1P-nummer på produktionsenheden som kontaktpersonen tilhører.
sidestoerrelse [Query]int32MinInclusive: 1
MaxInclusive: 1000
0 - 1Det maksimale antal returnerede søgeresultater.
Angives denne ikke sættes sidestørrelsen til 100.
sidenummer [Query]int32MinInclusive: 1
MaxInclusive: 2147483647
0 - 1Sidenummer definerer hvilken side i resultatsættet, der returneres.
Angives denne ikke, returneres første side.

Output

ElementTypeDetaljerForekomstBeskrivelse
responseSoegKontaktpersonerResponseDto1
-    soegeresultaterKontaktpersonGetDtoCollection1Søgeresultater.
-    -    KontaktpersonGetDtoKontaktpersonGetDto0 - *
-    -    -    fornavnestringLength: 1-501Fornavn(e).
-    -    -    efternavnstringLength: 1-501Efternavn.
-    -    -    titelstringMaxLength: 500 - 1Titel.
-    -    -    emailadresseemailMaxLength: 2540 - 1E-mailadresse.
Feltet er påkrævet, hvis Telefonnummer ikke er sat.
-    -    -    telefonnummertelMaxLength: 150 - 1Telefonnummer.
Feltet er påkrævet, hvis Emailadresse ikke er sat.
-    -    -    cvrNummerstringPattern: [0-9]{8}
MinLength: 1
1CVR-nummer på virksomheden som kontaktpersonen tilhører.
-    -    -    pNumrestringCollection1P-numre på produktionsenheder som kontaktpersonen tilhører.
-    -    -    -    stringstring0 - *
-    -    -    professioneltUuiduuid0 - 1UUID 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.
-    -    -    iduuid1Kontaktperson id.
-    -    -    oprettetTidspunktdate-time1Tidspunkt for oprettelse.
-    -    -    opdateretTidspunktdate-time1Tidspunkt for seneste opdatering.

Fejlkoder

Ingen fejlkoder

  • No labels