breadcrumbDescription
InsCensusServiceStd:getMembers
Brug denne tjeneste til at hente medlemmerne af en folketælling fra GroupCensusMember. Det henter også sidehovederne baseret på fieldsetName.
Kategori: InsCensusServiceStd
Metode: getMembers
Tjenesten accepterer input i dette format.
| censusId | fieldsetName | Forskydning | grænse | searchKey |
|---|---|---|---|---|
| c101 | test_fieldset | cmember101 | heltal | prefix |
Tjenesten bruger inputværdier til at generere output, der passer ind i din produktmodel.
| folketælling | lastOffSet | |
|---|---|---|
| sidehoveder | medlemmer | Id for det sidste optællingsmedlem |
| Liste over felter | Liste over medlemmer | |
Sådan fungerer det
Denne tjeneste har to nøglefunktioner:
-
Henter listen over
GroupCensusMemberfelter og sidehoveder baseret påfieldetName. Outputtet har altidPrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifierogPrimaryMemberSource, selvom disse felter ikke er inkluderet ifieldsetName. - Tjenesten bruger
censusIdtil at hente listen over folketællingsmedlemmer fraGroupCensusMember.- Hvis forskydningen har værdi, henter den Rækker med primære
GroupCensusMember(arrangeret efter Id) efter forskydningen og henter derefter alle afhængige for disse primære medlemmer. Hvis der er en grænseværdi, henter tjenesten de primære
GroupCensusMemberrækker (arrangeret efter Id), der ikke er større end den angivne grænse. Den henter derefter alle afhængige for disse primære medlemmer. Grænsen må ikke være på mere end 500.Hvis
searchKeyhar værdi, henter tjenestenGroupCensusMemberrækker (arrangeret med Id) sammen med den tilsvarende familie, som harsearchKeysom en delstreng til stede i deresFirstNameellerLastName.Hvis
memberIdshar en værdi, henter denGroupCensusMemberrækker (arrangeret efter Id), hvis Id er en del afmemberIds-matrixen. EntenmemberIdsellersearchKeyskal angives i input.Hvis
withPlanser indstillet tiltrue, henter tjenesten en liste over valgte planer for hvert medlem. De gyldigeContractGroupPlanIdfor hvert medlem afgrænses af et semikolon og returneres som en streng.De oplysninger, der hentes for hvert medlem, er baseret på de felter, der hentes fra
GroupCensusMember.Listen over medlemmer placeres i
members.
- Hvis forskydningen har værdi, henter den Rækker med primære
Serviceadfærd
Forstå, hvordan forskellige input påvirker serviceoutput.
| Input | Serviceoutput |
|---|---|
Ingen censusId eller ugyldig censusId |
Tjenesten henter ingen optællingsmedlemmer. |
Ingen fieldsetName og gyldig censusId |
|
Gyldig fieldsetName og gyldig censusId |
Tjenesten henter listen over GroupCensusMember felter i det angivne feltsæt og listen over GroupCensusMember. |
Gyldig limit |
Tjenesten henter listen over |
Gyldig offset |
Tjenesten henter listen over
|
Gyldig offset og gyldig limit |
Tjenesten henter listen over
|
Gyldig searchKey |
Tjenesten henter listen over |
Gyldig searchKey og gyldig limit |
Tjenesten henter listen over |
Gyldig searchKey og gyldig offset |
Tjenesten henter listen over |
Gyldig searchKey, gyldig limit og gyldig offset |
Tjenesten henter listen over
|
Fjernindstillinger
| Indstillinger | Beskrivelse |
|---|---|
|
Påkrævet. Id for den folketælling, hvis medlemmer skal hentes. |
|
Valgfrit. Navn på det feltsæt, der skal hentes Hvis værdien er ugyldig, returnerer tjenesten ingen felter. Hvis der ikke er nogen værdi, bruger tjenesten standardfeltet til at hente |
|
Valgfrit. Antallet af folketællingsmedlemmer, der skal hentes. |
|
Valgfrit. Id'et på folketællingsmedlemmet, hvorefter folketællingsmedlemmerne skal hentes. |
|
En streng til at søge efter matchende registreringer for optællingsmedlemmer. |
Input JSON
Denne tjeneste bruger ikke et input-JSON.
Output JSON
Tjenesten returnerer et output-JSON med en liste over felter, en liste over medlemmer og en lastOffSet værdi.
{
"census":{
"members":[
{
"Id":"a4C4P000000dNdbUAE",
"LastName":member1,
"FirstName":primary,
"Birthdate":"1999-08-08"
},
{
"Id":"a4C4P000000dNdcUAE",
"LastName":member1,
"FirstName":dependent,
"Birthdate":"1994-08-08"
},
{
"Id":"a4C4P000000dNdeUAE",
"LastName":member2,
"FirstName":primary,
"Birthdate":"1985-08-08"
}
],
"headers":[
{
"type":"STRING",
"label":"First Name",
"fieldId":"",
"name":"FirstName"
},
{
"type":"DATE",
"label":"Birthday",
"fieldId":"",
"name":"Birthdate"
},
{
"type":"STRING",
"label":"Last Name",
"fieldId":"",
"name":"LastName"
}
]
},
"lastOffset" : "a4C4P000000dNdeUAE"
}