Du är här:
InsCensusServiceStd:getMembers
Använd denna tjänst för att hämta medlemmarna i en folkräkning från GroupCensusMember. Den hämtar även sidhuvudena baserat på fieldsetName.
Klass: InsCensusServiceStd
Metod: getMembers
Tjänsten accepterar inmatning i detta format.
| censusId | fieldsetName | Förskjutning | gräns | searchKey |
|---|---|---|---|---|
| c101 | test_fieldset | cmember101 | heltal | prefix |
Tjänsten använder indatavärden för att skapa utdata som passar in i din produktmodell.
| folkräkning | lastOffSet | |
|---|---|---|
| sidhuvuden | medlemmar | ID för senaste folkräkningsmedlem |
| Lista över fält | Lista över medlemmar | |
Så här fungerar det
Denna tjänst har två nyckelfunktioner:
-
Hämtar listan över
GroupCensusMemberoch sidhuvuden baserat påfieldetName. Utdata har alltidPrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifierochPrimaryMemberSourceäven om dessa fält inte ingår ifieldsetName. - Tjänsten använder
censusIdför att hämta listan över folkräkningsmedlemmar frånGroupCensusMember.- Om förskjutningen har ett värde hämtar den Primära
GroupCensusMember(ordnade efter Id) efter förskjutningen och hämtar sedan alla beroenden för dessa Primära medlemmar. Om det finns ett gränsvärde hämtar tjänsten raderna för Primär
GroupCensusMember(ordnade efter Id) som inte är större än den specificerade gränsen. Den hämtar sedan alla beroenden för dessa primära medlemmar. Gränsen får inte vara högre än 500.Om
searchKeyhar värde hämtar tjänstenGroupCensusMember(ordnade efter Id) tillsammans med motsvarande familj, som harsearchKeysom en understräng i sinaFirstNameellerLastName.Om
memberIdshar ett värde hämtar detGroupCensusMember(ordnade efter Id) vars Id är en del avmemberIds. AntingenmemberIdsellersearchKeymåste anges som indata.Om
withPlansär satt tilltruehämtar tjänsten en lista över valda planer för varje medlem. De giltigaContractGroupPlanIdför varje medlem avgränsas av ett semikolon och returneras som en sträng.Informationen som hämtas för varje medlem baseras på fälten som hämtas från
GroupCensusMember.Listan över medlemmar placeras i
members.
- Om förskjutningen har ett värde hämtar den Primära
Servicebeteende
Förstå hur olika inmatningar påverkar serviceresultaten.
| Indata | Serviceresultat |
|---|---|
Inga censusId eller ogiltiga censusId |
Tjänsten hämtar ingen folkräkningsmedlem. |
Ingen fieldsetName och giltig censusId |
|
Giltiga fieldsetName och giltiga censusId |
Tjänsten hämtar listan över GroupCensusMember som finns i den givna fältuppsättningen och listan över GroupCensusMember. |
Giltig limit |
Tjänsten hämtar listan över |
Giltig offset |
Tjänsten hämtar listan över
|
Giltig offset och giltig limit |
Tjänsten hämtar listan över
|
Giltig searchKey |
Tjänsten hämtar listan över |
Giltiga searchKey och giltiga limit |
Tjänsten hämtar listan över |
Giltig searchKey och giltig offset |
Tjänsten hämtar listan över |
Giltigt searchKey, giltigt limit och giltigt offset |
Tjänsten hämtar listan över
|
Fjärralternativ
| Alternativ | Beskrivning |
|---|---|
|
Obligatoriskt. ID för folkräkning vars medlemmar måste hämtas. |
|
Valfritt. Namn på den fältuppsättning som ska hämta Om värdet är ogiltigt returnerar tjänsten inga fält. Om det inte finns något värde använder tjänsten standardfältuppsättningen för att hämta |
|
Valfritt. Antalet folkräkningsmedlemmar som ska hämtas. |
|
Valfritt . ID för den folkräkningsmedlem efter vilken folkräkningsmedlemmarna måste hämtas. |
|
En sträng för att söka efter matchande poster för folkräkningsmedlemmar. |
Indata-JSON
Denna tjänst tar inte en indata-JSON.
JSON för utdata
Tjänsten returnerar en JSON för utdata med en lista över fält, en lista över medlemmar och ett lastOffSet.
{
"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"
}