Versions Compared

Old Version 6

changes.mady.by.user Jan Nyman

Saved on

compared with

New Version 7

changes.mady.by.user Jan Nyman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Denne service gør det muligt at oprette og redigere persongruppeprojekter, samt at fremsøge persongruppemarkeringer i persongruppeprojekterne.

...

Table of Contents
maxLevel2

...

CreatePersonGrouppeProjekt (Tidl.

...

CreatePersonGroupProject)

Denne metode gør det muligt at oprette et persongruppeprojekt.

...

    personGrouppeProjektObjekt?

Element

Type

Detaljer

Forekomst

Beskrivelse

CreatePersonGroupProjectRequest

CreatePersonGroupProjectRequestType

1

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

 

 

1

 

-

    personGrouppeProjekt
(PersonGroupProjectItem)

PersonGrouppeProjektDto
(PersonGroupProjectItemType)

1

Indeholder detaljer for persongruppeprojekt objektet.

-    -    starttidspunkt
(StartTime)

dateTime

1

Startdato på persongruppeprojekt.

-    -    sluttidspunkt
(EndTime)

dateTime

0 - 1

Slutdato på persongruppeprojekt.

-     -    organisationsType    anvendendeOrganisationstype
(PersonGroupProjectTypeIdentifier)

?anvendendeOrganisationstypeTypeCodeList
(PersonGroupProjectTypeIdentifierType)

1

Organisationstypen, der har betydning for hvem der kan se projektet – se kodeliste for værdier

-    -    projektnavn
(ProjectName)

string

Length: 1-50

1

Navn på projekt.

...

Fejlkode

Fejltekst

Beskrivelse

4575

You are not authorized

You are not authorized to execute the operation

4636

Enddate cannot be before startdate

Enddate cannot be before startdate

9131

Invalid CodeListItemIdentifier

Invalid CodeListItemIdentifier

9405

Enddate cannot be in the past

Enddate cannot be in the past

...

UpdatePersonGrouppeProjekt (Tidl.

...

UpdatePersonGroupProject )

Denne metode gør det muligt at opdatere et registreret persongruppeprojekt. Det er kun muligt at ændre på startdatoen frem i tiden. En slutdato betyder, at det ikke længere er muligt at tilknytte personer til projektet. Der sættes ikke en slutdato på eksisterende persongruppemarkeringer.

...

    personGrouppeProjekt
(PersonGroupProject)?
(PersonGroupProjectType)    -    personGrouppeProjektObjekt?

Element

Type

Detaljer

Forekomst

Beskrivelse

UpdatePersonGroupProjectRequest

UpdatePersonGroupProjectRequestType

1

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

 

 

1

 

-

    PersonGroupProject

PersonGroupProjectType

1

Indeholder information om en given persongruppe.

-    -    projektIdentifier projektIdentifier
(PersonGroupProjectIdentifier)

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

Identifikation af persongruppeprojektet.

-

 personGrouppeProjekt
(PersonGroupProjectItem)

PersonGrouppeProjektDto
(PersonGroupProjectItemType)

1

Indeholder detaljer for persongruppeprojekt objektet.

-    -    -    starttidspunkt starttidspunkt
(StartTime)

dateTime

1

Startdato på persongruppeprojekt.

-    -    -    sluttidspunkt sluttidspunkt
(EndTime)

dateTime

0 - 1

Slutdato på persongruppeprojekt.

-    -    -    organisationsType anvendendeOrganisationstype
(PersonGroupProjectTypeIdentifier)

anvendendeOrganisationstypeTypeCodeList
(PersonGroupProjectTypeIdentifierType)

1

Organisationstypen, der har betydning for hvem der kan se projektet – se kodeliste for værdier

-    -    -    projektnavn projektnavn
(ProjectName)

string

Length: 1-50

1

Navn på projekt.

-    -    berigtigelseskommentar berigtigelseskommentar
(CorrectionComment)

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

...

Fejlkode

Fejltekst

Beskrivelse

4575

You are not authorized

You are not authorized to execute the operation

4666

The submitted PersonGroupProjectIdentifier is unknown to the system

The submitted PersonGroupProjectIdentifier is unknown to the system

4636

Enddate cannot be before startdate

Enddate cannot be before startdate

4643

The start time must not be in the past

The start time must not be in the past

9131

Invalid CodeListItemIdentifier

Invalid CodeListItemIdentifier

...

DeletePersonGrouppeProjekt (Tidl.

...

DeletePersonGroupProject )

Denne metode gør det muligt at slette et persongruppeprojekt.

...

Fejlkode

Fejltekst

Beskrivelse

4575

You are not authorized

You are not authorized to execute the operation

4666

The submitted PersonGroupProjectIdentifier is unknown to the system

The submitted PersonGroupProjectIdentifier is unknown to the system

4643

The start time must not be in the past

