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

« Previous Version 41 Current »

Metoder

CreateKontaktgruppe (POST /v1/personVisitering/kontaktgrupper){kontaktgruppeId}

Metoden bruges til at registrere (oprette) borgers kontaktgruppe

Operation

Endpoint

POST

/v1/personVisitering/kontaktgrupper

Tilladte organisationer

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

A-kasse

JobCenter

X

X

Kommune

X

X

STAR

X

Input

Elemenent

Type

Detaljer

Forekomst

Beskrivelse

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

Borgers cpr nummer

CreateKontaktgruppeRequest
(requestBody)

CreateKontaktgruppeRequestDto

1

Oplysninger om borgers kontaktgruppe

  • kontaktgruppeType

(ContactGroupTypeIdentifier)

VisiteringOgStatus.KontaktgruppeTypeCodeList [UDV]

(CodeListItemIdentifierType)

MaxInclusive: 10000000

1

Kontaktgruppen, som den ledige har på beregnings-tidspunkt.

  • Haendelsestidspunkt

(ContactGroupEventTime)

DateTime

(dateTime)

 

0 - 1

Kontaktgruppens hændelsestidspunkt i eksternt system.

  • Starttidspunkt

(ContactGroupStartTime)

DateTime

(dateTime)

 

1

Starttidspunkt for borgers kontaktgruppe.

  • Sluttidspunkt

(ContactGroupEndTime)

DateTime

(dateTime)

 

0 - 1

Sluttidspunkt for den borgers kontaktgruppe.

Output

Task<Guid> som er et unikt id for borgerens kontaktgruppe (kontaktgruppeId).

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetKontaktgruppeIdDto

 

1

Information om den oprettede kontaktgruppe

  • kontaktgruppeId

GUID

0 - 1

GUID på den oprettede kontaktgruppe

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1001

Ikke validt personnummer

Det angivne personnummer er enten for langt eller for kort eller indeholder data der ikke kan fortolkes som en dato

1010

Ukendt cpr nr

Personnummeret findes ikke i DFDG

1014

Request validerer ikke

Request validerer ikke

4404

Der findes ikke borger i DFDG med det angive cpr nr

(The person with specified cpr does not exist)

Der findes ikke borger i DFDG med det angive cpr nr

(The person with specified cpr does not exist)

4405

Personen med det angivne cpr nr er død

Personen med det angivne cpr nr er død

4511

The External operator is not allowed to view data for the person

The External operator is not allowed to view data for the person

4575

You are not authorized

You are not authorized to execute the operation

4644

Borger har allerede en åben kontaktgruppe

(This Client has an open existing contactgroup)

Borger har allerede en åben kontaktgruppe

(This Client has an open existing contactgroup)

4645

Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og fravær

(This person has a absenceregistration that conflicts with this Contactgroup)

Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og fravær

(This person has a absenceregistration that conflicts with this Contactgroup)

4654

This person has an absenceregistration that conflicts with the submitted personcategory

This person has an absenceregistration that conflicts with the submitted personcategory

4655

This person must be unenrolled before this personcategory value can be applied

This person must be unenrolled before this personcategory value can be applied

4656

This personcategory is not coherent with the person's enrollment

This personcategory is not coherent with the person's enrollment

4675

Den angivne kontaktgruppetype er ugyldig

(The ContactGroupTypeIdentifier is invalid)

Den angivne kontaktgruppetype er ugyldig

(The ContactGroupTypeIdentifier is invalid)

4703

Startdatoen skal være i dag

(The submitted startdate have to be present)

Startdatoen skal være i dag

(The submitted startdate have to be present)

4731

Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og tilmelding

(Registration is not allowed because of an illegal combination of the contactgroup and enrollment)

Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og tilmelding

(Registration is not allowed because of an illegal combination of the contactgroup and enrollment)

4919

Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende

(The contact group can not be ended due to an active enrollment)

Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende

(The contact group can not be ended due to an active enrollment)

6005

The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader

The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader

6033

Kontaktgruppen er i uoverensstemmelse med borgers alder

(ContactGroup is not coherent with age)

Kontaktgruppen er i uoverensstemmelse med borgers alder

(Contactgroup cannot be created if age requirements are not met)

8063

Hændelsestidspunkt skal være lig eller før kontaktgruppens starttidsunkt

(EventTime must be equal to or before contactgroup start.)

Hændelsestidspunkt skal være lig eller før kontaktgruppens starttidsunkt

(EventTime must be equal to or before contactgroup start.)

8096

The contact group change is not allowed.

The contact group change is not allowed.

8190

An active absenceregistration must exist to create the given category

An active absenceregistration must exist to create the given category

8192

Person category cannot be created, there is a later person category or contactgroup registration

Person category cannot be created, there is a later person category or contactgroup registration

8193

The PersonCategory is not coherent with the ContactGroup

The PersonCategory is not coherent with the ContactGroup

8194

The PersonCategory cannot be in the future

The PersonCategory cannot be in the future

8195

The PersonCategoryType is invalid

