Sie befinden sich hier:
InsCensusServiceStd:getMembersWithPlans
Verwenden Sie diesen Service, um die Liste der Volkszählungsmitglieder für einen bestimmten censusId abzurufen. Entsprechend diesen Zählungsmitgliedern ruft der Service die ContractGroupPlanIds aus GroupCensusMemberPlan ab. Der Service ruft auch Kopfzeilen basierend auf den fieldsetName und planFieldsetName ab.
Klasse: InsCensusServiceStd
Methode: getMembersWithPlans
Funktionsweise
Dieser Service verfügt über zwei wichtige Funktionen:
- Ruft die Liste der Felder in
GroupCensusMemberundGroupCensusMemberPlanab.Der Service verwendet den Parameter
fieldsetName, um die Liste derGroupCensusMemberabzurufen. Wenn kein Wert vorhanden ist, werden Felder aus dem Standardfeldset abgerufen. Wenn der eingegebene Wert keine Übereinstimmung findet, werden keine Felder abgerufen.Der Service verwendet den Parameter
planFieldsetName, um die Liste derGroupCensusMemberPlanabzurufen. Wenn kein Wert vorhanden ist, werden alle Felder abgerufen. Wenn der eingegebene Wert keine Übereinstimmung findet, werden keine Felder abgerufen.Ruft Beziehungsfelder ab, die zum Knoten "JSON-Kopfzeilen" kombiniert werden, selbst wenn diese Felder nicht im
fieldsetNameenthalten sind. Die folgenden Felder sind:PrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifierundPrimaryMemberSource.Wenn der Parameter
contractGroupPlanIdName des Vertragsgruppenplans
Produkttyp
ID der Vertragsgruppenpläne
-
Der Service verwendet
censusId, um die Liste der Volkszählungsmitglieder ausGroupCensusMemberund Vertragsgruppenplänen ausGroupCensusMemberPlanfür jedes Mitglied abzurufen.-
Wenn der Versatz einen Wert aufweist, werden nach dem Versatz die Zeilen der primären
GroupCensusMember(geordnet nach ID) und dann alle abhängigen Elemente für diese primären Mitglieder abgerufen. -
Wenn ein Grenzwert vorhanden ist, ruft der Service die Zeilen vom Typ "Primäre
GroupCensusMember" (geordnet nach ID) ab, die die angegebene Obergrenze nicht überschreiten. Anschließend werden alle abhängigen Mitglieder für diese primären Mitglieder abgerufen. Die Obergrenze darf 500 nicht überschreiten. -
Wenn
searchKeyeinen Wert aufweist, ruft der ServiceGroupCensusMember(geordnet nach ID) zusammen mit der entsprechenden Familie ab, in dersearchKeyals untergeordnete Zeichenfolge in derFirstNameoderLastNamevorhanden ist. WennGroupCensusMemberabhängige Mitglieder enthält, ruft der Service primäre Mitglieder ab, die diesen abhängigen Mitgliedern entsprechen. -
Wenn
memberIdsüber einen Wert verfügt, werdenGroupCensusMember(geordnet nach ID) abgerufen, deren ID Teil des ArraysmemberIdsist. Entweder müssenmemberIdsodersearchKeyeingegeben werden. -
Die für jedes Mitglied abgerufenen Informationen basieren auf den aus
GroupCensusMemberundGroupCensusMemberPlanabgerufenen Feldern. -
Die Liste der Mitglieder wird im
membersplatziert.
-
Serviceverhalten
Erfahren Sie, wie sich unterschiedliche Eingaben auf die Serviceausgaben auswirken.
| Eingabe | Serviceausgabe |
|---|---|
Keine |
Der Service ruft kein Volkszählungsmitglied ab. |
Nein fieldsetName und gültige censusId |
Der Service ruft Folgendes ab:
|
Gültige fieldsetName und gültige censusId |
Der Service listet GroupCensusMember gemäß der angegebenen fieldsetName auf und ruft die Liste der GroupCensusMember mit ContractGroupPlanIds ab. |
Keine planFieldsetName gültigen fieldsetName und gültigen censusId |
Der Service listet GroupCensusMember gemäß dem angegebenen fieldsetName, ContractGroupPlanId und Namensfeld von GroupCensusMemberPlan auf. Es ruft eine Liste der ContractGroupPlanIds ab. |
Gültige planFieldsetName gültige fieldsetName und gültige censusId |
Der Service ruft Folgendes ab:
|
Gültige contractId |
Der Service ruft den Namen des Vertragsgruppenplans, den Produkttyp, die untergeordneten Produkte und die Vertragsgruppenplan-ID als Optionen im Kopfzeilenfeld "ContractGroupPlanId" ab. |
Gültige limit |
Der Service ruft Folgendes ab:
|
Gültige offset |
Der Service ruft Folgendes ab:
|
Gültige offset und gültige limit |
Der Service ruft Folgendes ab:
|
Gültige searchKey |
Der Service ruft Folgendes ab:
|
Gültige searchKey und gültige limit |
Der Service ruft Folgendes ab:
|
Gültige searchKey und gültige offset |
Der Service ruft Folgendes ab:
|
Gültige searchKey, gültige limit und gültige offset |
Der Service ruft Folgendes ab:
|
Remote-Optionen
| Optionen | Beschreibung |
|---|---|
|
Erforderlich. ID der Volkszählung, deren Mitglieder abgerufen werden müssen. |
|
Erforderlich. ID der aktuellen Verträge des Accounts. Ruft den Namen des Vertragsgruppenplans, den Produkttyp und die Vertragsgruppe ab |
|
Optional. Name des Feldsets zum Abrufen der GroupCensusMember-Felder. Wenn der Wert ungültig ist, gibt der Service keine Felder zurück. Wenn kein Wert vorhanden ist, verwendet der Service das Standardfeldset, um GroupCensusMember-Felder abzurufen. |
|
Optional. Ruft die Felder GroupCensusMemberPlan und GroupCensusMember ab, wenn ein gültiger Planfeldsetwert vorhanden ist. Wenn der Wert ungültig ist, werden keine Felder zurückgegeben. Alle GroupCensusMemberPlan-Felder werden zurückgegeben, wenn keine Werte vorhanden sind. |
|
Optional. Die Anzahl der abzurufenden Zählungsmitglieder. |
|
Optional . Die ID des Zählmitglieds, nach der die Zählmitglieder abgerufen werden müssen. |
|
Eine Zeichenfolge zum Suchen nach übereinstimmenden Datensätzen von Volkszählungsmitgliedern. |
Input JSON
Dieser Service verwendet keine Eingabe-JSON.
Ausgabe-JSON
Der Service gibt eine Ausgabe-JSON zurück, die wie im folgenden Beispiel formatiert ist. Die Ausgabe enthält Details zu den Mitgliedern in der Zählung, wobei die Kopfzeilen eine Liste der Feld-API-Namen von GroupCensusMember und GroupCensusMemberPlan sind. Der members-Knoten gibt die Liste der ausgewählten Pläne für das Mitglied zusammen mit der ContractGroupPlanId zurück, die durch ; getrennt ist. Im Feld lastOffset wird die ID des letzten abgerufenen Volkszählungsmitglieds angezeigt. Dieser Wert kann als Offset-Parameter verwendet werden, um die nächsten Zeilen abzurufen.
Hier ist das JSON-Beispielformat für die Ausgabe:
{
"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 ist die Beispielausgabe-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"
}