Table of Contents |
---|
CreatePersonGroupProject
Metode til at oprette et persongruppeprojekt.
Valideringen om at startdato ikke kan være i fortiden udgår. Adgang: Jobcentre, kommuner og anden aktør til projekter med PersonGroupProjectTypeIdentifier id 3. A-kasser til projekter med id 4 og STAR til 1 og 5 (da STAR ikke meningsfuldt kan oprette et type 3 eller 4 projekt fordi det så ikke får tilknyttet en myndighed).
Input
...
...
...
...
...
...
Output
...
...
...
...
...
...
- CreatedItemIdentifier
...
Fejlkoder
...
...
...
...
9405
...
UpdatePersonGroupProject
Metode til at opdatere et persongruppeprojekt.
...
Table of Contents |
---|
CreatePersonGroupProject
Metode til at oprette et persongruppeprojekt.
Valideringen om at startdato ikke kan være i fortiden udgår. Adgang: Jobcentre, kommuner og anden aktør til projekter med PersonGroupProjectTypeIdentifier id 3. A-kasser til projekter med id 4 og STAR til 1 og 5 (da STAR ikke meningsfuldt kan oprette et type 3 eller 4 projekt fordi det så ikke får tilknyttet en myndighed).
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
CreatePersonGroupProjectRequest | CreatePersonGroupProjectRequestType | 1 | Forespørgsel som indeholder data vedr. oprettelsen af et persongruppeprojekt. | |
- PersonGroupProjectItem | PersonGroupProjectItemType | 1 | Indholder detaljer for persongruppeprojekt objektet. | |
- - StartTime | dateTime | 1 | Startdato på persongruppeprojekt. | |
- - EndTime | dateTime | 0 - 1 | Slutdato på persongruppeprojekt. | |
- - PersonGroupProjectTypeIdentifier | CodeListItemIdentifierType | MaxInclusive: 10000000 | 1 | Projekttypen, der har betydning for hvem der kan se projektet – se kodeliste for værdier |
- - ProjectName | ProjectNameType Base: string | Length: 1-50 | 1 | Navn på projekt. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|
CreatedResponse |
CreatedResponseType | 1 |
Kvittering som indeholder den unikke identifikation for den oprettede entitet | |
- CreatedItemIdentifier | 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 |
Base: string
Base: string
Unik identifikation for den oprettede entitet |
Fejlkoder
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 |
4702 | The submitted project type identifier is invalid | The submitted project type identifier is invalid |
¤XX1 | You are not allowed to create a project of this type | |
9405 | Enddate cannot be in the past |
UpdatePersonGroupProject
Metode til at opdatere et persongruppeprojekt.
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|
UpdatePersonGroupProjectRequest |
Metode til at slette et persongruppeprojekt.
Input
UpdatePersonGroupProjectRequestType | 1 |
Fejlkoder
DeletePersonGroupProject
Forespørgsel som indeholder data vedr. opdatering af et persongruppeprojekt. | ||||
- PersonGroupProject | PersonGroupProjectType | 1 | Indholder information om en given persongruppe. | |
- - PersonGroupProjectIdentifier | 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 | Identifikation af persongruppeprojektet. |
- - PersonGroupProjectItem | PersonGroupProjectItemType | 1 | Indholder detaljer for persongruppeprojekt objektet. | |
- - - StartTime | dateTime | 1 | Startdato på persongruppeprojekt. | |
- - - EndTime | dateTime | 0 - 1 | Slutdato på persongruppeprojekt. | |
- - - ProjectName | ProjectNameType Base: string |
Length: |
1-50 | 1 | Navn på projekt. | ||
- - CorrectionComment | CorrectionCommentType Base: string | Length: 0-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
EmptyResponse | EmptyResponseType | 1 | Tom kvittering |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse | |
---|---|---|---|
4575 | You are not authorized | You are not authorized to execute the operation | |
4589 | Unknown identifier | The submitted Identifier is unknown to the system | |
4666 | The submitted PersonGroupProjectIdentifier is unknown to the system | ||
4643 | The startdate must 4636 | Enddate cannot be before startdate | Enddate cannot be before startdate |
4643 | The startdate must not be in the past | The startdate must not be in the past |
...
DeletePersonGroupProject
Metode til at
...
Det er fjernet at man skal angive JobcenterIdentifier (og den type den var indlejret i), da den er redundant ift. metadata for kaldende organisation.
Base: string
slette et persongruppeprojekt.
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
DeletePersonGroupProjectRequest | DeletePersonGroupProjectRequestType | 1 | Forespørgsel som indeholder data vedr. sletning af et persongruppeprojekt. | |
- PersonGroupProjectIdentifier | 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 | Identifikation af persongruppeprojektet. |
- CorrectionComment | CorrectionCommentType Base: string | Length: 0-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|
EmptyResponse |
EmptyResponseType | 1 |
Base: string
Base: string
- - - - - - AuthorityCode
Tom kvittering |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
4575 | You are not authorized | You are not authorized to execute the operation |
4589 | Unknown identifier | The submitted Identifier is unknown to the system |
4666 | The submitted PersonGroupProjectIdentifier is unknown to the system | |
4643 | The startdate must not be in the past | The startdate must not be in the past |
GetPersonGroupProjects
Metode til at hente persongruppeprojekter. Omdøbes så det tydeligt fremgår at response kan indeholde mange projekter. Hentningen er generel hvis man er STAR og myndighedsspecifik for a-kasser og jobcentre, idet vi bruger metadata til at vælge den a-kasse eller det jobcenter der skal returneres projekter for.
Det er fjernet at man skal angive JobcenterIdentifier (og den type den var indlejret i), da den er redundant ift. metadata for kaldende organisation.
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetPersonGroupProjectRequest | GetPersonGroupProjectRequestType | 1 | Forespørgsel som indeholder data vedr. det persongruppeprojekt der ønskes. | |
- GetPersonGroupProject | GetPersonGroupProjectType | 1 | Indeholder information om det persongruppeprojekt der ønskes. | |
- - JobCenterIdentifier | JobCenterIdentifierType Base: string | Pattern: [0-9]{5} | 0 - 1 | Id på jobcenter. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse | ||
---|---|---|---|---|---|---|
GetPersonGroupProjectResponse | GetPersonGroupProjectResponseType | 1 | Svar som indeholder det ønskede persongruppeprojekt. | |||
- PersonGroupProjectCollection | PersonGroupProjectCollectionType | 1 | Placeholder for liste af persongruppeprojekt objekter. | |||
- - PersonGroupProject | PersonGroupProjectType | 0 - * | Indholder liste af persongruppeprojekt objekter. | |||
- - - PersonGroupProjectIdentifier | 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 | Identifikation af persongruppeprojektet. | ||
- - - PersonGroupProjectItem | PersonGroupProjectItemType | 1 | Indholder detaljer for persongruppeprojekt objektet. | |||
- - - - StartTime | dateTime | 1 | Startdato på persongruppeprojekt. | |||
- - - - EndTime | dateTime | 0 - 1 | Slutdato på persongruppeprojekt. | |||
- - - - | - - OrganisationTypeIdentifier1 | MyndighedstypePersonGroupProjectTypeIdentifier | CodeListItemIdentifierType | MaxInclusive: 10000000 | 1 | Projekttypen, der har betydning for hvem der kan se projektet – se kodeliste for værdier |
- - - CorrectionComment - ProjectName | CorrectionCommentTypeProjectNameType Base: string | Length: 01-150050 | 0 - 1 | Kommentar til berigtigelse af en registrering. |
...
Navn på projekt. | ||||
- - - - ParticipatingAuthorityCollection | AuthorityStructureType | 1 | En liste med deltagende myndigheder (a-kasser og jobcentre). Ved projekter af typen 1 - |
...
Stat - jobcentre |
...
Fejlkoder
...
...
...
...
CreatePersonGroupMarking
Denne servicemetode benyttes til at oprette en persongruppemarkering.
Input
, indeholder listen udelukkende et ParticipationIndicatedByProjectType objekt som repræsenterer alle jobcentre. | ||||
- - - - - ParticipationIndicatedByProjectType | boolean | 1 | Indikation på at deltagende myndigheder kun er angivet i kraft af projekttypen, da alle myndigheder deltager i denne projekttype. | |
- - - - - ParticipatingAuthority | 0 - * | En deltagende myndighed | ||
- - - - - - AuthorityCode | 1 | Myndighedskode | ||
- - - - - - AuthorityName | 1 | Myndighedsnavn | ||
- - - - - - OrganisationTypeIdentifier | 1 | Myndighedstype | ||
- - - CorrectionComment | CorrectionCommentType Base: string |
Length: |
Base: string
0-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering. |
Bemærk ParticipationIndicatedByProjectType objektet som sættes til true ved projekter af typen 1 - "Stat - jobcentre", og derved indikerer at alle jobcentre er med i denne type projekt.
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
4988 | The external operator does not have an active partial agreement with the requested jobcenter | The external operator does not have an active partial agreement with the requested jobcenter |
4667 | You are not allowed to see this project | |
4666 | The submitted PersonGroupProjectIdentifier is unknown to the system | |
¤XX9 | The indicated authority identifier is not known in the system |
CreatePersonGroupMarking
Denne servicemetode benyttes til at oprette en persongruppemarkering.
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|
CreatePersonGroupMarkingRequest |
- CreatedItemIdentifier
CreatePersonGroupMarkingRequestType | 1 |
- PersonGroupMarking | PersonGroupMarkingType | 1 | ||
- - PersonCivilRegistrationIdentifier | PersonCivilRegistrationIdentifierType Base: string | Pattern: |
(forkortet af praktiske hensyn) | 1 | Personnummer | ||
- - PersonGroupMarkingStartTime | dateTime | 1 | Startdato og -tidspunkt for tilknytningen til projektet. | |
- - PersonGroupMarkingEndTime | dateTime | 0 - 1 | Slutdato og -tidspunkt for tilknytningen til projektet. | |
- - PersonGroupProjectIdentifier | guid Base: string | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[ |
0-9a-fA-F]{4}-[ |
Fejlkode | Fejltekst|
---|---|
0-9a-fA-F]{12} | 1 |
Fejlkoder
Identificering af det persongruppeprojekt der skal tilknyttes til |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|
CreatedResponse | CreatedResponseType | 1 | Kvittering som indeholder den unikke identifikation for den oprettede entitet | |
- CreatedItemIdentifier | 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 identifikation for den oprettede entitet |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | Failed to validate message | The submitted message could not be validated |
1001 | Invalid cpr | The submitted cpr is either to long or short or contains data not interpretable as a date |
1010 | Unknown cpr | The submitted cpr is unknown to the system |
4404 | The person with specified cpr does not exist | The person with specified cpr does not exist |
4405 | The person with specified cpr is dead | The person with specified cpr is dead |
4666 | The submitted PersonGroupProjectIdentifier is unknown to the system | The submitted PersonGroupProjectIdentifier is unknown to the system |
4667 | You are not allowed to see this project | You are not allowed to see this project |
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 |
Fejlkoder med rødt udgår, da de hører til listen af standardkoder som kan fås på næsten alle services.
...
Metoden bruges til at hente borgertilknytninger for et specifikt projekt. Hvis der angives et tidsrum med start- og slutdato returneres udelukkende tilknytninger som er aktive indenfor denne periode (bemærk at dette er en udvidelse ift. den logik der har fungeret på version 6, hvor der udelukkende returneredes tilknytninger hvis start- og slutdato var indeholdt i den angivne tidsperiode)
Der tilføjes en ResponsibleAuthority som er den myndighed som har lov til at opdatere og lukke persongruppetilknytningen.
Inputreturneres udelukkende tilknytninger som er aktive indenfor denne periode (bemærk at dette er en udvidelse ift. den logik der har fungeret på version 6, hvor der udelukkende returneredes tilknytninger hvis start- og slutdato var indeholdt i den angivne tidsperiode)
Der tilføjes en ResponsibleAuthority som er den myndighed som har lov til at opdatere og lukke persongruppetilknytningen. Der tilføjes info om borgers aktuelle jobcenter, og - for type 5 projekter - borgers aktuelle a-kasse.
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetPersonGroupProjectMarkingsRequest | GetPersonGroupProjectMarkingsRequestType | 1 | Forespørgsel som indeholder data vedr. den persongruppemarkering der ønskes. | |
- PersonGroupProjectIdentifier | 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 | Identifikation af persongruppeprojektet. |
- StartDate | dateTime | 0 - 1 | Startdato på ønsket periode for tilknytninger | |
- EndDate | dateTime | 0 - 1 | Slutdato på ønsket periode for tilknytninger |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|
GetPersonGroupProjectMarkingsResponse |
GetPersonGroupProjectMarkingsResponseType | 1 |
Svar som indeholder |
persongruppemarkeringer. | ||||
- PersonGroupProjectMarkings | PersonGroupProjectMarkingsType | 1 | Placeholder for liste af PersonGroupProjectMarking objekter. | |
- - PersonGroupProjectMarking | PersonGroupProjectMarkingType | 0 - * | Indholder liste af PersonGroupProjectMarking objekter. | |
- - - PersonGroupMarkingIdentifier | 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 | Identifikation af |
persongruppetilknytningen. |
- |
Output
- - PersonCivilRegistrationIdentifier | string | 1 | CPR-nr på borgeren som er knyttet til persongruppeprojektet. | |
- - |
- PersonNameStructure |
PersonNameStructureType |
1 | Indholder |
detaljer af borgerens navn |
- - - |
- PersonGivenName | PersonGivenNameType Base: string |
Length: |
1-50 | 1 | Borgers fornavn | ||
- - - - PersonMiddleName | PersonMiddleNameType Base: string | Length: 1-40 | 0 - 1 | Borgers mellemnavn |
- - - - PersonSurnameName | PersonSurnameNameType Base: string | Length: 1-40 | 1 | Borgers efternavn |
- - - PostCodeIdentifier | PostCodeIdentifierType Base: string | Pattern: [0-9]{4} | 1 | Postnummeret for borgers bopæl |
- - - |
UnemploymentFundInfo | 0 - 1 | Borgers aktuelle a-kasse, udfyldes kun ved type 5 projekter | ||
- - - - |
UnemploymentFundCode |
int |
MinInclusive: |
0 |
MaxInclusive: |
99 | 1 |
Kode på a-kasse. |
- - - - |
Base:
UnemploymentFundName | string | Length: 1- |
100 | 1 | Navn på a-kasse. | ||
- - - JobcenterInfo | 1 | Borgers |
aktuelle jobcenter. |
- - - - |
Base:
JobcenterIdentifier | 1 |
Kode på jobcenter |
- - - |
Base: string
- JobcenterName | 1 | Navn på jobcenter | ||
- - - ResponsibleAuthority | 1 | Den myndighed som har oprettet tilknytningen og kan opdatere den | ||
- - - - AuthorityCode | 1 | Myndighedskode | ||
- - - - OrganisationTypeIdentifier | 1 | Myndighedstype | ||
- - - - UserFullName | 1 | Sagsbehandler navn aht. kontakt mhp. samarbejde | ||
- - - - |
UserIdentifier | 1 |
Sagsbehandler id |
- - - - |
UserEmail | 1 |
Sagsbehandler email aht. kontakt mhp. samarbejde |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
4666 | The submitted PersonGroupProjectIdentifier is unknown to the system |
...
Der tilføjes en ResponsibleAuthority som er den myndighed som har lov til at opdatere og lukke persongruppetilknytningen. Der tilføjes info om borgers aktuelle jobcenter, og - for type 5 projekter - borgers aktuelle a-kasse.
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetPersonGroupProjectMarkingsByCaseWorkerRequest | GetPersonGroupProjectMarkingsByCaseWorkerRequestType | 1 | Forespørgsel som indeholder data vedr. de persongruppeprojekter der ønskes. | |
- PersonGroupProjectIdentifier | 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 | Identifikation af persongruppeprojektet. |
- StartDate | dateTime | 0 - 1 | Startdato på ønsket periode for tilknytninger | |
- EndDate | dateTime | 0 - 1 | Slutdato på ønsket periode for tilknytninger | |
- RegisteringCaseworkerIdentifier | string | 0 - 1 | Den sagsbehandler som der ønskes persongruppeprojekttilknytninger for. |
...
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 Identifier is unknown to the system |
9400 | Only project type 5 allows adding authorities | |
9401 | The participating authority is unknown to DFDG | |
9402 | The list of participating authorities cannot contain duplicates | |
9403 | The project is not open for adding participating authorities |
...
Metode til at fjerne myndigheder fra tværgående persongruppeprojekter. Metoden kan kun kaldes af STAR.
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
...Request | ...RequestType | 1 | Forespørgsel som indeholder data vedr. opdatering af et persongruppeprojekt. | |
- PersonGroupProjectIdentifier | 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 | Identifikation af persongruppeprojektet. |
- Authority | RequestOrganisationStructureType | 1 | Identifikation af den myndighed der skal tilknyttes | |
- - AuthorityCode | 1 | Myndighedskode | ||
- - OrganisationTypeIdentifier | 1 | Myndighedstype |
...
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 Identifier is unknown to the system |
9400 | Only project type 5 allows adding authorities | |
9403 | The project is not open for adding participating authorities | |
9404 | The authority is not part of the project |
...