The PersonCategoryType is invalid

9331

Jobcentret må ikke oprette kontaktgruppen

(It is not allowed to create the ContactGroup for jobcenter)

Jobcentret må ikke oprette kontaktgruppen

(It is not allowed to create the ContactGroup for jobcenter)

9336

CV number has to be specified

9337
irrelevant pga JobSearch og Eventbroker?

Call to SetFlexijobApproved failed

Call to SetFlexijobApproved failed

9346
irrelevant pga JobSearch og Eventbroker?

Call to CVServiceForDFDG failed

Call to CVServiceForDFDG failed

CreateKontaktgruppe (POST /v1/personVisitering/kontaktgrupper)

CreateKontaktgruppe (POST /v1/personVisitering/kontaktgrupper/legacy)

Metoden bruges til at registrere (oprette) borgers kontaktgruppe, internt i STARs systemer.

Operation

Endpoint

POST

/v1/personVisitering/kontaktgrupper/legacy

Tilladte organisationer

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

STAR

X

Input

Elemenent

Type

Detaljer

Forekomst

Beskrivelse

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

Borgers cpr nummer

CreateKontaktgruppeRequest
(requestBody)

CreateKontaktgruppeRequestDto

1

Oplysninger om borgers kontaktgruppe

- DfdgPersonVisitationsstatus

DfdgPersonVisitationsstatusDto

1

Borgerens visitationsstatus, i DFDG

- - Tilmelding

TilmeldingDto

0 - 1

- - Servicekontekst

ServiceContextCodeList

0 - 1

- - …. mere

-    kontaktgruppeType

(ContactGroupTypeIdentifier)

VisiteringOgStatus.KontaktgruppeTypeCodeList [UDV]

(CodeListItemIdentifierType)

MaxInclusive: 10000000

1

Kontaktgruppen, som den ledige har på beregnings-tidspunkt.

- Haendelsestidspunkt

(ContactGroupEventTime)

DateTime

(dateTime)

 

0 - 1

Kontaktgruppens hændelsestidspunkt i eksternt system.

- Starttidspunkt

(ContactGroupStartTime)

DateTime

(dateTime)

 

1

Starttidspunkt for borgers kontaktgruppe.

-   Sluttidspunkt

(ContactGroupEndTime)

DateTime

(dateTime)

 

0 - 1

Sluttidspunkt for den borgers kontaktgruppe.

Output

Task<Guid> som er et unikt id for borgerens kontaktgruppe (kontaktgruppeId).

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetKontaktgruppeIdDto

 

1

Information om den oprettede kontaktgruppe

- kontaktgruppeId

GUID

0 - 1

GUID på den oprettede kontaktgruppe

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1001

Ikke validt personnummer

Det angivne personnummer er enten for langt eller for kort eller indeholder data der ikke kan fortolkes som en dato

1010

Ukendt cpr nr

Personnummeret findes ikke i DFDG

1014

Request validerer ikke

Request validerer ikke

4404

Der findes ikke borger i DFDG med det angive cpr nr

(The person with specified cpr does not exist)

Der findes ikke borger i DFDG med det angive cpr nr

(The person with specified cpr does not exist)

4405

Personen med det angivne cpr nr er død

Personen med det angivne cpr nr er død

4511

The External operator is not allowed to view data for the person

The External operator is not allowed to view data for the person

4575

You are not authorized

You are not authorized to execute the operation

4644

Borger har allerede en åben kontaktgruppe

(This Client has an open existing contactgroup)

Borger har allerede en åben kontaktgruppe

(This Client has an open existing contactgroup)

4645

Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og fravær

(This person has a absenceregistration that conflicts with this Contactgroup)

Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og fravær

(This person has a absenceregistration that conflicts with this Contactgroup)

4654

This person has an absenceregistration that conflicts with the submitted personcategory

This person has an absenceregistration that conflicts with the submitted personcategory

4655

This person must be unenrolled before this personcategory value can be applied

This person must be unenrolled before this personcategory value can be applied

4656

This personcategory is not coherent with the person's enrollment

This personcategory is not coherent with the person's enrollment

4675

Den angivne kontaktgruppetype er ugyldig

(The ContactGroupTypeIdentifier is invalid)

Den angivne kontaktgruppetype er ugyldig

(The ContactGroupTypeIdentifier is invalid)

4703

Startdatoen skal være i dag

(The submitted startdate have to be present)

Startdatoen skal være i dag

(The submitted startdate have to be present)

4731

Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og tilmelding

(Registration is not allowed because of an illegal combination of the contactgroup and enrollment)

Registrering ikke tilladt pga. ugyldig kombination af kontaktgruppe og tilmelding

(Registration is not allowed because of an illegal combination of the contactgroup and enrollment)

4919

Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende

(The contact group can not be ended due to an active enrollment)

Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende

(The contact group can not be ended due to an active enrollment)

6005

The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader

The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader

6033

Kontaktgruppen er i uoverensstemmelse med borgers alder

