InsEnrollmentService:findEnrollees

類別:InsEnrollmentService

方法:findEnrollees

運作方式

1. 服務會收到剖析後的 JSON。

2. 如果剖析的物件有 searchKey 參數,則會針對以指定 searchKey 為開頭的「姓氏」、「姓氏」或「成員識別碼」連絡人,以該物件的「連絡人」檢索清單。

   • 依預設,服務不會傳回具有到期保單的連絡人。

   • 如果剖析物件有 productType 參數,則系統會根據原則產品類型進一步篩選所取回的連絡人清單。

   • 如果剖析的物件具有 includeExpiredPolicies 參數,則無論其原則的到期日期為何,都會提取「連絡人」

3. 只要保單的群組是指定的帳戶識別碼,該服務便會取用保單清單,並將其對應至每個已取得的連絡人。

   • 如果輸入包含 effectiveDate,則只有具有相同生效日期的原則才會提取。

   • 如果輸入包含 productType,則只有具有相同 productType 的原則才會用其來提取。

   • 如果輸入集包含「ExpiredPolicies」到「true」,則即使到期原則也會再來。

4. 系統會在資料節點中傳回包含所有已指派原則詳細資料的會員清單。

輸入

輸入 JSON

JSON 輸入格式如下:

{
  "searchKey": String,
  "productType": productType,
  "includeExpiredPolicies": Boolean
}

含資料的範例 JSON 輸入:

{
    "searchKey": "Adam",
    "productType": "Medical",
    "includeExpiredPolicies": true
}

輸出 JSON

JSON 輸出是登記者清單,在 fields 節點下具有下列內容:

{
  "data": {
    "records": [
      {
        "fields": {
          "Id": "0035w000039SsoSAAS",
		  "AccountId": "0015w00002ADHiPAAX",
          "LastName": "C2P1",
          "FirstName": "P1",
		  "Name": "C2P1 P1"
        }
      }
    ]
  }
}

含資料的範例 JSON 輸出:

{
  "data": [
    {
      "AccountId": "0013h00000Gx5UqAAJ",
      "Id": "0033h00000BBybMAAT",
      "LastName": "C1P1",
      "FirstName": "D1",
      "Name": "D1 C1P1"
    },
    {
      "AccountId": "0013h00000Gx5UqAAJ",
      "Id": "0033h00000BBybPAAT",
      "LastName": "C1P2",
      "FirstName": "D1",
      "Name": "D1 C1P2"
    },
    {
      "AccountId": "0013h00000Gx5UrAAJ",
      "Id": "0033h00000BBybSAAT",
      "LastName": "C2P1",
      "FirstName": "D1",
      "Name": "D1 C2P1"
    }
  ],
  "error": "OK"
}