U bent hier:
InsCensusServiceStd:getMembersWithPlans
Gebruik deze service om de lijst van leden van de volkstelling voor een bepaalde censusId op te halen. Overeenkomstig deze tellingsleden haalt de service de ContractGroupPlanIds op uit GroupCensusMemberPlan. De service haalt ook headers op basis van de fieldsetName en planFieldsetName op.
Klasse: InsCensusServiceStd
Methode: getMembersWithPlans
De manier waarop het werkt...
Deze service heeft twee belangrijke functies:
- Haalt de lijst van velden in
GroupCensusMemberenGroupCensusMemberPlanop.De service gebruikt de parameter
fieldsetNameom de lijst vanGroupCensusMemberop te halen. Als er geen waarde is, worden velden opgehaald uit de standaardveldenset. Als de opgegeven waarde geen overeenkomst vindt, worden er geen velden opgehaald.De service gebruikt de parameter
planFieldsetNameom de lijst vanGroupCensusMemberPlanop te halen. Als er geen waarde is, worden alle velden opgehaald. Als de opgegeven waarde geen overeenkomst vindt, worden er geen velden opgehaald.Haalt relatievelden op die zijn gecombineerd om het JSON-headersknooppunt te vormen, zelfs als deze velden niet zijn opgenomen in de
fieldsetName. Deze velden zijn:PrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifierenPrimaryMemberSource.Als de parameter
waarde heeft, vult deze de lijst van contractregelrecords in met de volgende details van het contract:contractGroupPlanIdNaam contractgroepsplan
Producttype
ID van de contractgroepsplannen
-
De service gebruikt
censusIdom voor elk lid de lijst van tellingsleden op te halen uitGroupCensusMemberen contractgroepsplannen uitGroupCensusMemberPlan.-
Als de verschuiving waarde heeft, haalt deze rijen Primaire
GroupCensusMember(gerangschikt op ID) op na de verschuiving en haalt vervolgens alle afhankelijkheden voor deze Primaire leden op. -
Als er een limietwaarde is, haalt de service de rijen Primaire
GroupCensusMemberop (gerangschikt op ID) die niet groter zijn dan de opgegeven limiet. Vervolgens worden alle afhankelijke personen voor deze primaire leden opgehaald. De limiet mag niet hoger zijn dan 500. -
Als
searchKeywaarde heeft, haalt de serviceGroupCensusMemberop (gerangschikt op ID) in combinatie met overeenkomende familie, diesearchKeyals een subtekenreeks in hunFirstNameofLastNameheeft. AlsGroupCensusMemberafhankelijkheden bevat, haalt de service primaire leden op die overeenkomen met die afhankelijkheden. -
Als
memberIdseen waarde heeft, haalt hetGroupCensusMemberop (gerangschikt op ID) waarvan de ID deel uitmaakt van dememberIds.memberIdsofsearchKeymoet worden ingevoerd. -
De informatie die voor elk lid wordt opgehaald, is gebaseerd op de velden die worden opgehaald uit
GroupCensusMemberenGroupCensusMemberPlan. -
De lijst van leden wordt in het
membersgeplaatst.
-
Servicewerking
Begrijp hoe verschillende invoer van invloed is op de service-uitvoer.
| Invoer | Service-uitvoer |
|---|---|
Geen |
De service haalt geen tellingslid op. |
Geen fieldsetName en geldige censusId |
De service haalt het volgende op:
|
Geldige fieldsetName en geldige censusId |
De service vermeldt GroupCensusMember volgens de opgegeven fieldsetName en haalt de lijst van GroupCensusMember op met ContractGroupPlanIds. |
Geen planFieldsetName geldige fieldsetName en geldige censusId |
De service vermeldt GroupCensusMember volgens het opgegeven veld fieldsetName, ContractGroupPlanId en Naam van GroupCensusMemberPlan. Het haalt lijst van met ContractGroupPlanIds op. |
Geldige planFieldsetName geldige fieldsetName en geldige censusId |
De service haalt het volgende op:
|
Geldige contractId |
De service haalt de naam van het contractgroepsplan, het producttype, de onderliggende producten en de ID van het contractgroepsplan op als opties in het veld ContractGroupPlanId. |
Geldige limit |
De service haalt het volgende op:
|
Geldige offset |
De service haalt het volgende op:
|
Geldige offset en geldige limit |
De service haalt het volgende op:
|
Geldige searchKey |
De service haalt het volgende op:
|
Geldige searchKey en geldige limit |
De service haalt het volgende op:
|
Geldige searchKey en geldige offset |
De service haalt het volgende op:
|
Geldige searchKey, geldige limit en geldige offset |
De service haalt het volgende op:
|
Externe opties
| Opties | Beschrijving |
|---|---|
|
Verplicht. ID van telling waarvan leden moeten worden opgehaald. |
|
Verplicht . ID van het huidige contract van de account. Haalt de naam, het producttype en de contractgroep van het contractgroepsplan op |
|
Optioneel. Naam van het veld dat is ingesteld om de velden GroupCensusMember op te halen. Als de waarde ongeldig is, retourneert de service geen velden. Als er geen waarde is, gebruikt de service de standaardveldset om GroupCensusMember-velden op te halen. |
|
Optioneel. Haalt de velden GroupCensusMemberPlan en GroupCensusMember op wanneer er een geldige veldsetwaarde voor het plan is. Er worden geen velden geretourneerd als de waarde niet geldig is. Alle velden van GroupCensusMemberPlan worden geretourneerd wanneer er geen waarde is. |
|
Optioneel. Het aantal op te halen volkstellingsleden. |
|
Optioneel . De ID van het tellingslid waarna de tellingsleden moeten worden opgehaald. |
|
Een tekenreeks om te zoeken naar overeenkomende records van tellingsleden. |
Invoer-JSON
Deze service gebruikt geen invoer-JSON.
Uitvoer-JSON
De service retourneert een uitvoer-JSON-indeling zoals in het onderstaande voorbeeld. De uitvoer bevat details voor de leden in de telling, waarbij headers een lijst van veld-API-namen van GroupCensusMember en GroupCensusMemberPlan is. Het knooppunt members retourneert een lijst van geselecteerde plannen voor het lid, samen met ContractGroupPlanId, gescheiden met ;. Het veld lastOffset toont de ID van het laatste tellingslid dat wordt opgehaald. Deze waarde kan worden gebruikt als de parameter offset om de volgende rijen te krijgen.
Hier is de voorbeelduitvoer-JSON-indeling:
{
"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"
}Hier is de voorbeelduitvoer-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"
}