(ContactGroup is not coherent with age)

Kontaktgruppen er i uoverensstemmelse med borgers alder

(Contactgroup cannot be created if age requirements are not met)

8063

Hændelsestidspunkt skal være lig eller før kontaktgruppens starttidsunkt

(EventTime must be equal to or before contactgroup start.)

Hændelsestidspunkt skal være lig eller før kontaktgruppens starttidsunkt

(EventTime must be equal to or before contactgroup start.)

8096

The contact group change is not allowed.

The contact group change is not allowed.

8190

An active absenceregistration must exist to create the given category

An active absenceregistration must exist to create the given category

8192

Person category cannot be created, there is a later person category or contactgroup registration

Person category cannot be created, there is a later person category or contactgroup registration

8193

The PersonCategory is not coherent with the ContactGroup

The PersonCategory is not coherent with the ContactGroup

8194

The PersonCategory cannot be in the future

The PersonCategory cannot be in the future

8195

The PersonCategoryType is invalid

The PersonCategoryType is invalid

9331

Jobcentret må ikke oprette kontaktgruppen

(It is not allowed to create the ContactGroup for jobcenter)

Jobcentret må ikke oprette kontaktgruppen

(It is not allowed to create the ContactGroup for jobcenter)

9336

CV number has to be specified

9337
irrelevant pga JobSearch og Eventbroker?

Call to SetFlexijobApproved failed

Call to SetFlexijobApproved failed

9346
irrelevant pga JobSearch og Eventbroker?

Call to CVServiceForDFDG failed

Call to CVServiceForDFDG failed

UpdateKontaktgruppe (PUT /v1/personVisitering/kontaktgrupper/{kontaktgruppeId})

Metoden bruges til at opdatere en registreret kontaktgruppe.

Operation

Endpoint

PUT

/v1/personVisitering/kontaktgrupper/{kontaktgruppeId}

Tilladte organisationer

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

A-kasse

JobCenter

X

X

Kommune

X

X

STAR

X

Input

Elemenent

Type

Detaljer

Forekomst

Beskrivelse

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

Borgers cpr nummer

kontaktgruppeId [Fra route]

Guid

1

Unikt id for kontaktgruppen

UpdateKontaktgruppeRequest
(requestBody)

UpdateKontaktgruppeRequestDto

1

Oplysninger om borgers kontaktgruppe

- kontaktgruppeType

(ContactGroupTypeIdentifier)

VisiteringOgStatus.KontaktgruppeTypeCodeList [UDV]

(CodeListItemIdentifierType)

MaxInclusive: 10000000

1

Kontaktgruppen, som den ledige har på beregnings-tidspunkt.

- haendelsestidspunkt

(ContactGroupEventTime)

DateTime

(dateTime)

 

0 - 1

Kontaktgruppens hændelsestidspunkt.

- starttidspunkt

(ContactGroupStartTime)

DateTime

(dateTime)

 

1

Starttidspunkt for borgers kontaktgruppe.

- sluttidspunkt

(ContactGroupEndTime)

DateTime

(dateTime)

 

0 - 1

Sluttidspunkt for den borgers kontaktgruppe.

- berigtigelseskommentar

string

(CorrectionCommentType
Base: string)

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

Output

Kun status

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1001

Ikke validt personnummer

Det angivne personnummer er enten for langt eller for kort eller indeholder data der ikke kan fortolkes som en dato

1010

Ukendt cpr nr

Personnummeret findes ikke i DFDG

1014

Request validerer ikke

Request validerer ikke

4404

Der findes ikke borger i DFDG med det angive cpr nr

(The person with specified cpr does not exist)

Der findes ikke borger i DFDG med det angive cpr nr

(The person with specified cpr does not exist)

4405

The person with specified cpr is dead

The person with specified cpr is dead

4511

The External operator is not allowed to view data for the person

The External operator is not allowed to view data for the person

4575

You are not authorized

You are not authorized to execute the operation

4589

Den anvendte identifier findes ikke på denne borger i DFDG

(Unknown identifier)

Den anvendte identifier findes ikke på denne borger i DFDG

(Unknown identifier)

4644

Borger har allerede en åben kontaktgruppe

(This Client has an open existing contactgroup)

Borger har allerede en åben kontaktgruppe

(This Client has an open existing contactgroup)

4646

Kontaktgruppe-typen kan ikke ændres

(The ContactGroupTypeIdentifier cannot be changed)

Kontaktgruppe-typen kan ikke ændres

(The ContactGroupTypeIdentifier cannot be changed)

4647

Startdatoen må ikke ændres

(The Startdate cannot be changed)

Startdatoen må ikke ændres

(The Startdate cannot be changed)

4648

Slutdatoen kan ikke være før dags dato

(The Enddate cannot be before todays date)

Slutdatoen kan ikke være før dags dato

(The Enddate cannot be before todays date)

4669

Slutdato må ikke være før startdato

(The enddate must not be earlier than the start date)

Slutdato må ikke være før startdato

(The enddate must not be earlier than the start date)