The start time must not be in the past

...

GetPersonGrouppeProjekt (Tidl.

...

GetPersonGroupProject)

Metode til at hente et specifikt persongruppeprojekt.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGroupProjectResponse
(GetPersonGroupProjectRequest)

GetPersonGroupProjectResponseType
(GetPersonGroupProjectRequestType)

1

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

-    projektIdentifier
(PersonGroupProjectIdentifier)

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

Identifikation af et specifikt persongruppeprojekt.

...

    -    personGrouppeProjektObjekt    -    ParticipationIndicatedByProjectType    -    ParticipatingAuthoritiesParticipatingAuthorityTypeCollection    -    ParticipatingAuthorityTypeParticipatingAuthorityType    -    AuthorityCode    -    OrganisationTypeIdentifier    -    CorrectionComment

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGroupProjectResponse

GetPersonGroupProjectResponseType

1

-    personGrouppeProjekt
(PersonGroupProject)

GetPersonGroupProjectType

1

Persongruppeprojekt

-    -    projektIdentifier projektIdentifier
(PersonGroupProjectIdentifier)

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

Identifikation af persongruppeprojektet.

-

 personGrouppeProjekt
(PersonGroupProjectItem)

PersonGrouppeProjektDto
(GetPersonGroupProjectItemType)

1

Indeholder detaljer for persongruppeprojekt objektet.

-    -    -    starttidspunkt starttidspunkt
(StartTime)

dateTime

1

Startdato på persongruppeprojekt.

-    -    -    sluttidspunkt sluttidspunkt
(EndTime)

dateTime

0 - 1

Slutdato på persongruppeprojekt.

-    -    -    organisationsType anvendendeOrganisationstype
PersonGroupProjectTypeIdentifier

anvendendeOrganisationstypeTypeCodeList
(PersonGroupProjectTypeIdentifierType)

1

Projekttypen, der har betydning for hvem der kan se projektet – se kodeliste for værdier

-    -    -    projektnavn projektnavn
(ProjectName)

string

Length: 1-50

1

Navn på projekt.

-    -

 deltagerIndikatorPåProjektType

ParticipationIndicatedByProjectType

boolean

1

Indikation på at deltagende myndigheder kun er angivet i kraft af projekttypen, da alle myndigheder deltager i denne projekttype.

-    -

 deltagendeMyndighed
ParticipatingAuthorities

deltagendeMyndighedDto

(ParticipatingAuthorityTypeCollection)

1

En liste med deltagende myndigheder (a-kasser og jobcentre). Ved projekter af typen 1 - Stat - jobcentre er listen tom idet feltet ParticipationIndicatedByProjectType=true indikerer at alle jobcentre deltager.

-    -    -

 deltagendeMyndigheder
(ParticipatingAuthorityType)

deltagendeMyndigheder
(ParticipatingAuthorityType)

0 - *

En deltagende myndighed

-    -    -    -

 myndighedsKode
(AuthorityCode)

string

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

1

Myndighedskode

-    -    -    -

 OrganisationType
(OrganisationTypeIdentifier)

OrganisationTypeCodeList
OrganisationTypeIdentifierType

1

Myndighedstype

-

 berigtigelseskommentar
(CorrectionComment)

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

4666

The submitted PersonGroupProjectIdentifier is unknown to the system

The submitted PersonGroupProjectIdentifier is unknown to the system

9404

The authority is not part of the project

The authority is not part of the project

...

GetPersonGrouppeProjekter (Tidl.

...

GetPersonGroupProjects)

Metode til at hente persongruppeprojekter.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGrouppeProjekterRequest
(GetPersonGroupProjectsRequest)

GetPersonGrouppeProjekterRequestType)
(GetPersonGroupProjectsRequestType)

1

Output

GetPersonGroupProjectsResponseType    PersonGroupProjects    PersonGroupProjectIdentifier    PersonGroupProjectItemGetPersonGroupProjectItemType    -    StartTime    -    EndTime    -    PersonGroupProjectTypeIdentifierPersonGroupProjectTypeIdentifierType    -    ProjectName    -    ParticipationIndicatedByProjectType    -    ParticipatingAuthorities    -    ParticipatingAuthorityType    -    AuthorityCode    -    OrganisationTypeIdentifierOrganisationTypeIdentifierType    -    CorrectionComment

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGroupProjectsResponse

GetPersonGrouppeProjekterResponse
(GetPersonGroupProjectsResponse)

GetPersonGrouppeProjekterResponseType
(GetPersonGroupProjectsResponseType)

1

-

    personGrouppeProjekt
(PersonGroupProjects)

PersonGrouppeProjektDto
GetPersonGroupProjectTypeCollection

1

Placeholder for liste af persongruppeprojekt objekter.

-    -    GetPersonGroupProjectType

GetPersonGroupProjectType

0 - *

