Borgerkommunikation.FagprofessionelKontaktService (Version 1, 2023-4)

Siden opdateres automatisk til at afspejle koden.

Metoder

CreateFagprofessionelKontakt (POST /v1/FagprofessionelKontakt)

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

A-kasse

X

 

 

 

 

 

 

 

JobCenter

X

 

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.fagprofessionelkontakt.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

CreateFagprofessionelKontaktRequestDto

 

1

 

-    fagprofessionelKontaktNavn

string

Length: 1-250

1

Navn på kontakt, team eller fornavn, mellemnavn, efternavn på kontaktpersonen

-    fagprofessionelKontaktType

FagprofessionelKontaktTypeCodeList

 

1

 

-    eksternKontaktReference

string

Length: 1-250

0 - 1

Ekstern system reference på kontakten; f.eks. til AD

-    telefonnummer

string

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

0 - 1

Kontaktens telefonnummer inkl. landekode

-    mobilnummer

string

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

0 - 1

Kontaktens mobilnummer inkl. landekode

-    emailadresse

email

 

0 - 1

Kontaktens emailadresse

-    ansvarligMyndighedDto

AnsvarligMyndighedDto

 

1

 

-    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    organisationCode

string

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

1

Organisationskode.
Hvis uddannelsesinstitution så institutionsnummer. Hvis andet end myndighed så CVR-nummer

-    -    clientSystemType

ClientSystemTypeCodeList

 

1

 

-    -    cvrnummer

string

Pattern: [0-9]{8}

0 - 1

CVR-nummer på organisationen, som kontakten er tilknyttet

-    -    produktionsenhedsnummer

string

Pattern: [0-9]{10}

0 - 1

Produktionsenhedsnummer på organisationen, som kontakten er tilknyttet

-    fagprofessionelKontaktId

uuid

 

0 - 1

Identifikation af kontakt

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

CreateFagprofessionelKontaktResponseDto

 

1

 

-    fagprofessionelKontaktId

uuid

 

1

Identifikation af kontakt

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1013

User has insufficient permissions to access this webservice

User has insufficient permissions to access this webservice

1014

The submitted message is not valid

The submitted message is not valid

1101

Client certificate missing from request

Client certificate missing from request

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4413

The authoritytype of the requestheader is invalid

The authoritytype of the requestheader is invalid

60000

Fagprofessionel kontakt id findes allerede

Fagprofessionel kontakt id findes allerede

60001

For myndighedstype 11, 12, 17, 20 og 22 skal der angives CVR- og P-nummer

For myndighedstype 11, 12, 17, 20 og 22 skal der angives CVR- og P-nummer

UpdateFagprofessionelKontakt (PUT /v1/FagprofessionelKontakt)

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

A-kasse

X

 

 

 

 

 

 

 

JobCenter

X

 

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.fagprofessionelkontakt.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

UpdateFagprofessionelKontaktRequestDto

 

1

 

-    fagprofessionelKontaktNavn

string

Length: 1-250

1

Navn på kontakt, team eller fornavn, mellemnavn, efternavn på kontaktpersonen

-    fagprofessionelKontaktType

FagprofessionelKontaktTypeCodeList

 

1

 

-    eksternKontaktReference

string

Length: 1-250

0 - 1

Ekstern system reference på kontakten; f.eks. til AD

-    telefonnummer

string

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

0 - 1

Kontaktens telefonnummer inkl. landekode

-    mobilnummer

string

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

0 - 1

Kontaktens mobilnummer inkl. landekode

-    emailadresse

email

 

0 - 1

Kontaktens emailadresse

-    ansvarligMyndighedDto

AnsvarligMyndighedDto

 

1

 

-    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    organisationCode

string

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

1

Organisationskode.
Hvis uddannelsesinstitution så institutionsnummer. Hvis andet end myndighed så CVR-nummer

-    -    clientSystemType

ClientSystemTypeCodeList

 

1

 

-    -    cvrnummer

string