4919

Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende

(The contact group can not be ended due to an active enrollment)

Kontaktgruppen kan ikke afsluttes pga. aktiv tilmelding som jobsøgende

(The contact group can not be ended due to an active enrollment)

6005

The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader

The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader

8065

Hændelsestidspunkt kan ikke ændres

(EventTime can not be changed.)

Hændelsestidspunkt kan ikke ændres

(EventTime can not be changed.)

9336

CV number has to be specified

CV number has to be specified

9337
irrelevant pga JobSearch og Eventbroker?

Call to SetFlexijobApproved failed

Call to SetFlexijobApproved failed

9346
irrelevant pga JobSearch og Eventbroker?

Call to CVServiceForDFDG failed

Call to CVServiceForDFDG failed

9370

Kontaktgruppen kan ikke afsluttes pga. et åbent fraværsforhold

(The contact group can not be ended due to an active absence)

Kontaktgruppen kan ikke afsluttes pga. et åbent fraværsforhold

(The contact group can not be ended due to an active absence)

GetKontaktgrupper (GET /v1/personVisitering/kontaktgrupper/{x-civilRegistrationIdentifier})

Denne metode benyttes til at hente oplysninger om borgers kontaktgrupper

Operation

Endpoint

GET

/v1/personVisitering/kontaktgrupper

Tilladte organisationer

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

A-kasse

 

X 

 120 dage på begge sider af medlemsskab

 X

 

 

Driftsselskab

X

X

JobCenter

 

X

 

 X

X

 X

Kommune

 

X

 

 X

 

STAR

X

 

 

 

 

 

Udbetaling Danmark (UDK)

X

Udlændinge- og Integrationsministeriet (UIM)

X

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetKontaktgrupperResponse

GetKontaktgrupperResponseDto

1

- Kontaktgrupper

(ContactGroup)

IEnumerable<KontaktgrupperDto>

(ContactGroupTypeCollection)

 

1

Samling af kontaktgrupper registreret på borger

- - KontaktgrupperDto

KontaktgrupperDto

0 - *

- - - kontaktgruppeId 

(MessageIdentifier)

Guid

(Guid)

(Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12})

0 - 1

GUID på kontaktgruppen

- - - kontaktgruppeType

(ContactGroupTypeIdentifier)

VisiteringOgStatus.KontaktgruppeTypeCodeList [UDV]

(ContactGroupTypeIdentifierType)

1

- - - haendelsestidspunkt

(ContactGroupEventTime)

DateTime

(dateTime)

 

1

Kontaktgruppens hændelsestidspunkt.

- - - starttidspunkt

(ContactGroupStartTime)

DateTime

(dateTime)

 

1

Starttidspunkt for borgers kontaktgruppe.

- - - sluttidspunkt

(ContactGroupEndTime)

DateTime

(dateTime)

 

0 - 1

Sluttidspunkt for den borgers kontaktgruppe.

- - - berigtigelseskommentar

string

(CorrectionCommentType
Base: string)

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1001

Ikke validt personnummer

Det angivne personnummer er enten for langt eller for kort eller indeholder data der ikke kan fortolkes som en dato

1010

Ukendt cpr nr

Personnummeret findes ikke i DFDG

1014

Request validerer ikke

Request validerer ikke

4575

You are not authorized

You are not authorized to execute the operation

GetKontaktgruppe (GET /v1/personVisitering/kontaktgrupper/{x-civilRegistrationIdentifier}/{kontaktgruppeId})

Denne metode benyttes til at hente oplysninger om borgers kontaktgrupper

Operation

Endpoint

GET

/v1/personVisitering/kontaktgrupper

Tilladte organisationer

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

A-kasse

 

X 

 120 dage på begge sider af medlemsskab

 X

 

 

Driftsselskab

X

X

JobCenter

 

X

 

 X

X

 X

Kommune

 

X

 

 X

 

STAR

X

 

 

 

 

 

Udbetaling Danmark (UDK)

X

Udlændinge- og Integrationsministeriet (UIM)

X

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

 

kontaktgruppeId

uuid

1

GUID på kontaktgruppen

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetKontaktgrupperResponse

GetKontaktgrupperResponseDto

1

  • Kontaktgrupper

(ContactGroup)

IEnumerable<KontaktgrupperDto>

(ContactGroupTypeCollection)

 

1

Samling af kontaktgrupper registreret på borger

  • - KontaktgrupperDto

KontaktgrupperDto

0 - *

  • - - kontaktgruppeId 

(MessageIdentifier)

Guid

(Guid)

(Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12})

0 - 1

GUID på kontaktgruppen

  • - - kontaktgruppeType

(ContactGroupTypeIdentifier)

VisiteringOgStatus.KontaktgruppeTypeCodeList [UDV]

(ContactGroupTypeIdentifierType)

1

  • - - haendelsestidspunkt

(ContactGroupEventTime)

DateTime

(dateTime)

 

1

Kontaktgruppens hændelsestidspunkt.

  • - - starttidspunkt

