Du är här:
InsCensusServiceStd:getMembersWithPlans
Använd denna tjänst för att hämta listan över folkräkningsmedlemmar för en given censusId. Motsvarande dessa folkräkningsmedlemmar hämtar tjänsten ContractGroupPlanIds från GroupCensusMemberPlan. Tjänsten hämtar även sidhuvuden baserat på fieldsetName och planFieldsetName.
Klass: InsCensusServiceStd
Metod: getMembersWithPlans
Så här fungerar det
Denna tjänst har två nyckelfunktioner:
- Hämtar listan över fält i
GroupCensusMemberochGroupCensusMemberPlan.Tjänsten använder parametern
fieldsetNameför att hämta listan överGroupCensusMember. Om det inte finns något värde hämtas fält från standardfältuppsättningen. Om det angivna värdet inte hittar någon träff hämtas inga fält.Tjänsten använder parametern
planFieldsetNameför att hämta listan överGroupCensusMemberPlan. Om det inte finns något värde hämtas alla fält. Om det angivna värdet inte hittar någon träff hämtas inga fält.Hämtar relationsfält som kombineras för att bilda JSON-sidhuvudnoden även om dessa fält inte är inkluderade i
fieldsetName. Dessa fält är:PrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifierochPrimaryMemberSource.Om parametern
har värde fyller den i listan över kontraktradposter med följande detaljer om kontraktet:contractGroupPlanIdNamn på kontraktgruppplan
Produkttyp
ID för kontraktgruppplanerna
-
Tjänsten använder
censusIdför att hämta listan över folkräkningsmedlemmar frånGroupCensusMemberoch kontraktgruppplaner frånGroupCensusMemberPlanför varje medlem.-
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. OmGroupCensusMemberinnehåller beroenden hämtar tjänsten primära medlemmar som motsvarar dessa beroenden. -
Om
memberIdshar ett värde hämtar detGroupCensusMember(ordnade efter Id) vars Id är en del avmemberIds. AntingenmemberIdsellersearchKeymåste anges som indata. -
Informationen som hämtas för varje medlem baseras på fälten som hämtas från
GroupCensusMemberochGroupCensusMemberPlan. -
Listan över medlemmar placeras i
members.
-
Servicebeteende
Förstå hur olika inmatningar påverkar serviceresultaten.
| Indata | Serviceresultat |
|---|---|
Inga |
Tjänsten hämtar ingen folkräkningsmedlem. |
Ingen fieldsetName och giltig censusId |
Tjänsten hämtar:
|
Giltiga fieldsetName och giltiga censusId |
Tjänsten listar GroupCensusMember enligt det specificerade fieldsetName och hämtar listan över GroupCensusMember med ContractGroupPlanIds. |
Inga planFieldsetName giltiga fieldsetName och giltiga censusId |
Tjänsten listar GroupCensusMember enligt det specificerade fältet fieldsetName, ContractGroupPlanId och Namn för GroupCensusMemberPlan. Den hämtar en lista över med ContractGroupPlanIds. |
planFieldsetName Giltigt fieldsetName och giltigt censusId |
Tjänsten hämtar:
|
Giltig contractId |
Tjänsten hämtar namnet på kontraktgruppens plan, produkttyp, underordnade produkter och ID för kontraktgruppens plan som alternativ i ContractGroupPlanId. |
Giltig limit |
Tjänsten hämtar:
|
Giltig offset |
Tjänsten hämtar:
|
Giltig offset och giltig limit |
Tjänsten hämtar:
|
Giltig searchKey |
Tjänsten hämtar:
|
Giltiga searchKey och giltiga limit |
Tjänsten hämtar:
|
Giltiga searchKey och giltiga offset |
Tjänsten hämtar:
|
Giltigt searchKey, giltigt limit och giltigt offset |
Tjänsten hämtar:
|
Fjärralternativ
| Alternativ | Beskrivning |
|---|---|
|
Obligatoriskt. ID för folkräkning vars medlemmar måste hämtas. |
|
Required. ID för kontots aktuella kontrakt. Hämtar namnet på kontraktgruppens plan, produkttyp och kontraktgrupp |
|
Valfritt. Namn på fältuppsättning för att hämta GroupCensusMember-fälten. 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 GroupCensusMember-fält. |
|
Valfritt. Hämtar fälten GroupCensusMemberPlan och GroupCensusMember när det finns ett giltigt värde för uppsättning av planfält. Inga fält returneras om värdet inte är giltigt. Alla GroupCensusMemberPlan-fält returneras om det inte finns något värde. |
|
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-utdataformat enligt exemplet nedan. Utdata har detaljer om medlemmarna i folkräkningen, där sidhuvuden är en lista över fältens API-namn på GroupCensusMember och GroupCensusMemberPlan. members returnerar listan över valda planer för medlemmen tillsammans med ContractGroupPlanId avgränsat av ;. Fältet lastOffset visar ID för den senaste folkräkningsmedlemmen som hämtades. Detta värde kan användas som offset-parameter för att få nästa rader.
Här är JSON-formatet för exempelutdata:
{
"census":{
"members":[
{
"ContractGroupPlanId":"ID1;ID2",
"Id":"ID",
"fieldAPI1":"value"
}
],
"headers":[
{
"type":"field type",
"label":"field label",
"fieldId":"",
"name":"fieldAPI1"
},
{
"options":[
{
"value":"ID",
"type":"Product Type",
"name":"Contract Group Plan Name"
}
],
"type":"REFERENCE",
"label":"Plan",
"fieldId":"",
"name":"ContractGroupPlanId"
}
]
},
"lastOffset" : "census member Id"
}Här är exempelutdata-JSON:
{
"census":{
"members":[
{
"ContractGroupPlanId":"",
"Id":"a4C4P000000dNdbUAE",
"LastName":member1,
"FirstName":primary,
"Birthdate":"1999-08-08"
},
{
"ContractGroupPlanId":"a2N4P000006ygEjUAI",
"Id":"a4C4P000000dNdcUAE",
"LastName":member1,
"FirstName":dependent,
"Birthdate":"1994-08-08"
},
{
"ContractGroupPlanId":"a2N4P000006ygEjUAI;a2N4P000006ygEiUAI",
"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"
},
{
"type":"REFERENCE",
"label":"Plan",
"fieldId":"",
"name":"ContractGroupPlanId",
"options":[
{
"value":"a2N4P000006ygEiUAI",
"type":"Medical",
"name":"rootProd",
"childProducts": [
{
"value": "0rgDC000000000RYAQ",
"IsOptional": false,
"name": "MandatoryCoverage"
},
{
"value": "0rgDC000000000RYBQ",
"IsOptional": true,
"name": "OptionalCoverage"
}
]
},
{
"value":"a2N4P000006ygEjUAI",
"type":"Dental",
"name":"rootProd2",
"childProducts": [
{
"value": "0rgDC000000000RYCQ",
"IsOptional": false,
"name": "MandatoryCoverage"
},
{
"value": "0rgDC000000000RYDQ",
"IsOptional": true,
"name": "OptionalCoverage"
}
]
}
]
}
]
},
"lastOffset" : "a4C4P000000dNdeUAE"
}