Pattern: [0-9]{8}

0 - 1

CVR-nummer på organisationen, som kontakten er tilknyttet

-    -    produktionsenhedsnummer

string

Pattern: [0-9]{10}

0 - 1

Produktionsenhedsnummer på organisationen, som kontakten er tilknyttet

-    fagprofessionelKontaktId

uuid

 

1

Identifikation af kontakt

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1013

User has insufficient permissions to access this webservice

User has insufficient permissions to access this webservice

1014

The submitted message is not valid

The submitted message is not valid

1101

Client certificate missing from request

Client certificate missing from request

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4413

The authoritytype of the requestheader is invalid

The authoritytype of the requestheader is invalid

60002

Fagprofessionel kontakt id findes ikke

Fagprofessionel kontakt id findes ikke

60008

Kun oprettende myndighed kan ændre en kontaktperson

Kun oprettende myndighed kan ændre en kontaktperson

60009

Emailadresse samt enten mobilnummer eller telefonnummer skal angives

Emailadresse samt enten mobilnummer eller telefonnummer skal angives

DeleteFagprofessionelKontakt (DELETE /v1/FagprofessionelKontakt)

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

A-kasse

X

 

 

 

 

 

 

 

JobCenter

X

 

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.fagprofessionelkontakt.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

DeleteFagprofessionelKontaktRequestDto

 

1

 

-    fagprofessionelKontaktId

uuid

 

1

Identifikation af kontakt

-    ansvarligMyndighed

AnsvarligMyndighedDto

 

1

 

-    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    organisationCode

string

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

1

Organisationskode.
Hvis uddannelsesinstitution så institutionsnummer. Hvis andet end myndighed så CVR-nummer

-    -    clientSystemType

ClientSystemTypeCodeList

 

1

 

-    -    cvrnummer

string

Pattern: [0-9]{8}

0 - 1

CVR-nummer på organisationen, som kontakten er tilknyttet

-    -    produktionsenhedsnummer

string

Pattern: [0-9]{10}

0 - 1

Produktionsenhedsnummer på organisationen, som kontakten er tilknyttet

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1013

User has insufficient permissions to access this webservice

User has insufficient permissions to access this webservice

1014

The submitted message is not valid

The submitted message is not valid

1101

Client certificate missing from request

Client certificate missing from request

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4413

The authoritytype of the requestheader is invalid

The authoritytype of the requestheader is invalid

60002

Fagprofessionel kontakt id findes ikke

Fagprofessionel kontakt id findes ikke

60008

Kun oprettende myndighed kan ændre en kontaktperson

Kun oprettende myndighed kan ændre en kontaktperson

GetFagprofessionelKontaktForBorger (GET /v1/FagprofessionelKontakt)

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

A-kasse

 

X

Fra 120 dage inden medlemskab til 120 dage efter medlemskab

X

 

 

 

 

JobCenter

 

X

 

X

X

X

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.fagprofessionelkontakt.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

x-civilRegistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetFagprofessionelKontaktForBorgerResponseDto

 

1

 

-    fagprofessionelleKontakter

PersonFagprofessionelKontaktDtoCollection

 

1

Liste af borgerens fagprofessionelle kontakter

-    -    PersonFagprofessionelKontaktDto

PersonFagprofessionelKontaktDto

 

0 - *

 

-    -    -    fagprofessionelKontaktNavn

string

Length: 1-250

1

Navn på kontakt, team eller fornavn, mellemnavn, efternavn på kontaktpersonen

-    -    -    fagprofessionelKontaktType

FagprofessionelKontaktTypeCodeList

 

1

 

-    -    -    eksternKontaktReference

string

Length: 1-250

0 - 1

Ekstern system reference på kontakten; f.eks. til AD

-    -    -    telefonnummer

string

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

0 - 1

Kontaktens telefonnummer inkl. landekode

-    -    -    mobilnummer

string

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

0 - 1

Kontaktens mobilnummer inkl. landekode

-    -    -    emailadresse