(ContactGroupStartTime)

DateTime

(dateTime)

 

1

Starttidspunkt for borgers kontaktgruppe.

  • - - sluttidspunkt

(ContactGroupEndTime)

DateTime

(dateTime)

 

0 - 1

Sluttidspunkt for den borgers kontaktgruppe.

  • - - berigtigelseskommentar

string

(CorrectionCommentType
Base: string)

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1001

Ikke validt personnummer

Det angivne personnummer er enten for langt eller for kort eller indeholder data der ikke kan fortolkes som en dato

1010

Ukendt cpr nr

Personnummeret findes ikke i DFDG

1014

Request validerer ikke

Request validerer ikke

4404

Person med det angivne CPR-nummer findes ikke

Person med det angivne CPR-nummer findes ikke

4575

You are not authorized

You are not authorized to execute the operation

4589

Id ikke fundet

Id ikke fundet

GetKontaktgruppeHistorik (GET /v1/personVisitering/kontaktgrupper/historik)

Denne metode benyttes til at hente historik for alle aktivitetstillaeg for en given borger.

Operation

Endpoint

GET

v1/kontaktgrupper/historik

Tilladte organisationer

 

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

A-kasse

 

 X

120 dage på begge sider af medlemsskab

 X

 

 

AUB

X

JobCenter

 

X

 

X

X

X

Kommune

 

X

 

X

 

STAR

X

 

 

 

 

 

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

0 - 1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetKontaktgruppeHistorikResponse

GetKontaktgruppeHistorikResponseDto

 

 

 

  • KontaktgruppeHistorik

(ContactGroup)

IEnumerable<KontaktgruppeHistorikDto>

(ContactGroupTypeCollection)

 

1

Samling af kontaktgrupper registreret på borger

  • - Kontaktgruppe

KontaktgruppeDto

0 - *

  • - - kontaktgruppeId 

(MessageIdentifier)

Guid

(Guid)

(Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12})

0 - 1

GUID på kontaktgruppen

  • - - kontaktgruppeType

(ContactGroupTypeIdentifier)

VisiteringOgStatus.KontaktgruppeTypeCodeList [UDV]

(ContactGroupTypeIdentifierType)

1

  • - - haendelsestidspunkt

(ContactGroupEventTime)

DateTime

(dateTime)

 

1

Kontaktgruppens hændelsestidspunkt.

  • - - starttidspunkt

(ContactGroupStartTime)

DateTime

(dateTime)

 

1

Starttidspunkt for borgers kontaktgruppe.

  • - - sluttidspunkt

(ContactGroupEndTime)

DateTime

(dateTime)

 

0 - 1

Sluttidspunkt for den borgers kontaktgruppe.

  • - - berigtigelseskommentar

string

(CorrectionCommentType
Base: string)

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

  • -    dfdgRegistreringstidspunkt

(RegistrationDate)

DateTime

 

1

Tidspunkt for registreringen i DFDG

  • -    Registreringsmetadata

RegistreringsmetadataDto

 

1

 

  • -    -    ErSlettet

boolean

 

1

Angiver om registreringen er en sletning

  • -    -    ErAktuel

boolean

 

1

Det er en række som er aktuel (kan typisk også ses i PSS).

  • -    -    RegistrerendeMyndighed

RegistrerendeMyndighedDto

 

0 - 1

 

  • -    -    -    OrganisationType

OrganisationTypeCodeList

 

1

 

  • -    -    -    Organisationskode

string

Length: 1-20

1

Identifikation af organisation / myndighed

  • -    -    -    RegistrerendeBruger

RegistrerendeBrugerDto

 

0 - 1

 

  • -    -    -    -    KaldendeBruger

KaldendeBrugerDto

 

1

 

  • -    -    -    -    -    BrugerFuldtNavn

string

Length: 1-140

1

Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.

  • -    -    -    -    -    BrugerType

RequestUserTypeCodeList

 

1

 

  • -    -    -    -    -    BrugerId

string

Length: 1-255

1

Unik identifikation af brugeren, f.eks. en GUID, et medarbejder ID, system ID, bruger ID, certifikat ID, cpr-nummer, email (hvis den er unik) o.l.

  • -    -    -    -    -    BrugerEmail

email

 

0 - 1

Brugers e-mail.

  • -    -    -    -    BrugerOrganisation

BrugerOrganisationDto

 

1

 

  • -    -    -    -    -    OrganisationType

OrganisationTypeCodeList

 

1

 

  • -    -    -    -    -    Organisattionskode

string

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

1

Organisationskode for den registrerende bruger.

  • -    -    -    -    DfdgRegistreringstidspunkt

DateTime

 

1

Tidspunkt for registrering i DFDG

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1001

Ikke validt personnummer

Det angivne personnummer er enten for langt eller for kort eller indeholder data der ikke kan fortolkes som en dato

1010

Ukendt cpr nr

Personnummeret findes ikke i DFDG

1014

Request validerer ikke

Request validerer ikke

