您在此处:
InsCensusServiceStd:getMembersWithPlans
使用此服务检索给定censusId的人口普查成员列表。与这些普查成员对应,服务从GroupCensusMemberPlan检索ContractGroupPlanIds。该服务还根据fieldsetName和planFieldsetName检索标题。
类:InsCensusServiceStd
方法:getMembersWithPlans
工作原理
此服务有两个主要功能:
- 检索“
GroupCensusMember”和“GroupCensusMemberPlan”中的字段列表。该服务使用参数
fieldsetName检索字段列表GroupCensusMember。如果没有值,将从默认字段集中检索字段。如果输入的值未找到匹配项,则不会检索字段。该服务使用参数
planFieldsetName检索GroupCensusMemberPlan字段列表。如果没有值,将检索所有字段。如果输入的值未找到匹配项,则不会检索字段。检索组合在一起形成 JSON 标题节点的关系字段,即使这些字段不包含在
fieldsetName中。这些字段是:PrimaryGroupCensusMemberId、RelationshipToPrimaryMember、SourceSystemIdentifier和PrimaryMemberSource。如果
参数有值,它会使用以下合同详细信息填充合同行记录列表:contractGroupPlanId合同组计划名称
产品类型
合同组计划的 ID
-
该服务使用
censusId从GroupCensusMember记录中检索普查成员列表,并从GroupCensusMemberPlan中检索每个成员的合同组计划。-
如果偏移有值,它会在偏移后检索主要
GroupCensusMember行(按 ID 排序),然后检索这些主要成员的所有依赖项。 -
如果有限制值,服务会检索不大于指定限制的主要
GroupCensusMember行(按 ID 排序)。然后,它检索这些主要成员的所有依赖项。限制不能超过 500。 -
如果
searchKey有值,服务会检索GroupCensusMember行(按 ID 排序)以及相应的系列,该系列将searchKey作为子字符串出现在它们的FirstName或LastName中。如果GroupCensusMember包含依赖项,服务会检索与这些依赖项对应的主要成员。 -
如果
memberIds有值,它会检索 ID 是memberIds数组一部分的GroupCensusMember行(按 ID 排序)。必须在输入中提供memberIds或searchKey。 -
为每个成员检索的信息基于从
GroupCensusMember和GroupCensusMemberPlan检索的字段。 -
成员列表被放入存储
members节点。
-
服务行为
了解不同的输入如何影响服务输出。
| 输入 | 服务输出 |
|---|---|
没有 |
该服务未检索普查成员。 |
没有fieldsetName 有效的censusId |
该服务检索:
|
有效 censusIdfieldsetName |
该服务根据指定的fieldsetName列出GroupCensusMember字段,并检索带有ContractGroupPlanIds的GroupCensusMember列表。 |
没有planFieldsetName 有效fieldsetName和有效censusId |
服务会根据指定的fieldsetName、ContractGroupPlanId和GroupCensusMemberPlan名称字段列出GroupCensusMember字段。它检索带有 ContractGroupPlanIds 的列表。 |
有效planFieldsetName 有效fieldsetName和有效censusId |
该服务检索:
|
有效contractId |
该服务检索合同组计划名称、产品类型、子产品和合同组计划 ID,作为ContractGroupPlanId标题字段中的选项。 |
有效limit |
该服务检索:
|
有效offset |
该服务检索:
|
有效 limitoffset |
该服务检索:
|
有效searchKey |
该服务检索:
|
有效 limitsearchKey |
该服务检索:
|
有效 offsetsearchKey |
该服务检索:
|
有效searchKey、有效limit和有效offset |
该服务检索:
|
远程选项
| 选项 | 描述 |
|---|---|
|
必填。 必须检索成员的人口普查 ID。 |
|
必填。 客户当前合同的 ID。 检索合同组计划名称、产品类型和合同组 |
|
可选。 用于检索 GroupCensusMember 字段的字段集的名称。 如果值无效,服务不会返回字段。 如果没有值,服务会使用默认字段集检索“GroupCensusMember”字段。 |
|
可选。 当存在有效的计划字段集值时,检索 GroupCensusMemberPlan 和 GroupCensusMember 字段。 如果值无效,则不会返回字段。 当没有值时,将返回所有 GroupCensusMemberPlan 字段。 |
|
可选。 要检索的人口普查成员数量。 |
|
可选。 普查成员的 ID,此后必须检索普查成员。 |
|
用于搜索匹配普查成员记录的字符串。 |
输入 JSON
此服务不需要输入 JSON。
输出 JSON
该服务返回一个输出 JSON,格式如下例所示。输出包含普查成员的详细信息,其中“标题”是GroupCensusMember和GroupCensusMemberPlan的字段 API 名称列表。members节点返回成员的选定计划列表,以及用 ; 分隔的 ContractGroupPlanId。lastOffset字段显示检索的最后一个普查成员的 ID。此值可用作偏移参数,以获取下一行。
以下是输出 JSON 格式示例:
{
"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"
}以下是示例输出 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"
}