email

 

0 - 1

Kontaktens emailadresse

-    -    -    ansvarligMyndighedDto

AnsvarligMyndighedDto

 

1

 

-    -    -    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    -    -    organisationCode

string

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

1

Organisationskode.
Hvis uddannelsesinstitution så institutionsnummer. Hvis andet end myndighed så CVR-nummer

-    -    -    -    clientSystemType

ClientSystemTypeCodeList

 

1

 

-    -    -    -    cvrnummer

string

Pattern: [0-9]{8}

0 - 1

CVR-nummer på organisationen, som kontakten er tilknyttet

-    -    -    -    produktionsenhedsnummer

string

Pattern: [0-9]{10}

0 - 1

Produktionsenhedsnummer på organisationen, som kontakten er tilknyttet

-    -    -    fagprofessionelKontaktRelationId

uuid

 

0 - 1

Identifikation af tilknytningen mellem kontakten og borgeren. Hvis kontakten er mentor eller udslusningskoordinator er værdien null

-    -    -    fagprofessionelKontaktId

uuid

 

1

Identifikation af kontakt

-    -    -    fagprofessionelKontaktRolleType

FagprofessionelKontaktRolleTypeCodeList

 

1

 

-    -    -    startDato

date-time

 

1

Startdato og tidspunkt for tilknytningen af kontakten

-    -    -    slutDato

date-time

 

0 - 1

Slutdato og tidspunkt for tilknytningen af kontakten

-    -    -    kommentarTilBorger

string

Length: 1-250

0 - 1

Kommentar/bemærkninger til visning for borger på Jobnet

-    -    -    kommentarTilSagsbehandler

string

Length: 1-250

0 - 1

Kommentar/bemærkninger til visning for jobkonsulent i a-kasse og jobcenter

-    -    -    kontaktSkalVisesForBorger

boolean

 

1

Indikator for, om kontakten med denne rolle skal vises for borger på Jobnet.
Bemærk ikke alle roller vises på Jobnet.

-    -    -    dfdgRegistreringstidspunkt

date-time

 

1

Tidspunktet for registrering af tilknytningen mellem borger og den fagprofessionelle kontakt

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1013

User has insufficient permissions to access this webservice

User has insufficient permissions to access this webservice

1014

The submitted message is not valid

The submitted message is not valid

1101

Client certificate missing from request

Client certificate missing from request

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4413

The authoritytype of the requestheader is invalid

The authoritytype of the requestheader is invalid

GetFagprofessionelKontaktForOrganisation (GET /v1/FagprofessionelKontakt/{organisationType}/{organisationCode})

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

A-kasse

X

 

 

 

 

 

 

 

JobCenter

X

 

 

 

 

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.fagprofessionelkontakt.read

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

organisationType [Path]

OrganisationTypeCodeList

 

1

 

organisationCode [Path]

string

Pattern: [-][1]|[0-9]{1,8}

1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetFagprofessionelKontaktForAnsvarligMyndighedResponseDto

 

1

 

-    fagprofessionelleKontakter

FagprofessionelKontaktDtoCollection

 

1

Liste af fagprofessionelle kontakter, som er tilknyttet organisationen

-    -    FagprofessionelKontaktDto

FagprofessionelKontaktDto

 

0 - *

 

-    -    -    fagprofessionelKontaktNavn

string

Length: 1-250

1

Navn på kontakt, team eller fornavn, mellemnavn, efternavn på kontaktpersonen

-    -    -    fagprofessionelKontaktType

FagprofessionelKontaktTypeCodeList

 

1

 

-    -    -    eksternKontaktReference

string

Length: 1-250

0 - 1

Ekstern system reference på kontakten; f.eks. til AD

-    -    -    telefonnummer

string

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

0 - 1

Kontaktens telefonnummer inkl. landekode

-    -    -    mobilnummer

string

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

0 - 1

Kontaktens mobilnummer inkl. landekode

-    -    -    emailadresse

email

 

