詳細情報:
InsCensusServiceStd:getMembers
このサービスを使用して、GroupCensusMemberから国勢調査のメンバーを取得します。また、fieldsetNameに基づいてヘッダーも取得されます。
クラス: InsCensusServiceStd
方法: getMembers
サービスでは、次の形式の入力を受け入れます。
| censusId | fieldsetName | オフセット | 制限 | searchKey |
|---|---|---|---|---|
| c101 | test_fieldset | cmember101 | integer | プレフィックス |
このサービスでは、入力値を使用して、商品モデルに適合する出力を生成します。
| 国勢調査 | lastOffSet | |
|---|---|---|
| headers | メンバー | 前回の国勢調査メンバーの ID |
| 項目のリスト | メンバーのリスト | |
操作手順
このサービスには 2 つの主要な機能があります。
-
fieldetNameに基づいてGroupCensusMember項目とヘッダーのリストを取得します。出力には常にPrimaryGroupCensusMemberId、RelationshipToPrimaryMember、SourceSystemIdentifier、およびPrimaryMemberSourceが含まれます。これらのフィールドがfieldsetNameに含まれていない場合も同様です。 - このサービスでは、
censusIdを使用して、GroupCensusMemberレコードから国勢調査メンバーのリストを取得します。- オフセットに値がある場合、オフセット後に主
GroupCensusMemberの行 (ID で並び替え) が取得され、これらの主メンバーのすべての連動関係が取得されます。 limit 値がある場合、サービスは指定された limit を超えない主
GroupCensusMemberの行 (ID で並び替え) を取得します。次に、これらのプライマリメンバーのすべての扶養家族が取得されます。制限は 500 を超えることはできません。searchKeyに値がある場合、サービスは、FirstNameまたはLastNameにサブ文字列としてsearchKeyがあるGroupCensusMember行 (ID で並び替え) と対応するファミリーを取得します。memberIdsに値がある場合、ID がmemberIds配列の一部であるGroupCensusMember行 (ID で並び替え) を取得します。memberIdsまたはsearchKeyを入力に指定する必要があります。[
withPlans] が [true] に設定されている場合、各メンバーで選択されたプランのリストが取得されます。各メンバーの有効なContractGroupPlanIdはセミコロンで区切られ、文字列として返されます。各メンバーで取得される情報は、
GroupCensusMemberから取得されるフィールドに基づきます。メンバーのリストは
membersノードに配置されます。
- オフセットに値がある場合、オフセット後に主
サービス動作
さまざまな入力がサービス出力にどのように影響するかを理解します。
| 入力 | サービス出力 |
|---|---|
censusIdがない、または無効なcensusId |
このサービスでは国勢調査メンバーは取得されません。 |
No fieldsetName and valid censusId |
|
有効 censusIdfieldsetName |
このサービスでは、特定の項目セットに存在するGroupCensusMember項目のリストとGroupCensusMemberのリストが取得されます。 |
Valid limit |
サービスは、指定された制限内の |
Valid offset |
サービスは
|
有効 limitoffset |
このサービスでは、特定の項目セットに存在する
|
Valid searchKey |
このサービスでは、特定の項目セットに存在する |
有効 limitsearchKey |
このサービスでは、特定の項目セットに存在する |
有効 offsetsearchKey |
このサービスでは、特定の項目セットに存在する |
有効なsearchKey、有効なlimit、有効なoffset |
このサービスでは、特定の項目セットに存在する
|
リモートオプション
| オプション | 説明 |
|---|---|
|
必須。 メンバーを取得する必要がある国勢調査の ID。 |
|
省略可能。
値が無効の場合、サービスは項目を返しません。 値がない場合、サービスはデフォルトのフィールドセットを使用してフィールドを取得します |
|
省略可能。 取得される国勢調査メンバーの数。 |
|
省略可能。 国勢調査メンバーを取得する必要がある国勢調査メンバーの ID。 |
|
一致する国勢調査メンバーレコードを検索する文字列。 |
Input 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"
}