您位於此處:
InsEnrollmentServiceStd:enrollFamily
使用此服務可在包含主要成員和與涵蓋範圍相關聯的相依性之根計畫內註冊一個家庭。
類別:InsEnrollmentServiceStd
方法:enrollFamily
運作方式
- 服務會先驗證輸入資料,以確認:
提供必要的要求資料。
提供的
flowName及其版本有效且已啟用。提供的
primaryMemberId有效,且有與指定primaryMemberId和censusId相符的記錄。提供的
contractId或rootPlanId有效,或提供的rootPlanId的contractGroupPlan與提供的contractId相關聯。系統會針對在
GroupCensusMemberPlan表格中提供的rootPlanId和primaryMemberId完成註冊狀態。有一個與指定的
rootPlanId和primaryCensusMemberId相關聯的記錄。
-
如果輸入資料有效,則服務會呼叫註冊流程。
-
註冊流程會建立「保單」、「保單參與者」和「保單涵蓋範圍」。
-
服務會在成功執行時傳回原則識別碼。
-
服務會在發生任何驗證或註冊流程執行錯誤時,傳回包含錯誤詳細資料的錯誤。
遠端選項
| 選項 | 描述 |
|---|---|
flowName
|
必要 用於個人註冊的註冊流程名稱。 |
groupCensusId
|
必要 群組普查的識別碼,其中包含要註冊之家庭的所有普查成員。 |
contractId
|
必要 成員所屬契約的識別碼,以及成員註冊的計畫。 |
primaryMemberId
|
必要 要註冊的主要成員識別碼。 |
rootPlanId
|
必要 註冊產品的根契約群組計畫識別碼。 |
isProrated
|
選擇性。 如果為 |
isSaveMemberPremium
|
選擇性 表示是否必須為所有 InsurancePolicyParticipant 記錄設定保單保費金額。如果為 |
userInputs
|
選擇性 等級程序用來取得產品價格的輸入資料集。 |
additionalInputs
|
選擇性 用於產品評分之其他輸入的序列化金鑰值對應。 |
matchingKeysList
|
必要 如果組織中啟用 personAccount,則「帳戶」物件的逗號分隔欄位用於針對現有「帳戶」記錄進行重複偵測。 如果組織中未啟用 personAccount,則「連絡人」物件的逗號分隔欄位用於針對現有「連絡人」記錄進行重複偵測。 |
inputKeysList
|
選擇性 用於包含在個別評分結果中的等級輸入輸入索引鍵的逗號分隔清單。 |
emailEncodingKey
|
如果使用建立入口網頁使用者可叫用動作,則為必要。 用於建立使用者記錄的電子郵件編碼金鑰。例如,ISO-8859-1 或 UTF-8。 |
languageLocaleKey
|
選擇性 如果使用建立入口網頁使用者可叫用動作,則為必要。 |
localeSidKey
|
如果使用建立入口網頁使用者可叫用動作,則為必要。 用於建立使用者記錄的地區設定 SID 金鑰。 |
timezoneSidKey
|
如果使用建立入口網頁使用者可叫用動作,則為必要。 用於建立使用者記錄的時區 SID 金鑰。 |
profileId
|
選擇性 應與「使用者」記錄相關聯的「設定檔」記錄識別碼。 |
輸入 JSON
以下是範例輸入 JSON:
{
'flowName': 'Individual_Enrollment',
'groupCensusId':'0rfSG00000003fRYAQ',
'contractId':'800RN000000jyCRYAY',
'primaryMemberId':'0r6SG0000000j1xYAA',
'rootPlanId':'0rgRN0000000320YAA',
'isProrated': true,
'isSaveMemberPremium':true,
'emailEncodingKey':'ISO-8859-1',
'languageLocaleKey':'en_US',
'localeSidKey':'en_US',
'timezoneSidKey':'America/Los_Angeles',
'profileId':'00eSG00000120ug',
'userInputs':{"ratingType": "Enrollment"},
'additionalInputs':{"mergeList": "true", "includeOptionalCovSelectFlag":true}
'matchingKeysList':'FirstName,LastName',
'inputKeysList':'aggByKey,primaryMember,groupCensusMemberId'
}輸出錯誤的 JSON
以下是範例錯誤輸出 JSON:
{
"errors":[
{
"error":"already enrolled",
"rootPlanId":"0rgRN0000000320YAA",
"censusMemberId":"0r6RN0000006HOJYA2"
},
]
}