0 - 1

Kontaktens emailadresse

-    -    -    ansvarligMyndighedDto

AnsvarligMyndighedDto

 

1

 

-    -    -    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    -    -    organisationCode

string

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

1

Organisationskode.
Hvis uddannelsesinstitution så institutionsnummer. Hvis andet end myndighed så CVR-nummer

-    -    -    -    clientSystemType

ClientSystemTypeCodeList

 

1

 

-    -    -    -    cvrnummer

string

Pattern: [0-9]{8}

0 - 1

CVR-nummer på organisationen, som kontakten er tilknyttet

-    -    -    -    produktionsenhedsnummer

string

Pattern: [0-9]{10}

0 - 1

Produktionsenhedsnummer på organisationen, som kontakten er tilknyttet

-    -    -    fagprofessionelKontaktId

uuid

 

1

Identifikation af kontakt

-    -    -    fagprofessionelKontaktRelationer

FagprofessionelKontaktRelationDtoCollection

 

1

Liste af relationer mellem kontakten og tilknyttede borgere

-    -    -    -    FagprofessionelKontaktRelationDto

FagprofessionelKontaktRelationDto

 

0 - *

 

-    -    -    -    -    fagprofessionelKontaktRelationId

uuid

 

1

Identifikation af relationen mellem borger og fagprofessionel kontakt

-    -    -    -    -    civilRegistrationIdentifier

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000
MinLength: 1

1

Borgers personnummer

-    -    -    -    -    fagprofessionelKontaktRolleType

FagprofessionelKontaktRolleTypeCodeList

 

1

 

-    -    -    -    -    dfdgRegistreringstidspunkt

date-time

 

1

Tidspunktet for registrering af tilknytningen mellem borger og den fagprofessionelle kontakt

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1013

User has insufficient permissions to access this webservice

User has insufficient permissions to access this webservice

1014

The submitted message is not valid

The submitted message is not valid

1101

Client certificate missing from request

Client certificate missing from request

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4413

The authoritytype of the requestheader is invalid

The authoritytype of the requestheader is invalid

CreateFagprofessionelKontaktForBorger (POST /v1/FagprofessionelKontakt/relation)

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

A-kasse

 

X

 

 

 

 

 

 

JobCenter

 

X

 

 

X

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.fagprofessionelkontakt.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

x-civilRegistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

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

CreateFagprofessionelKontaktForBorgerRequestDto

 

1

 

-    fagprofessionelKontaktId

uuid

 

1

Identifikation af kontakt

-    fagprofessionelKontaktRolleType

FagprofessionelKontaktRolleTypeCodeList

 

1

 

-    startDato

date-time

 

1

Startdato og tidspunkt for tilknytningen af kontakten

-    slutDato

date-time

 

0 - 1

Slutdato og tidspunkt for tilknytningen af kontakten

-    kommentarTilBorger

string

Length: 1-250

0 - 1

Kommentar/bemærkninger til visning for borger på Jobnet

-    kommentarTilSagsbehandler

string

Length: 1-250

0 - 1

Kommentar/bemærkninger til visning for jobkonsulent i a-kasse og jobcenter

-    kontaktSkalVisesForBorger

boolean

 

1

Indikator for, om kontakten med denne rolle skal vises for borger på Jobnet.
Bemærk ikke alle roller vises på Jobnet.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

CreateFagprofessionelKontaktForBorgerResponseDto

 

1

 

-    fagprofessionelKontaktRelationId

uuid

 

1

Identifikation af relationen mellem kontakten og borger. Hvis kontakten er mentor eller udslusningskoordinator er værdien null

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

2001

Invalid CodeList name

Invalid CodeList name

1013

User has insufficient permissions to access this webservice

User has insufficient permissions to access this webservice

1014

The submitted message is not valid

The submitted message is not valid

1101

Client certificate missing from request

Client certificate missing from request

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4413

The authoritytype of the requestheader is invalid

The authoritytype of the requestheader is invalid

60002

