Du er her:
InsCensusServiceStd:getMembers
Bruk denne tjenesten til å hente medlemmene av en folketelling fra GroupCensusMember. Den henter også hodene basert på fieldsetName.
Klasse: InsCensusServiceStd
Metode: getMembers
Tjenesten godtar inndata i dette formatet.
| censusId | fieldsetName | Forskyvning | grense | searchKey |
|---|---|---|---|---|
| c101 | test_fieldset | cmember101 | heltall | prefiks |
Tjenesten bruker inndataverdier til å generere utdata som passer inn i produktmodellen.
| folketelling | lastOffSet | |
|---|---|---|
| headers | medlemmer | ID for siste folketellingsmedlem |
| Liste over felt | Liste over medlemmer | |
Slik virker det
Denne tjenesten har to nøkkelfunksjoner:
-
Henter listen over
GroupCensusMember-felt og -hoder basert påfieldetName. Utdataene har alltidPrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifierogPrimaryMemberSourceselv om disse feltene ikke er inkludert ifieldsetName. - Tjenesten bruker
censusIdtil å hente listen over folketellingsmedlemmer fraGroupCensusMember.- Hvis forskyvningen har en verdi, henter den Primære
GroupCensusMember-rader (sortert etter Id) etter forskyvningen, og henter deretter alle avhengige for disse Primære medlemmene. Hvis det er en grenseverdi, henter tjenesten de primære
GroupCensusMember-radene (sortert etter Id) som ikke er større enn den angitte grensen. Den henter deretter alle avhengige for disse primære medlemmene. Grensen kan ikke være mer enn 500.Hvis
searchKeyhar verdi, henter tjenestenGroupCensusMemberrader (sortert med Id) sammen med tilhørende familie, som harsearchKeysom en delstreng til stede i sinFirstNameellerLastName.Hvis
memberIdshar en verdi, henter denGroupCensusMember-rader (sortert etter Id) der Id er en del avmemberIds-matrisen. EntenmemberIdsellersearchKeymå oppgis i inndata.Hvis
withPlanser satt tiltrue, henter tjenesten en liste over valgte planer for hvert medlem. GyldigeContractGroupPlanIdfor hvert medlem avgrenses av et semikolon og returneres som en streng.Informasjonen som hentes for hvert medlem, er basert på feltene som hentes fra
GroupCensusMember.Medlemslisten plasseres i
members-noden.
- Hvis forskyvningen har en verdi, henter den Primære
Virkemåte for service
Forstå hvordan forskjellige inndata påvirker tjenesteutdataene.
| Inndata | Tjenesteutdata |
|---|---|
Ingen censusId eller ugyldig censusId |
Tjenesten henter ikke noe folketellingsmedlem. |
Ingen fieldsetName og gyldig censusId |
|
Gyldig fieldsetName og gyldig censusId |
Tjenesten henter listen over GroupCensusMember-felt som finnes i det gitte feltsettet, 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
|
Eksterne alternativer
| Options | Description |
|---|---|
|
Obligatorisk. ID-en til folketellingen der medlemmer må hentes. |
|
Valgfritt. Navnet på feltsettet som skal hente Hvis verdien er ugyldig, returnerer ikke tjenesten noen felt. Hvis det ikke er noen verdi, bruker tjenesten standardfeltsettet til å hente |
|
Optional. Antall folketellingsmedlemmer som skal hentes. |
|
Optional. ID-en til folketellingsmedlemmet som folketellingsmedlemmene må hentes etter. |
|
En streng for å søke etter samsvarende poster for folketellingsmedlemmer. |
Inndata-JSON
Denne tjenesten bruker ikke en inndata-JSON.
Utdata-JSON
Tjenesten returnerer en utdata-JSON-fil med en liste over felt, en liste over medlemmer og en lastOffSet-verdi.
{
"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"
}