Indholder liste af persongruppeprojekt objekter.

-    -    -

    projektIdentifier
(PersonGroupProjectIdentifier)

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

Identifikation af persongruppeprojektet.

-    -    -

    personGrouppeProjekt
(PersonGroupProjectItem)

PersonGrouppeProjektDto
(GetPersonGroupProjectItemType)

1

Indeholder detaljer for persongruppeprojekt objektet.

-    -    -

 starttidspunkt
(StartTime)

dateTime

1

Startdato på persongruppeprojekt.

-    -    -

 sluttidspunkt
(EndTime)

dateTime

0 - 1

Slutdato på persongruppeprojekt.

-    -    -

 anvendendeOrganisationstype
PersonGroupProjectTypeIdentifier

anvendendeOrganisationstypeTypeCodeList
(PersonGroupProjectTypeIdentifierType)

1

Projekttypen, der har betydning for hvem der kan se projektet – se kodeliste for værdier

-    -    -

 projektnavn
ProjectName

string

Length: 1-50

1

Navn på projekt.

-    -    -

 deltagerIndikatorPåProjektType
ParticipationIndicatedByProjectType

boolean

1

Indikation på at deltagende myndigheder kun er angivet i kraft af projekttypen, da alle myndigheder deltager i denne projekttype.

-    -    -

 deltagendeMyndighed
ParticipatingAuthorities

ParticipatingAuthorityTypeCollection

1

En liste med deltagende myndigheder (a-kasser og jobcentre). Ved projekter af typen 1 - Stat - jobcentre er listen tom idet feltet ParticipationIndicatedByProjectType=true indikerer at alle jobcentre deltager.

-    -    -    -

 deltagendeMyndigheder
ParticipatingAuthorityType

ParticipatingAuthorityType

0 - *

En deltagende myndighed

-    -    -    -    -

 myndighedsKode
AuthorityCode

string

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

1

Myndighedskode

-    -    -    -    -

 OrganisationType
OrganisationTypeIdentifier

OrganisationTypeCodeList
(OrganisationTypeIdentifierType)

1

Myndighedstype

-    -

 berigtigelseskommentar
CorrectionComment

string

Length: 0-1500

0 - 1

Kommentar til berigtigelse af en registrering.

Fejlkoder

Ingen fejlkoder

...

GetPersonGrouppeMarkering (Tidl.

...

GetPersonGroupMarking)

Metoden bruges til at hente en specifik persongruppetilknytning.

...

Fejlkode

Fejltekst

Beskrivelse

4589

Unknown identifier

The submitted Identifier is unknown to the system

...

GetPersonGrouppeProjektMarkeringer (Tidl.

...

GetPersonGroupProjectMarkings) ¤Mangler

Metode til at hente tilknytninger til et projekt, som man som myndighed har adgang til - med mulighed for at indsnævre resultatet til en specifik sagsbehandlers tilknytninger.

...

Fejlkode

Fejltekst

Beskrivelse

4666

The submitted PersonGroupProjectIdentifier is unknown to the system

The submitted PersonGroupProjectIdentifier is unknown to the system

...

GetPersonGrouppeProjektMarkeringerByCaseWorker (Tidl.

...

GetPersonGroupProjectMarkingsByCaseWorker) ¤Mangler

Tilladte organisationer (¤Skal afklares her)

 

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

 

 

 

 

 

 

 

JobCenter

 

 

 

 

 

 

Kommune

 

 

 

 

 

 

 

STAR

 

 

 

 

 

 

 

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetPersonGroupProjectMarkingsByCaseWorkerResponse

GetPersonGroupProjectMarkingsByCaseWorkerResponseType

 

1

Svar som indeholder persongruppeprojekter.

  • CitizenGroupProjectMarkings

CitizenGroupProjectMarkingsType

 

0 - 1

Placeholderelement for liste af CitizenGroupProjectMarking objektet.

  • -    CitizenGroupProjectMarking

CitizenGroupProjectMarkingType

 

0 - *

Indholder liste af CitizenGroupProjectMarking objektet.

  • -    -    GroupMarkingIdentifier

guid
Base: string

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

1

Objekt ID´et for PersonGroupProjectMarking objektet.

  • -    -    PersonCivilRegistrationIdentifier

string

 

1

CPR-nr på borgeren som er knyttet til persongruppemarkeringen.

  • -    -    PersonNameStructure

PersonNameStructureType

 

1

Indholder detaljer af borgerens navn

  • -    -    -    PersonGivenName

PersonGivenNameType
Base: string

Length: 1-50

1

Declaration of an individual"s first name(s).

  • -    -    -    PersonMiddleName

PersonMiddleNameType
Base: string

Length: 1-40

0 - 1

Declaration of an individual"s middle name(s).

  • -    -    -    PersonSurnameName

PersonSurnameNameType
Base: string