Fagprofessionel kontakt id findes ikke

Fagprofessionel kontakt id findes ikke

60003

Rollerne 2 og 15 kan kun oprettes og opdateres via ActivityService

Rollerne 2 og 15 kan kun oprettes og opdateres via ActivityService

60004

Slutdato må ikke være historisk

Slutdato må ikke være historisk

60005

Slutdato må ikke være før startdato

Slutdato må ikke være før startdato

60011

Emailadresse og enten telefonnummer eller mobilnummer skal angives for rolle 32

Emailadresse og enten telefonnummer eller mobilnummer skal angives for rolle 32

60006

Unknown cpr

Unknown cpr

60007

The person with specified cpr is dead

The person with specified cpr is dead

UpdateFagprofessionelKontaktForBorger (PUT /v1/FagprofessionelKontakt/relation)

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

A-kasse

 

X

 

 

 

 

 

 

JobCenter

 

X

 

 

X

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.fagprofessionelkontakt.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

x-civilRegistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

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

UpdateFagprofessionelKontaktForBorgerRequestDto

 

1

 

-    fagprofessionelKontaktId

uuid

 

1

Identifikation af kontakt

-    fagprofessionelKontaktRolleType

FagprofessionelKontaktRolleTypeCodeList

 

1

 

-    startDato

date-time

 

1

Startdato og tidspunkt for tilknytningen af kontakten

-    slutDato

date-time

 

0 - 1

Slutdato og tidspunkt for tilknytningen af kontakten

-    kommentarTilBorger

string

Length: 1-250

0 - 1

Kommentar/bemærkninger til visning for borger på Jobnet

-    kommentarTilSagsbehandler

string

Length: 1-250

0 - 1

Kommentar/bemærkninger til visning for jobkonsulent i a-kasse og jobcenter

-    kontaktSkalVisesForBorger

boolean

 

1

Indikator for, om kontakten med denne rolle skal vises for borger på Jobnet.
Bemærk ikke alle roller vises på Jobnet.

-    fagprofessionelKontaktRelationId

uuid

 

1

Identifikation af tilknytningen mellem kontaktperson og borger. Hvis kontaktpersonen er mentor eller udslusningskoordinator er værdien null.

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

2001

Invalid CodeList name

Invalid CodeList name

1013

User has insufficient permissions to access this webservice

User has insufficient permissions to access this webservice

1014

The submitted message is not valid

The submitted message is not valid

1101

Client certificate missing from request

Client certificate missing from request

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

4413

The authoritytype of the requestheader is invalid

The authoritytype of the requestheader is invalid

60002

Fagprofessionel kontakt id findes ikke

Fagprofessionel kontakt id findes ikke

60003

Rollerne 2 og 15 kan kun oprettes og opdateres via ActivityService

Rollerne 2 og 15 kan kun oprettes og opdateres via ActivityService

60004

Slutdato må ikke være historisk

Slutdato må ikke være historisk

60005

Slutdato må ikke være før startdato

Slutdato må ikke være før startdato

60011

Emailadresse og enten telefonnummer eller mobilnummer skal angives for rolle 32

Emailadresse og enten telefonnummer eller mobilnummer skal angives for rolle 32

60006

Unknown cpr

Unknown cpr

60007

The person with specified cpr is dead

The person with specified cpr is dead

60017

Fagprofessionel kontakt på borger må ikke opdateres, så den overlapper anden kontakt med samme rolle

Fagprofessionel kontakt på borger må ikke opdateres, så den overlapper anden kontakt med samme rolle

CreateFagprofessionelleKontakter (POST /v1/FagprofessionelKontakt/action/masseopdatering)

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

JobCenter

 

X

 

 

X

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.fagprofessionelkontakt.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

OpdateringFagprofessionelleKontakterRequestDto

 

1

 

-    fagprofessionelKontaktRelationer

MassePersonFagprofessionelKontaktDtoCollection

 

1

Liste af relationener mellem borgere og fagprofessionelle kontakter

