您在此处:
InsCensusServiceStd:getMembers
使用此服务从GroupCensusMember检索普查成员。它还根据fieldsetName检索标题。
类:InsCensusServiceStd
方法:getMembers
服务接受此格式的输入。
| censusId | fieldsetName | 偏移 | 限制 | searchKey |
|---|---|---|---|---|
| c101 | test_fieldset | cmember101 | 整型 | prefix |
该服务使用输入值来生成适合您的产品模型的输出。
| 人口普查 | lastOffSet | |
|---|---|---|
| headers | 成员 | 上次人口普查成员的 ID |
| 字段列表 | 成员列表 | |
工作原理
此服务有两个主要功能:
-
根据
fieldetName检索GroupCensusMember字段和标题列表。输出始终包含PrimaryGroupCensusMemberId、RelationshipToPrimaryMember、SourceSystemIdentifier和PrimaryMemberSource,即使这些字段未包含在fieldsetName中。 - 该服务使用
censusId从GroupCensusMember记录中检索普查成员列表。- 如果偏移有值,它会在偏移后检索主要
GroupCensusMember行(按 ID 排序),然后检索这些主要成员的所有依赖项。 如果有限制值,服务会检索不大于指定限制的主要
GroupCensusMember行(按 ID 排序)。然后,它检索这些主要成员的所有依赖项。限制不能超过 500。如果
searchKey有值,服务会检索GroupCensusMember行(按 ID 排序)以及相应的系列,这些系列将searchKey作为子字符串出现在它们的FirstName或LastName中。如果
memberIds有值,它会检索 ID 是memberIds数组一部分的GroupCensusMember行(按 ID 排序)。必须在输入中提供memberIds或searchKey。如果
withPlans设置为true,服务将检索每个成员的选定计划列表。每个成员的有效ContractGroupPlanId由分号分隔,并以字符串形式返回。为每个成员检索的信息基于从
GroupCensusMember检索的字段。成员列表会放入 ⁇
members⁇ 节点。
- 如果偏移有值,它会在偏移后检索主要
服务行为
了解不同的输入如何影响服务输出。
| 输入 | 服务输出 |
|---|---|
没有censusId或无效censusId |
该服务未检索普查成员。 |
没有fieldsetName 有效的censusId |
|
有效 censusIdfieldsetName |
该服务检索给定字段集中存在的GroupCensusMember字段列表和GroupCensusMember列表。 |
有效limit |
该服务检索指定限制内的 |
有效offset |
该服务检索
|
有效 limitoffset |
该服务检索给定字段集中存在的
|
有效searchKey |
该服务检索给定字段集中存在的 |
有效 limitsearchKey |
该服务检索给定字段集中存在的 |
有效 offsetsearchKey |
该服务检索给定字段集中存在的 |
有效searchKey、有效limit和有效offset |
该服务检索给定字段集中存在的
|
远程选项
| 选项 | 描述 |
|---|---|
|
必填。 必须检索成员的人口普查 ID。 |
|
可选。 用于检索 如果值无效,服务不会返回字段。 如果没有值,服务会使用默认字段集检索字段 |
|
可选。 要检索的人口普查成员数量。 |
|
可选。 普查成员的 ID,此后必须检索普查成员。 |
|
用于搜索匹配普查成员记录的字符串。 |
输入 JSON
此服务不需要输入 JSON。
输出 JSON
该服务返回带有字段列表、成员列表和lastOffSet值的输出 JSON。
{
"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"
}