Length: 1-40

1

Declaration of an individuals surname.

  • -    -    PostCodeIdentifier

PostCodeIdentifierType
Base: string

Pattern: [0-9]{4}

1

The postal departments nationwide postal code.

  • -    -    CitizenGroupMarkingTime

dateTime

 

0 - 1

Tidspunktet for at borgeren er knyttet til persongruppemarkeringen

  • -    -    CitizenGroupMarkingCaseworker

CitizenGroupMarkingCaseworkerType

 

1

Den caseworker der har knyttet borgeren til persongruppemarkeringen

  • -    -    -    RegisteringCaseworkerIdentifier

string

 

1

Id for sagsbehandleren

  • -    -    -    RegisteringCaseworkerFullName

string

 

1

Fuldt navn på sagsbehandleren.

Fejlkoder

Ingen fejlkoder

...

addProjektDeltagendeMyndigheder (Tidl.

...

AddProjectParticipatingAuthorities) ¤Mangler

Metode til at tilføje myndigheder til et persongruppeprojekt med flere deltagende jobcentre og/eller a-kasser.

...

Fejlkode

Fejltekst

Beskrivelse

4575

You are not authorized

You are not authorized to execute the operation

4666

The submitted PersonGroupProjectIdentifier is unknown to the system

The submitted PersonGroupProjectIdentifier is unknown to the system

9400

Only project type 5 allows adding authorities

Only project type 5 allows adding authorities

9401

The participating authority is unknown to DFDG

The participating authority is unknown to DFDG

9402

The list of participating authorities cannot contain duplicates

The list of participating authorities cannot contain duplicates

9403

The project is not open for adding participating authorities

The project is not open for adding participating authorities

...

RemoveProjektDeltagendeMyndigheder (Tidl.

...

RemoveProjectParticipatingAuthority) ¤Mangler

Metode til at fjerne myndigheder fra et tværgående persongruppeprojekter. Metoden kan kun kaldes af STAR.

...

Fejlkode

Fejltekst

Beskrivelse

4575

You are not authorized

You are not authorized to execute the operation

4666

The submitted PersonGroupProjectIdentifier is unknown to the system

The submitted PersonGroupProjectIdentifier is unknown to the system

9400

Only project type 5 allows adding authorities

Only project type 5 allows adding authorities

9403

The project is not open for adding participating authorities

The project is not open for adding participating authorities

9404

The authority is not part of the project

The authority is not part of the project

...

CreatePersonGrouppeMarkering (Tidl.

...

CreatePersonGroupMarking) ¤Mangler

Denne servicemetode benyttes til at oprette en persongruppemarkering

...

Fejlkode

Fejltekst

Beskrivelse

4666

The submitted PersonGroupProjectIdentifier is unknown to the system

The submitted PersonGroupProjectIdentifier is unknown to the system

4669

The enddate must not be earlier than the start date

The enddate must not be earlier than the start date

4670

The startdate must not be earlier than the project startdate

The startdate must not be earlier than the project startdate

4671

The enddate must not be later than the project enddate

The enddate must not be later than the project enddate

4672

This person is already associated with this project within this time frame

This person is already associated with this project within this time frame

...

UpdatePersonGrouppeMarkering (Tidl.

...

UpdatePersonGroupMarking) ¤Mangler

Denne servicemetode benyttes til at opdatere en persongruppemarkering.

...

Fejlkode

Fejltekst

Beskrivelse

4589

Unknown identifier

The submitted Identifier is unknown to the system

4666

The submitted PersonGroupProjectIdentifier is unknown to the system

The submitted PersonGroupProjectIdentifier is unknown to the system

4668

The startdate must not be in the past

The startdate must not be in the past

4669

The enddate must not be earlier than the start date

The enddate must not be earlier than the start date

4670

The startdate must not be earlier than the project startdate

The startdate must not be earlier than the project startdate

4671

The enddate must not be later than the project enddate

The enddate must not be later than the project enddate

4672

This person is already associated with this project within this time frame

This person is already associated with this project within this time frame

9407

Only the creating authority or current jobcenter can update/delete a marking

Only the creating authority or current jobcenter can update/delete a marking

...

DeletePersonGrouppeMarkering (Tidl.

...

DeletePersonGroupMarking) ¤Mangler

Denne servicemetode benyttes til at slette en persongruppemarkering.

...

Fejlkode

Fejltekst

Beskrivelse

4589

Unknown identifier

The submitted Identifier is unknown to the system

4668

The startdate must not be in the past

The startdate must not be in the past

9407

Only the creating authority or current jobcenter can update/delete a marking

Only the creating authority or current jobcenter can update/delete a marking

...

GetPersonGrouppeProjekterByType (Tidl.

...

GetPersonGroupProjectsByType) ¤Mangler

Metode til at hente persongruppeprojekter af en specifik type

...