您位於此處:
InsGroupClassService:getGroupClassesByContract
使用此服務可取得具有輸入所提供 contractId 的符合資格計畫清單,以及作為輸入所提供 GroupclassId 的符合資格計畫清單。
類別:InsGroupClassService
方法:getGroupClassesByAccount
運作方式
-
服務會取得
contractId和groupClassId作為輸入。備註 提供contractId是必要的,但groupClassId是選擇性的。 -
接著會驗證輸入資料,以確認提供的
contractId和groupClassId有效。 -
如果僅提供
contractId,則服務會針對涵蓋範圍的所有符合資格計畫和所有有效群組類別,以及每個有效群組類別的符合資格計畫。 -
如果同時提供
groupClassId與contractId,則服務會針對所提供的groupClassId來取用所有符合資格的計畫。
輸入選項
| 輸入 | 描述 |
|---|---|
| contractId | 契約群組計畫的識別碼 |
| groupClassId | 群組類別的識別碼 |
輸入 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
}輸入 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"
}
]
}