4575

You are not authorized

You are not authorized to execute the operation

CreatePersonkategori (POST /v1/personVisitering/personkategorier){personkategoriId}

Metoden bruges til at registrere (oprette) borgers personkategori / visitation.

Operation

Endpoint

POST

/v1/personVisitering/personkategorier

Tilladte organisationer

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

A-kasse

JobCenter

X

X

Kommune

X

X

STAR

X

Input

Elemenent

Type

Detaljer

Forekomst

Beskrivelse

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

Borgers cpr nummer

CreatePersonkategoriRequest
(requestBody)

CreatePersonkategoriRequestDto

1

Oplysninger om borgers personkategori / visitation

- Personkategori

PersonkategoriDto

- - personkategoriType

(PersonCategoryTypeIdentifier)

VisiteringOgStatus.PersonkategoriTypeCodeList [UDV]

(PersonCategoryTypeIdentifierType)

1

Kodelisteværdi for personkategori

- - haendelsestidspunkt

(IncidentDate)

DateTime

(dateTime)

 

1

Angiver den dato og klokkeslet hvor borgeren blev kategoriseret.

Output

Task<Guid> som er et unikt id for borgerens personkategori (personkategoriId).

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetPersonkategoriIdDto

 

1

Information om den oprettede kontaktgruppe

- personkategoriId

GUID

0 - 1

GUID på den oprettede kontaktgruppe

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1001

Ikke validt personnummer

Det angivne personnummer er enten for langt eller for kort eller indeholder data der ikke kan fortolkes som en dato

1010

Ukendt cpr nr

Personnummeret findes ikke i DFDG

1014

Request validerer ikke

Request validerer ikke

4404

Der findes ikke borger i DFDG med det angive cpr nr

(The person with specified cpr does not exist)

Der findes ikke borger i DFDG med det angive cpr nr

(The person with specified cpr does not exist)

4405

Personen med det angivne cpr nr er død

Personen med det angivne cpr nr er død

4511

The External operator is not allowed to view data for the person

The External operator is not allowed to view data for the person

4575

You are not authorized

You are not authorized to execute the operation

4654

Registrering ikke tilladt pga. ugyldig kombination af personkategori og eksisterende fraværsregistrering

(This person has an absenceregistration that conflicts with the submitted personcategory)

Registrering ikke tilladt pga. ugyldig kombination af personkategori og eksisterende fraværsregistrering

(This person has an absenceregistration that conflicts with the submitted personcategory)

4655

Borger skal afmeldes som jobsøgende inden personkategorien kan anvendes

(This person must be unenrolled before this personcategory value can be applied)

Borger skal afmeldes som jobsøgende inden personkategorien kan anvendes

(This person must be unenrolled before this personcategory value can be applied)

4656

Borger skal afmeldes som jobsøgende inden personkategorien kan anvendes

