詳細情報:
InsGroupClassService:getGroupClassesByContract
このサービスを使用して、入力として指定されたcontractIdの対象プランのリストと、入力として指定された GroupclassId の対象プランのリストを取得します。
クラス: InsGroupClassService
方法: getGroupClassesByAccount
操作手順
-
サービスは
contractIdとgroupClassIdを入力として受け取ります。メモcontractIdの指定は必須ですが、groupClassIdは省略可能です。 -
次に、入力データを検証して、指定された
contractIdとgroupClassIdが有効であることを確認します。 -
contractIdのみが提供される場合、サービスは補償範囲が含まれるすべての対象プランとすべての有効なグループクラスを、有効な各グループクラスの対象プランと共に取得します。 -
contractIdと共にgroupClassIdも提供される場合、サービスは提供されたgroupClassIdの対象プランをすべて取得します。
入力オプション
| 入力 | 説明 |
|---|---|
| contractId | 契約グループプランの ID |
| groupClassId | グループクラスの ID |
Input JSON
入力としてcontractIdのみが指定されている場合の入力 JSON の例を次に示します。
{
"contractId":"001B000001UGEaRIAX"
}出力 JSON
入力としてcontractIdのみを指定した場合の出力 JSON の例を次に示します。
{
"accountId": "800RN000000jc0JYAQ",
"eligiblePlans":
[
{
"Id":"0rgRN000000030fYTT",
"Name":"Vision Standard",
"Type":"Vision",
"childPlans":[
{
"value": "0rgDC000000000RYAQ",
"IsOptional": false,
"name": "MandatoryCoverage"
}
]
},
{
"Id":"0rgRN000000030fYTS",
"Name":"Medical Standard",
"Type":"Medical",
"childPlans":[
{
"value": "0rgDC000000000RYAR",
"IsOptional": false,
"name": "MandatoryCoverage"
},
{
"value": "0rgDC000000000RYAT",
"IsOptional": true,
"name": "OptionalCoverage"
}
]
}
],
"groupClasses":
[
{
"Id":"0rERN000000004Y2PN",
"Name":"Employees",
"Code":"Employees"
},
{
"Id":"0rERN000000004Y2AQ",
"Name":"Executives",
"Code":"Executives",
"eligiblePlans":
[
{
"Id":"0rgRN000000030fYAA",
"Name":"Dental Premium",
"Type":"Dental",
"childPlans":
[
{
"value": "0rgDC000000000RYAR",
"IsOptional": false,
"name": "MandatoryCoverage"
},
{
"value": "0rgDC000000000RYAT",
"IsOptional": true,
"name": "OptionalCoverage"
}
]
}
] //eligible plans node
}
] // groupclasses node
}Input JSON
contractId と groupClassId の両方を入力として指定した場合のサンプル入力 JSON を次に示します。
{
"contractId":"001B000001UGEaRIAX",
"groupClassId":"0rERN000000004Y2AQ"
}出力 JSON
contractId と の両方groupClassIdを入力として指定した場合の出力 JSON の例を次に示します。
{
"accountId": "800RN000000jc0JYAQ",
"eligiblePlans":[
{
"Id":"0rgRN000000030fYTT",
"Name":"Vision Standard",
"Type":"Vision",
"childPlans":
[
{
"value": "0rgDC000000000RYAQ",
"IsOptional": false,
"name": "MandatoryCoverage"
}
]
},
{
"Id":"0rgRN000000030fYTS",
"Name":"Medical Standard",
"Type":"Medical",
"childPlans":[
{
"value": "0rgDC000000000RYAR",
"IsOptional": false,
"name": "MandatoryCoverage"
},
{
"value": "0rgDC000000000RYAT",
"IsOptional": true,
"name": "OptionalCoverage"
}
]
}
], // eligible plans node
"groupClasses":[
{
"Id":"0rERN000000004Y2AQ",
"Name":"Executives",
"Code":"Executives",
"eligiblePlans":[
{
"Id":"0rgRN000000030fYAA",
"Name":"Dental Premium",
"Type":"Dental",
"childPlans":[
{
"value": "0rgDC000000000RYAR",
"IsOptional": false,
"name": "MandatoryCoverage"
},
{
"value": "0rgDC000000000RYAT",
"IsOptional": true,
"name": "OptionalCoverage"
}
]
}
]
}出力 JSON
エラーのある出力 JSON の例を次に示します。
{
"errors" : [
{
"error":"Specify a valid ContractID",
"contractId":"001B000001UGEaRIAX"
}
]
}