詳細情報:
InsCensusServiceStd:getMembersWithPlans
このサービスを使用して、特定のcensusIdの国勢調査メンバーのリストを取得します。これらの国勢調査メンバーに対応するサービスは、GroupCensusMemberPlan からContractGroupPlanIdsを取得します。このサービスでは、fieldsetNameとplanFieldsetNameに基づいてヘッダーも取得されます。
クラス: InsCensusServiceStd
方法: getMembersWithPlans
操作手順
このサービスには 2 つの主要な機能があります。
-
GroupCensusMemberおよびGroupCensusMemberPlanの項目のリストを取得します 。このサービスは、パラメータ
fieldsetNameを使用して、GroupCensusMemberフィールドのリストを取得します。値がない場合、項目はデフォルトの項目セットから取得されます。入力した値で一致が見つからない場合、項目は取得されません。このサービスは、パラメータ
planFieldsetNameを使用してフィールドのリストを取得しますGroupCensusMemberPlan。値がない場合、すべての項目が取得されます。入力した値で一致が見つからなかった場合、項目は取得されません。JSON ヘッダーノードを形成するために結合されたリレーションフィールドを取得します。これらのフィールドが
fieldsetNameに含まれていない場合も同様です。PrimaryGroupCensusMemberId、RelationshipToPrimaryMember、SourceSystemIdentifier、およびPrimaryMemberSourceフィールドです。contractGroupPlanId契約グループプラン名
商品種別
契約グループプランの ID
-
このサービスでは、 を
censusId使用して、GroupCensusMemberレコードから国勢調査メンバーのリストを取得し、各メンバーのGroupCensusMemberPlanから契約グループ計画を取得します。-
オフセットに値がある場合、オフセット後に主
GroupCensusMemberの行 (ID で並び替え) が取得され、これらの主メンバーのすべての連動関係が取得されます。 -
limit 値がある場合、サービスは指定された limit を超えない主
GroupCensusMemberの行 (ID で並び替え) を取得します。次に、これらのプライマリメンバーのすべての扶養家族が取得されます。制限は 500 を超えることはできません。 -
searchKeyに値がある場合、サービスはGroupCensusMember行 (ID で並び替え) と、対応するファミリーを取得します。ファミリーには、FirstNameまたはLastNameにサブ文字列としてsearchKeyがあります。GroupCensusMemberに連動関係が含まれる場合、サービスはそれらの連動関係に対応するプライマリメンバーを取得します。 -
memberIdsに値がある場合、ID がmemberIds配列の一部であるGroupCensusMember行 (ID で並び替え) を取得します。memberIdsまたはsearchKeyを入力に指定する必要があります。 -
各メンバーで取得される情報は、
GroupCensusMemberおよびGroupCensusMemberPlanから取得される項目に基づいています。 -
メンバーのリストは ノードに配置されます
members。
-
サービス動作
さまざまな入力がサービス出力にどのように影響するかを理解します。
| 入力 | サービス出力 |
|---|---|
|
このサービスでは国勢調査メンバーは取得されません。 |
No fieldsetName and valid censusId |
このサービスでは、以下が取得されます。
|
有効 censusIdfieldsetName |
このサービスは、指定されたfieldsetNameに従ってGroupCensusMemberフィールドをリストし、ContractGroupPlanIdsを含むGroupCensusMemberのリストを取得します。 |
planFieldsetName 有効なfieldsetNameと有効なcensusIdがありません |
このサービスでは、GroupCensusMemberPlanの指定された [fieldsetName]、[ContractGroupPlanId]、[名前] 項目に従ってGroupCensusMember項目がリストされます。ContractGroupPlanIds を含む |
有効planFieldsetName なfieldsetNameと有効なcensusId |
このサービスでは、以下が取得されます。
|
Valid contractId |
このサービスでは、契約グループプラン名、商品種別、子商品、および契約グループプラン ID がContractGroupPlanIdヘッダーフィールドのオプションとして取得されます。 |
Valid limit |
このサービスでは、以下が取得されます。
|
Valid offset |
このサービスでは、以下が取得されます。
|
有効 limitoffset |
このサービスでは、以下が取得されます。
|
Valid searchKey |
このサービスでは、以下が取得されます。
|
有効 limitsearchKey |
このサービスでは、以下が取得されます。
|
有効 offsetsearchKey |
このサービスでは、以下が取得されます。
|
有効なsearchKey、有効なlimit、有効なoffset |
このサービスでは、以下が取得されます。
|
リモートオプション
| オプション | 説明 |
|---|---|
|
必須。 メンバーを取得する必要がある国勢調査の ID。 |
|
必須。 取引先の現在の契約の ID。 契約グループプラン名、商品種別、契約グループを取得します。 |
|
省略可能。 GroupCensusMember 項目を取得する項目セットの名前。 値が無効の場合、サービスは項目を返しません。 値がない場合、サービスはデフォルトの項目セットを使用して GroupCensusMember 項目を取得します。 |
|
省略可能。 有効な計画項目セット値がある場合に GroupCensusMemberPlan 項目と GroupCensusMember 項目を取得します。 値が有効でない場合、項目は返されません。 値がない場合、すべての GroupCensusMemberPlan 項目が返されます。 |
|
省略可能。 取得される国勢調査メンバーの数。 |
|
省略可能。 国勢調査メンバーを取得する必要がある国勢調査メンバーの ID。 |
|
一致する国勢調査メンバーレコードを検索する文字列。 |
Input JSON
このサービスは入力 JSON を取りません。
出力 JSON
このサービスは、次の例のように書式設定された出力 JSON を返します。出力には国勢調査のメンバーの詳細が含まれます。headers は、GroupCensusMember と GroupCensusMemberPlan の項目 API 参照名のリストです。membersノードは、メンバー用に選択されたプランのリストと、; で区切られた ContractGroupPlanId を返します。[lastOffset] フィールドには、取得された最後の国勢調査メンバーの ID が表示されます。この値は、次の行を取得する offset パラメーターとして使用できます。
出力 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"
}