(This personcategory is not coherent with the person's enrollment)

Borger skal afmeldes som jobsøgende inden personkategorien kan anvendes

(This personcategory is not coherent with the person's enrollment)

4664

Den angivne personkategori er ikke gyldig

(The submitted PersonCategory value is invalid)

Den angivne personkategori er ikke gyldig

(The submitted PersonCategory value is invalid)

4716

Registrering er ikke tilladt pga. ugyldig kombination af personkategori og kontaktgruppe

(This personcategory is not coherent with the person's contact group)

Registrering er ikke tilladt pga. ugyldig kombination af personkategori og kontaktgruppe

(This personcategory is not coherent with the person's contact group)

4752

Cannot register personcategory since warning letter date for an active illness reg. has passed

Cannot register personcategory since warning letter date for an active illness reg. has passed

6005

The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader

The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader

6029

Personkategorien “ikke visiteret” må ikke sættes af sagsbehandler

Visitationgroup “ikke visiteret” is not allowed

Personkategorien “ikke visiteret” må ikke sættes af sagsbehandler

Visitationgroup “ikke visiteret” is not allowedd

8192

Personkategorien kan ikke registreres pga. senere registrering af personkategori eller kontaktgruppe

(Person category cannot be created, there is a later person category or contactgroup registration)

Personkategorien kan ikke registreres pga. senere registrering af personkategori eller kontaktgruppe

(Person category cannot be created, there is a later person category or contactgroup registration)

8193

Registrering er ikke tilladt pga. ugyldig kombination af personkategori og kontaktgruppe

(This personcategory is not coherent with the person's contact group)

Registrering er ikke tilladt pga. ugyldig kombination af personkategori og kontaktgruppe

(This personcategory is not coherent with the person's contact group)

8194

Personkategoriseringen kan ikke være fremtidig

(The PersonCategory cannot be in the future)

Personkategoriseringen kan ikke være fremtidig

(The PersonCategory cannot be in the future)

8195

Den angivne personkategori er ikke gyldig

(The PersonCategoryType is invalid)

Den angivne personkategori er ikke gyldig

(The PersonCategoryType is invalid)

9282

Registrering ikke tilladt pga. ugyldig kombination af personkategori og eksisterende fraværsregistrering

The person has an absence registration which conflicts with this person category

Registrering ikke tilladt pga. ugyldig kombination af personkategori og eksisterende fraværsregistrering

The person has an absence registration which conflicts with this person category

UpdatePersonkategori (PUT /v1/personVisitering/personkategorier/{personkategoriId})

Metoden bruges til at opdatere en registreret personkategori.

Operation

Endpoint

PUT

/v1/personVisitering/personkategorier/{personkategoriId}

Tilladte organisationer

Alle borgere

Egne borgere

Tidligere egne borgere

Gæsteadgang

Anden Aktør - egne borgere

Anden Aktør - gæsteadgang

A-kasse

JobCenter

X

X

Kommune

X

X

STAR

X

Input

Elemenent

Type

Detaljer

Forekomst

Beskrivelse

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

Borgers cpr nummer

personkategoriId [Fra Route]

Guid

1

Unikt id for personkategorien.

UpdatePersonkategoriRequest
(requestBody)

UpdatePersonkategoriRequestDto

1

Oplysninger om borgers personkategori / visitation.

- berigtigelseskommentar

string

(CorrectionCommentType
Base: string)

Length: 1-1500

0 - 1

Kommentar til berigtigelse af en registrering.

Output

Kun status

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1001

Ikke validt personnummer

Det angivne personnummer er enten for langt eller for kort eller indeholder data der ikke kan fortolkes som en dato

1010

Ukendt cpr nr

Personnummeret findes ikke i DFDG

1014

Request validerer ikke

Request validerer ikke

4404

Der findes ikke borger i DFDG med det angive cpr nr

(The person with specified cpr does not exist)

Der findes ikke borger i DFDG med det angive cpr nr

(The person with specified cpr does not exist)

4405

Personen med det angivne cpr nr er død

Personen med det angivne cpr nr er død

4575

You are not authorized

You are not authorized to execute the operation

4589

Den anvendte identifier findes ikke på denne borger i DFDG

(Unknown identifier)

Den anvendte identifier findes ikke på denne borger i DFDG

(Unknown identifier)

6005

The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader

The person with specified cpr does not belong to the jobcenter specified in ActiveOrganisationHeader

GetPersonkategorier (GET /v1/personVisitering/personkategorier{CivilRegistrationIdentifier}/)

Denne metode benyttes til at hente oplysninger om borgers personkategorier

Operation

Endpoint

GET

/v1/personVisitering/personkategorier

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

0 - 1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonkategorierResponse
(response)

GetPersonkategorierResponseDto

1

- Personkategorier

(PersonCategoryInfo)

IEnumerable<PersonkategoriDto>

(PersonCategoryTypeCollection)

 

1

Samling af personkategorier registreret på borger

- - Personkategori

(PersonCategoryInfo)

PersonkategoriDto

(PersonCategoryInfoType)

0 - *

-

- - - personkategoriId

(MessageIdentifier)

Guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Unik nøgle

- -    -    personkategoriType

(PersonCategoryType)

VisiteringOgStatus.PersonkategoriTypeCodeList [UDV]

(PersonCategoryType)

 

1

Personkategori

- -    -    haendelsestidspunkt

(IncidentDate)

DateTime

(dateTime)

 

1

Angiver den dato og klokkeslet borger blev kategoriseret.

  • - - afslutningstidspunkt

DateTime

(dateTime)

0 - 1

Angiver den dato og klokkeslet borgers kategori blev afsluttet

  • - - erSlettet

Boolean

1

Indikation på om personkategoriseringen er slettet

- -    -   berigtigelseskommentar 

(CorrectionComment)

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

- -    -    dfdgRegistreringstidspunkt

(RegistrationDate)

DateTime

(dateTime)

 

1

Tidspunkt for registreringen i DFDG

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1001

Ikke validt personnummer

Det angivne personnummer er enten for langt eller for kort eller indeholder data der ikke kan fortolkes som en dato

1010

Ukendt cpr nr

Personnummeret findes ikke i DFDG

1014

Request validerer ikke

Request validerer ikke

4575

You are not authorized

You are not authorized to execute the operation

GetPersonkategori (GET /v1/personVisitering/personkategorier{CivilRegistrationIdentifier}/{personkategoriId})

Denne metode benyttes til at hente oplysninger om borgers personkategori

Operation

Endpoint

GET

/v1/personVisitering/personkategorier

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

0 - 1

 

personkategoriId

Guid

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Unik nøgle

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonkategorierResponse
(response)

GetPersonkategorierResponseDto

1

  • Personkategorier

(PersonCategoryInfo)

IEnumerable<PersonkategoriDto>

(PersonCategoryTypeCollection)

 

1

Samling af personkategorier registreret på borger

  • - Personkategori

(PersonCategoryInfo)

PersonkategoriDto

(PersonCategoryInfoType)

0 - *

-

  • - - personkategoriId

(MessageIdentifier)

Guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Unik nøgle

  • -    -    personkategoriType

(PersonCategoryType)

VisiteringOgStatus.PersonkategoriTypeCodeList [UDV]

(PersonCategoryType)

 

1

Personkategori

  • -    -    haendelsestidspunkt

(IncidentDate)

DateTime

(dateTime)

 

1

Angiver den dato og klokkeslet borger blev kategoriseret.

  • - - afslutningstidspunkt

DateTime

(dateTime)

0 - 1

Angiver den dato og klokkeslet borgers kategori blev afsluttet

  • - - erSlettet

Boolean

1

Indikation på om personkategoriseringen er slettet

  • -    -   berigtigelseskommentar 

(CorrectionComment)

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

  • -    -    dfdgRegistreringstidspunkt

(RegistrationDate)

DateTime

(dateTime)

 

1

Tidspunkt for registreringen i DFDG

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1001

Ikke validt personnummer

Det angivne personnummer er enten for langt eller for kort eller indeholder data der ikke kan fortolkes som en dato

1010

Ukendt cpr nr

Personnummeret findes ikke i DFDG

1014

Request validerer ikke

Request validerer ikke

4575

You are not authorized

You are not authorized to execute the operation

GetPersonkategoriHistorik (GET /v1/personVisitering/personkategorier/historik)

Denne metode benyttes til at hente historik for alle personkategorier for en given borger.

Operation

Endpoint

GET

v1/personkategorier/historik

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

0 - 1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonkategoriHistorikResponse

GetPersonkategoriHistorikResponseDto

 

 

 

  • PersonkategoriHistorik

(PersonCategoryHistoryCollection)

IEnumerable<PersonkategoriHistorikDto>

(PersonCategoryHistoryCollection)

 

1

Samling af kontaktgrupper registreret på borger

  • - Personkategori

(PersonCategoryInfo)

PersonkategoriDto

(PersonCategoryInfoType)

0 - *

-

  • - - personkategoriId

(MessageIdentifier)

Guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Unik nøgle

  • -    -    personkategoriType

(PersonCategoryType)

VisiteringOgStatus.PersonkategoriTypeCodeList [UDV]

(PersonCategoryType)

 

1

Personkategori

  • -    -    haendelsestidspunkt

(IncidentDate)

DateTime

(dateTime)

 

1

Angiver den dato og klokkeslet borger blev kategoriseret.

  • - - afslutningstidspunkt

DateTime

(dateTime)

0 - 1

Angiver den dato og klokkeslet borgers kategori blev afsluttet

  • - - erSlettet

Boolean

1

Indikation på om personkategoriseringen er slettet

  • -    -    berigtigelseskommentar 

(CorrectionComment)

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

  • -    dfdgRegistreringstidspunkt

(RegistrationDate)

DateTime

 

1

Tidspunkt for registreringen i DFDG

  • -    Registreringsmetadata

RegistreringsmetadataDto

 

1

 

  • -    -    ErSlettet

boolean

 

1

Angiver om registreringen er en sletning

  • -    -    ErAktuel

boolean

 

1

Det er en række som er aktuel (kan typisk også ses i PSS).

  • -    -    RegistrerendeMyndighed

RegistrerendeMyndighedDto

 

0 - 1

 

  • -    -    -    OrganisationType

OrganisationTypeCodeList

 

1

 

  • -    -    -    Organisationskode

string

Length: 1-20

1

Identifikation af organisation / myndighed

  • -    -    -    RegistrerendeBruger

RegistrerendeBrugerDto

 

0 - 1

 

  • -    -    -    -    KaldendeBruger

KaldendeBrugerDto

 

1

 

  • -    -    -    -    -    BrugerFuldtNavn

string

Length: 1-140

1

Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.

  • -    -    -    -    -    BrugerType

RequestUserTypeCodeList

 

1

 

  • -    -    -    -    -    BrugerId

string

Length: 1-255

1

Unik identifikation af brugeren, f.eks. en GUID, et medarbejder ID, system ID, bruger ID, certifikat ID, cpr-nummer, email (hvis den er unik) o.l.

  • -    -    -    -    -    BrugerEmail

email

 

0 - 1

Brugers e-mail.

  • -    -    -    -    BrugerOrganisation

BrugerOrganisationDto

 

1

 

  • -    -    -    -    -    OrganisationType

OrganisationTypeCodeList

 

1

 

  • -    -    -    -    -    Organisattionskode

string

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

1

Organisationskode for den registrerende bruger.

  • -    -    -    -    DfdgRegistreringstidspunkt

DateTime

 

1

Tidspunkt for registrering i DFDG

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1001

Ikke validt personnummer

Det angivne personnummer er enten for langt eller for kort eller indeholder data der ikke kan fortolkes som en dato

1010

Ukendt cpr nr

Personnummeret findes ikke i DFDG

1014

Request validerer ikke

Request validerer ikke

4575

You are not authorized

You are not authorized to execute the operation

  • No labels

Tilgængelighed: https://starwiki.atlassian.net/was