-    -    MassePersonFagprofessionelKontaktDto

MassePersonFagprofessionelKontaktDto

 

0 - *

 

-    -    -    civilRegistrationIdentifier

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000
MinLength: 1

1

Borgers personnummer

-    -    -    fagprofessionelKontaktRelationId

uuid

 

1

Identifikation af relationen mellem borger og fagprofessionel kontakt

-    fagprofessionelKontakt

MasseFagprofessionelKontaktDto

 

1

 

-    -    fagprofessionelKontaktId

uuid

 

0 - 1

Identifikation af kontakt

-    -    fagprofessionelKontaktNavn

string

Length: 1-250

1

Navn på kontakt, team eller fornavn, mellemnavn, efternavn på kontaktpersonen

-    -    fagprofessionelKontaktType

FagprofessionelKontaktTypeCodeList

 

0 - 1

 

-    -    eksternKontaktReference

string

Length: 1-250

0 - 1

Ekstern system reference på kontakten; f.eks. til AD

-    -    fagprofessionelKontaktRolleType

FagprofessionelKontaktRolleTypeCodeList

 

1

 

-    -    telefonnummer

string

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

0 - 1

Kontaktens telefonnummer inkl. landekode

-    -    mobilnummer

string

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

0 - 1

Kontaktens mobilnummer inkl. landekode

-    -    emailadresse

email

 

0 - 1

Kontaktens emailadresse

-    -    startDato

date-time

 

1

Startdato og tidspunkt for tilknytningen af kontakten

-    -    slutDato

date-time

 

0 - 1

Slutdato og tidspunkt for tilknytningen af kontakten

-    -    kommentarTilBorger

string

Length: 1-250

0 - 1

Kommentar/bemærkninger til visning for borger på Jobnet

-    -    kommentarTilSagsbehandler

string

Length: 1-250

0 - 1

Kommentar/bemærkninger til visning for jobkonsulent i a-kasse og jobcenter

-    -    kontaktSkalVisesForBorger

boolean

 

1

Indikator for, om kontakten med denne rolle skal vises for borger på Jobnet.
Bemærk ikke alle roller vises på Jobnet.

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1013

User has insufficient permissions to access this webservice

User has insufficient permissions to access this webservice

1014

The submitted message is not valid

The submitted message is not valid

1101

Client certificate missing from request

Client certificate missing from request

2001

Invalid CodeList name

Invalid CodeList name

4413

The authoritytype of the requestheader is invalid

The authoritytype of the requestheader is invalid

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

60003

Rollerne 2 og 15 kan kun oprettes og opdateres via ActivityService

Rollerne 2 og 15 kan kun oprettes og opdateres via ActivityService

60004

Slutdato må ikke være historisk

Slutdato må ikke være historisk

60005

Slutdato må ikke være før startdato

Slutdato må ikke være før startdato

60006

Unknown cpr

Unknown cpr

60007

The person with specified cpr is dead

The person with specified cpr is dead

60011

Emailadresse og enten telefonnummer eller mobilnummer skal angives for rolle 32

Emailadresse og enten telefonnummer eller mobilnummer skal angives for rolle 32

60012

Id på ekstern kontaktreference eksisiterer allerede

Id på ekstern kontaktreference eksisiterer allerede

60013

Id på fagproffessionel og/eller ekstern kontaktreference matcher ikke eksisterende opl

Id på fagproffessionel og/eller ekstern kontaktreference matcher ikke eksisterende opl

60016

Fagprofessionel kontakt kan kun opdateres via ActivityService

Fagprofessionel kontakt kan kun opdateres via ActivityService

UpdateFagprofessionelleKontakter (PUT /v1/FagprofessionelKontakt/action/masseopdatering)

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

JobCenter

 

X

 

 

X

 

 

 

STAR

X

 

 

 

 

 

 

 

Scope

borgerkommunikation.fagprofessionelkontakt.write

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

OpdateringFagprofessionelleKontakterRequestDto

 

