PersonAdvancedSearchService (Version 3, 2019-4)
Siden opdateres automatisk til at afspejle koden. CodeFirst.
Metoder
PersonAdvancedSearch
Servicemetode der kan fremsøge en flere cpr numre på baggrund af forskellige data, eksempelvis om personen er tilmeldt en a-kasse m.m.
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 |
---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
Ikke defineret
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
PersonAdvancedSearchRequest | PersonAdvancedSearchType |
| 1 |
|
- BaseType | PersonAdvancedSearchBase |
| 1 |
|
- - JobCenterCode | int |
| 1 | Jobcenterkode. I requestet kan det angives i hvilket jobcenter, der skal fremsøges personer i (hvis 0 søges i alle jobcentre). I responset returneres hvilket jobcenter, som personen er tilknyttet. |
- - Enrollment | boolean |
| 0 - 1 | Angivelse af tilmelding. I requestet kan det angives, hvorvidt de fremsøgte personer skal være tilmeldt eller ej (udelades denne i requestet, tages der ikke højde for tilmelding i søgningen). I responset returneres det, om personen er tilmeldt eller ej, når Enrollment er angivet i requestet eller ClientCategory er forskellig fra 0. |
- - ContactGroup | int |
| 1 | Kodelisteværdi for aktuel kontaktgruppe (ContactGroupTypeIdentifier). I requestet kan det angives i hvilken kontaktgruppe, der skal fremsøges personer i (hvis 0 søges der i alle kontaktgrupper). I responset returneres personens aktuelle kontaktgruppe, når ContactGroup i requestet er forskellig fra 0. |
- - ClientCategory | int |
| 1 | Kodelisteværdi for tilmeldekategori (ClientCategoryTypeIdentifier). I requestet kan det angives i hvilken tilmeldekategori, der skal fremsøges personer i (hvis 0 søges der i alle tilmeldekategorier). I responset returneres personens tilmeldekategori, når ClientCategory i requestet er forskellig fra 0. |
- - PersonCategory | int |
| 1 | Kodelisteværdi for personkategori (PersonCategoryTypeIdentifier). I requestet kan det angives i hvilken personkategori, der skal fremsøges personer i (hvis 0 søges der i alle personkategorier). I responset returneres personens personkategori, når PersonCategory i requestet er forskellig fra 0. |
- - HasNotAbsence | boolean |
| 0 - 1 | Angivelse af ikke igangværende fravær/fritagelser. I requestet kan det angives, hvorvidt de fremsøgte personer ikke må have igangværende fravær/fritagelser eller ej (udelades denne i requestet, tages der ikke højde for igangværende fravær/fritagelser i søgningen). I responset returneres det, om personen ikke har igangværende fravær/fritagelser eller ej, når HasNotAbsence er angivet i requestet. |
- - AbsenceTypeIdentifier |
| 0 - 1 | Angivelse af specifikt fravær. I requestet kan det angives, hvis borgere der returneres skal have et specifikt aktivt fravær tilknyttet. | |
- - UnemploymentFund | int |
| 1 | A-kasse kode. I requestet kan det angives i hvilken A-kasse, der skal fremsøges personer i (hvis -1 søges i alle A-kasser). I responset returneres hvilken A-kasse, som personen er tilknyttet, når UnemploymentFund i requestet er forskellig fra -1. |
- - Insured | boolean |
| 0 - 1 | Angivelse af, om personen er forsikret. I requestet kan det angives, hvorvidt de fremsøgte personer skal være forsikret eller ej (udelades denne i requestet, tages der ikke højde for dette i søgningen). I responset returneres det, om personen er forsikret eller ej, når Insured er angivet i requestet. |
- - AgeFromDate | dateTime |
| 0 - 1 | Start dato for søgning af personer med en given alder. I requestet kan det angives, hvornår en person tidligst må være født (udelades denne i requestet, tages der ikke højde for dette i søgningen). Der returneres ikke noget i responset. |
- - AgeToDate | dateTime |
| 0 - 1 | Slut dato for søgning af personer med en given alder. I requestet kan det angives, hvornår en person senest må være født (udelades denne i requestet, tages der ikke højde for dette i søgningen). Der returneres ikke noget i responset. |
- - HasNotAbsenceSince | dateTime |
| 0 - 1 | Benyttes sammen med HasNotAbsence til angivelse af en dato for, hvornår der kigges på ikke igangværende fravær/fritagelser (udelades denne i requestet, tager der ikke højde for dette i søgningen). Der returneres ikke noget i responset. |
- - EnrollmentPriorTo | dateTime |
| 0 - 1 | Benyttes sammen med Enrollment og/eller ClientCategory til angivelse af en dato for, hvornår der kigges på tilmeldinger (udelades denne i requestet, tages der ikke højde for dette i søgningen). Der returneres ikke noget i responset. |
- - ContactGroupPriorTo | dateTime |
| 0 - 1 | Benyttes sammen med ContactGroup til angivelse af en dato for, hvornår der kigges på den kontaktgrupper (udelades denne i requestet, tages der ikke højde for dette i søgningen). Der returneres ikke noget i responset. |
- - HasCv | boolean |
| 0 - 1 | Angivelse af, om personen har CV kundenummer. I requestet kan det angives, hvorvidt de fremsøgte personer skal have et CV kundenummer eller ej (udelades denne i requestet, tager der ikke højde for dette i søgningen). I responset returneres det, om personen har et CV kundenummer eller ej. |
- - HasIntegrationContract | boolean |
| 0 - 1 | Angivelse af om personen har en integrationskontrakt. I requestet kan det angives, hvorvidt de fremsøgte personer skal have en integrationskontrakt eller ej (udelades denne i requestet, tager der ikke højde for dette i søgningen). I responset returneres det, om personen har en integrationskontrakt eller ej. |
- - HasBenefitsGrading | boolean |
| 0 - 1 | Angivelse af personen har dagpengetællere. I requestet kan det angives, hvorvidt de fremsøgte personer skal have dagpengetællere eller ej (udelades denne i requestet, tager der ikke højde for dette i søgningen). I responset returneres det, om personen har en dagpengetællere eller ej. |
- - SelfBookingStatus | int | MinInclusive: 1 | 0 - 1 | Kodelisteværdi for om borgeren skal selvbooke. Værdierne kan være: 1 = 'Ingen aktiv frist', 2 = 'Aktiv frist', 3 = 'Straksbookingramt, fritaget pga. fravær', 4 = 'Straksbookingramt'. I requestet kan det angives en status for selvbooking, der skal fremsøges personer i (udelades denne i requestet, tager der ikke højde for dette i søgningen). I responset returneres personens aktuelle status for selvbooking. |
- NoOfRows | int |
| 1 | Antallet af personer, der skal fremsøges. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
PersonAdvancedSearchResponse | PersonAdvancedSearchDataTypeCollection |
| 1 |
|
- PersonAdvancedSearchDataType | PersonAdvancedSearchDataType |
| 0 - * |
|
- - BaseType | PersonAdvancedSearchBase |
| 1 |
|
- - - JobCenterCode | int |
| 1 | Jobcenterkode. I requestet kan det angives i hvilket jobcenter, der skal fremsøges personer i (hvis 0 søges i alle jobcentre). I responset returneres hvilket jobcenter, som personen er tilknyttet. |
- - - Enrollment | boolean |
| 0 - 1 | Angivelse af tilmelding. I requestet kan det angives, hvorvidt de fremsøgte personer skal være tilmeldt eller ej (udelades denne i requestet, tages der ikke højde for tilmelding i søgningen). I responset returneres det, om personen er tilmeldt eller ej, når Enrollment er angivet i requestet eller ClientCategory er forskellig fra 0. |
- - - ContactGroup | int |
| 1 | Kodelisteværdi for aktuel kontaktgruppe (ContactGroupTypeIdentifier). I requestet kan det angives i hvilken kontaktgruppe, der skal fremsøges personer i (hvis 0 søges der i alle kontaktgrupper). I responset returneres personens aktuelle kontaktgruppe, når ContactGroup i requestet er forskellig fra 0. |
- - - ClientCategory | int |
| 1 | Kodelisteværdi for tilmeldekategori (ClientCategoryTypeIdentifier). I requestet kan det angives i hvilken tilmeldekategori, der skal fremsøges personer i (hvis 0 søges der i alle tilmeldekategorier). I responset returneres personens tilmeldekategori, når ClientCategory i requestet er forskellig fra 0. |
- - - PersonCategory | int |
| 1 | Kodelisteværdi for personkategori (PersonCategoryTypeIdentifier). I requestet kan det angives i hvilken personkategori, der skal fremsøges personer i (hvis 0 søges der i alle personkategorier). I responset returneres personens personkategori, når PersonCategory i requestet er forskellig fra 0. |
- - - HasNotAbsence | boolean |
| 0 - 1 | Angivelse af ikke igangværende fravær/fritagelser. I requestet kan det angives, hvorvidt de fremsøgte personer ikke må have igangværende fravær/fritagelser eller ej (udelades denne i requestet, tages der ikke højde for igangværende fravær/fritagelser i søgningen). I responset returneres det, om personen ikke har igangværende fravær/fritagelser eller ej, når HasNotAbsence er angivet i requestet. |
- - - AbsenceTypeIdentifier |
| 0 - 1 | Angivelse af specifikt fravær. I requestet kan det angives, hvis borgere der returneres skal have et specifikt aktivt fravær tilknyttet. | |
- - - UnemploymentFund | int |
| 1 | A-kasse kode. I requestet kan det angives i hvilken A-kasse, der skal fremsøges personer i (hvis -1 søges i alle A-kasser). I responset returneres hvilken A-kasse, som personen er tilknyttet, når UnemploymentFund i requestet er forskellig fra -1. |
- - - Insured | boolean |
| 0 - 1 | Angivelse af, om personen er forsikret. I requestet kan det angives, hvorvidt de fremsøgte personer skal være forsikret eller ej (udelades denne i requestet, tages der ikke højde for dette i søgningen). I responset returneres det, om personen er forsikret eller ej, når Insured er angivet i requestet. |
- - - AgeFromDate | dateTime |
| 0 - 1 | Start dato for søgning af personer med en given alder. I requestet kan det angives, hvornår en person tidligst må være født (udelades denne i requestet, tages der ikke højde for dette i søgningen). Der returneres ikke noget i responset. |
- - - AgeToDate | dateTime |
| 0 - 1 | Slut dato for søgning af personer med en given alder. I requestet kan det angives, hvornår en person senest må være født (udelades denne i requestet, tages der ikke højde for dette i søgningen). Der returneres ikke noget i responset. |
- - - HasNotAbsenceSince | dateTime |
| 0 - 1 | Benyttes sammen med HasNotAbsence til angivelse af en dato for, hvornår der kigges på ikke igangværende fravær/fritagelser (udelades denne i requestet, tager der ikke højde for dette i søgningen). Der returneres ikke noget i responset. |
- - - EnrollmentPriorTo | dateTime |
| 0 - 1 | Benyttes sammen med Enrollment og/eller ClientCategory til angivelse af en dato for, hvornår der kigges på tilmeldinger (udelades denne i requestet, tages der ikke højde for dette i søgningen). Der returneres ikke noget i responset. |
- - - ContactGroupPriorTo | dateTime |
| 0 - 1 | Benyttes sammen med ContactGroup til angivelse af en dato for, hvornår der kigges på den kontaktgrupper (udelades denne i requestet, tages der ikke højde for dette i søgningen). Der returneres ikke noget i responset. |
- - - HasCv | boolean |
| 0 - 1 | Angivelse af, om personen har CV kundenummer. I requestet kan det angives, hvorvidt de fremsøgte personer skal have et CV kundenummer eller ej (udelades denne i requestet, tager der ikke højde for dette i søgningen). I responset returneres det, om personen har et CV kundenummer eller ej. |
- - - HasIntegrationContract | boolean |
| 0 - 1 | Angivelse af om personen har en integrationskontrakt. I requestet kan det angives, hvorvidt de fremsøgte personer skal have en integrationskontrakt eller ej (udelades denne i requestet, tager der ikke højde for dette i søgningen). I responset returneres det, om personen har en integrationskontrakt eller ej. |
- - - HasBenefitsGrading | boolean |
| 0 - 1 | Angivelse af personen har dagpengetællere. I requestet kan det angives, hvorvidt de fremsøgte personer skal have dagpengetællere eller ej (udelades denne i requestet, tager der ikke højde for dette i søgningen). I responset returneres det, om personen har en dagpengetællere eller ej. |
- - - SelfBookingStatus | int | MinInclusive: 1 | 0 - 1 | Kodelisteværdi for om borgeren skal selvbooke. Værdierne kan være: 1 = 'Ingen aktiv frist', 2 = 'Aktiv frist', 3 = 'Straksbookingramt, fritaget pga. fravær', 4 = 'Straksbookingramt'. I requestet kan det angives en status for selvbooking, der skal fremsøges personer i (udelades denne i requestet, tager der ikke højde for dette i søgningen). I responset returneres personens aktuelle status for selvbooking. |
- - PersonCivilRegistrationIdentifier | PersonCivilRegistrationIdentifierType | 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 | Personens CPR nummer. |
- - CvCustomerIdentifier | string | Pattern: [0-9]{8} | 0 - 1 | Personens CV kundenummer, hvis en sådan haves. |
- - Absence | int |
| 1 | Kodelisteværdi for fraværs-/fritagelsestype (AbsenceTypeIdentifier) på et af persons aktuelle fravær/fritagelser eller 0, hvis personen ikke har et aktuelt fravær/fritagelse og/eller hvis HasNotAbsence ikke er angivet i requestet. |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1010 | Unknown cpr | The submitted cpr is unknown to the system |
1013 | Insufficient permissions | User has insufficient permissions to access this webservice |
1014 | Failed to validate message | The submitted message could not be validated |