您位於此處:
InsEnrollmentService:getEnrolleePolicies
使用此服務可讓使用者搜尋指定註冊用戶集的原則。
方法:getEnrolleePolicies
運作方式
-
服務會收到剖析後的 JSON。
-
如果輸入未包含 accountId,則會傳回錯誤。
-
如果輸入未包含有效的連絡人識別碼清單,則會傳回錯誤。
-
-
此服務會針對每個 contactId 取用連絡人清單。
-
只要保單的群組是指定的帳戶識別碼,服務便會取用保單清單,並將其對應至每個已取得的連絡人。
-
如果輸入包含 effectiveDate,則只有具有相同生效日期的原則才會提取。
-
如果輸入包含 productType,則只有具有相同 productType 的原則才會用此選項。
-
如果輸入集包含「ExpiredPolicies」到「true」,則即使到期原則也會再來。
-
-
也會取回所取用保單的「產品」詳細資料,包括針對指定保單註冊之相依的清單。
-
系統會在
data節點中傳回具有所有指派原則詳細資料的已提取登記者清單。
輸入
輸入 |
描述 |
|---|---|
|
擁有待取用資產的連絡人識別碼清單。 |
|
用來篩選所取用註冊的帳戶識別碼。 |
|
選擇性 字串 日期字串,用於根據原則生效的時間來篩選所取用註冊清單。 |
|
選擇性 字串 根據產品類型篩選所取用的註冊清單。 |
|
選擇性 布林值 決定服務是否應包含具有到期原則的連絡人 |
輸入 JSON
JSON 格式:
{
"contactIds": [ContactId],
"accountId": accountId,
"effectiveDate": Date,
"productType": productType,
"includeExpiredPolicies": Boolean
}範例資料輸出:
{
"contactIds": [ "0035w000034kiVwAAI" ],
"accountId": "0015w00002ADHiPAAX",
"effectiveDate": "6/12/2020",
"productType": "Medical",
"includeExpiredPolicies": true
}輸出 JSON
JSON 格式:
{
"data": [
{
"enrollments": [
{
"dependents": [
{
"partyId":Id,
"contactId": Id,
"relationshipType": String,
"LastName": String",
"FirstName": String,
"Id": Id
}
],
"EffectiveEnd": Date,
"EffectiveStart": Date,
"Name": String,
"productName": String,
"primaryMemberContactId": Id,
"policyNumber": String,
"accountId": Id,
"productId": Id,
"Id": Id
}
],
"AccountId": Id,
"Id": Id,
"LastName": String,
"FirstName": String,
"Name": String
}
],
"error": "OK"
}範例資料輸出:
{
"data": [
{
"enrollments": [
{
"dependents": [
{
"partyId": "a0z3h0000036sJiAAI",
"contactId": "0033h00000BBybMAAT",
"relationshipType": "Dependent",
"LastName": "C1P1",
"FirstName": "D1",
"Id": "a4B3h000000IdiMEAS"
},
{
"partyId": "a0z3h0000036sJjAAI",
"contactId": "0033h00000BBybNAAT",
"relationshipType": "Dependent",
"LastName": "C1P1",
"FirstName": "D2",
"Id": "a4B3h000000IdiNEAS"
}
],
"EffectiveEnd": null,
"EffectiveStart": "2020-06-12",
"Name": "Policy1",
"productName": "MedPlan A",
"primaryMemberContactId": "0033h00000BBybLAAT",
"policyNumber": null,
"accountId": "0013h00000Gx5UqAAJ",
"productId": "01t3h000002T4JmAAK",
"Id": "02i3h00000037xxAAA"
}
],
"AccountId": "0013h00000Gx5UqAAJ",
"Id": "0033h00000BBybLAAT",
"LastName": "C1P1",
"FirstName": "P1",
"Name": "P1 C1P1"
},
{
"enrollments": [
{
"dependents": [
{
"partyId": "a0z3h0000036sJlAAI",
"contactId": "0033h00000BBybPAAT",
"relationshipType": "Dependent",
"LastName": "C1P2",
"FirstName": "D1",
"Id": "a4B3h000000IdiOEAS"
},
{
"partyId": "a0z3h0000036sJmAAI",
"contactId": "0033h00000BBybQAAT",
"relationshipType": "Dependent",
"LastName": "C1P2",
"FirstName": "D2",
"Id": "a4B3h000000IdiPEAS"
}
],
"EffectiveEnd": null,
"EffectiveStart": "2020-06-12",
"Name": "Policy2",
"productName": null,
"primaryMemberContactId": "0033h00000BBybOAAT",
"policyNumber": null,
"accountId": "0013h00000Gx5UqAAJ",
"productId": null,
"Id": "02i3h00000037xyAAA"
}
],
"AccountId": "0013h00000Gx5UqAAJ",
"Id": "0033h00000BBybOAAT",
"LastName": "C1P2",
"FirstName": "P2",
"Name": "P2 C1P2"
}
],
"error": "OK"
}