1

 

-    fagprofessionelKontaktRelationer

MassePersonFagprofessionelKontaktDtoCollection

 

1

Liste af relationener mellem borgere og fagprofessionelle kontakter

-    -    MassePersonFagprofessionelKontaktDto

MassePersonFagprofessionelKontaktDto

 

0 - *

 

-    -    -    civilRegistrationIdentifier

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000
MinLength: 1

1

Borgers personnummer

-    -    -    fagprofessionelKontaktRelationId

uuid

 

1

Identifikation af relationen mellem borger og fagprofessionel kontakt

-    fagprofessionelKontakt

MasseFagprofessionelKontaktDto

 

1

 

-    -    fagprofessionelKontaktId

uuid

 

0 - 1

Identifikation af kontakt

-    -    fagprofessionelKontaktNavn

string

Length: 1-250

1

Navn på kontakt, team eller fornavn, mellemnavn, efternavn på kontaktpersonen

-    -    fagprofessionelKontaktType

FagprofessionelKontaktTypeCodeList

 

0 - 1

 

-    -    eksternKontaktReference

string

Length: 1-250

0 - 1

Ekstern system reference på kontakten; f.eks. til AD

-    -    fagprofessionelKontaktRolleType

FagprofessionelKontaktRolleTypeCodeList

 

1

 

-    -    telefonnummer

string

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

0 - 1

Kontaktens telefonnummer inkl. landekode

-    -    mobilnummer

string

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

0 - 1

Kontaktens mobilnummer inkl. landekode

-    -    emailadresse

email

 

0 - 1

Kontaktens emailadresse

-    -    startDato

date-time

 

1

Startdato og tidspunkt for tilknytningen af kontakten

-    -    slutDato

date-time

 

0 - 1

Slutdato og tidspunkt for tilknytningen af kontakten

-    -    kommentarTilBorger

string

Length: 1-250

0 - 1

Kommentar/bemærkninger til visning for borger på Jobnet

-    -    kommentarTilSagsbehandler

string

Length: 1-250

0 - 1

Kommentar/bemærkninger til visning for jobkonsulent i a-kasse og jobcenter

-    -    kontaktSkalVisesForBorger

boolean

 

1

Indikator for, om kontakten med denne rolle skal vises for borger på Jobnet.
Bemærk ikke alle roller vises på Jobnet.

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1013

User has insufficient permissions to access this webservice

User has insufficient permissions to access this webservice

1014

The submitted message is not valid

The submitted message is not valid

1101

Client certificate missing from request

Client certificate missing from request

2001

Invalid CodeList name

Invalid CodeList name

4413

The authoritytype of the requestheader is invalid

The authoritytype of the requestheader is invalid

4575

You are not authorized to execute the operation

You are not authorized to execute the operation

60002

Fagprofessionel kontakt id findes ikke

Fagprofessionel kontakt id findes ikke

60003

Rollerne 2 og 15 kan kun oprettes og opdateres via ActivityService

Rollerne 2 og 15 kan kun oprettes og opdateres via ActivityService

60004

Slutdato må ikke være historisk

Slutdato må ikke være historisk

60005

Slutdato må ikke være før startdato

Slutdato må ikke være før startdato

60006

Unknown cpr

Unknown cpr

60007

The person with specified cpr is dead

The person with specified cpr is dead

60011

Emailadresse og enten telefonnummer eller mobilnummer skal angives for rolle 32

Emailadresse og enten telefonnummer eller mobilnummer skal angives for rolle 32

60013

Id på fagproffessionel og/eller ekstern kontaktreference matcher ikke eksisterende opl

Id på fagproffessionel og/eller ekstern kontaktreference matcher ikke eksisterende opl

60014

Id på ekstern kontaktreference findes ikke

Id på ekstern kontaktreference findes ikke

60016

Fagprofessionel kontakt kan kun opdateres via ActivityService

Fagprofessionel kontakt kan kun opdateres via ActivityService