InsCensusService:getMembersWithPlans

類別:InsCensusService

方法:getMembersWithPlans

運作方式

此服務有兩個關鍵功能:

1. 檢索 GroupCensusMember__c 和 GroupCensusMemberPlan__c 中的欄位清單。

   • 此服務會使用參數 fieldsetName 取得 GroupCensusMember__c 欄位清單。若沒有值,則會從預設的欄位集 (即 EditableTable) 提取欄位。若輸入的值找不到相符項目,則系統將不取用任何欄位。

   • 此服務會使用參數 planFieldsetName 取得 GroupCensusMemberPlan__c 欄位清單。若沒有值,則會取回所有欄位。若輸入的值找不到相符項目,則系統將不取用任何欄位。

   • 如果 contractId 參數有值,則會在 ContractLineId__c.options 中填入契約的以下詳細資料:

     • 產品名稱

     • 產品類型

     • 屬於契約一部分的計畫識別碼。

   • 取得結合為 JSON headers 節點的關係欄位:

     • MemberIdentifier__c

     • PrimaryMemberIdentifier__c

     • RelatedCensusMemberId__c

     • IsPrimaryMember__c

     • IsSpouse__c

     • 識別碼

2. 將 GroupCensusMember__c 中的成員清單取回。

   • 此服務使用 censusId 來從 GroupCensusMember__c 提取普查成員,並從每個成員的 GroupCensusMemberPlan__c 提取普查成員計畫。

     

     備註

     offset 參數值會用於在位移之後,以接下來 2000 個 GroupCensusMember__c 列 (依 GroupCensusMember__c 識別碼排序) 來提取。

     如果沒有 offset 參數的值,則會取回前 2000 列。

   • 針對每個成員的資訊是根據從 GroupCensusMember__c 和 GroupCensusMemberPlan__c 取得的欄位。

   • 成員清單會放置在 members 節點中。

遠端選項

輸入 JSON

此服務不會取得輸入 JSON。

輸出 JSON

服務會傳回輸出 JSON,格式如下所示:

{  
   "census":{  
      "members":[  
         {  
            "vlocity_ins__ContractLineId__c":"",
            "Id":"a4C4P000000dNdbUAE",
            "vlocity_ins__LastName__c":null,
            "vlocity_ins__FirstName__c":null,
            "vlocity_ins__Birthdate__c":"1999-08-08"
         },
         {  
            "vlocity_ins__ContractLineId__c":"a2N4P000006ygEjUAI",
            "Id":"a4C4P000000dNdcUAE",
            "vlocity_ins__LastName__c":null,
            "vlocity_ins__FirstName__c":null,
            "vlocity_ins__Birthdate__c":"1994-08-08"
         },
         {  
            "vlocity_ins__ContractLineId__c":"a2N4P000006ygEjUAI;a2N4P000006ygEiUAI",
            "Id":"a4C4P000000dNdeUAE",
            "vlocity_ins__LastName__c":null,
            "vlocity_ins__FirstName__c":null,
            "vlocity_ins__Birthdate__c":"1985-08-08"
         }
      ],
      "headers":[  
         {  
            "type":"STRING",
            "label":"First Name",
            "fieldId":"",
            "name":"vlocity_ins__FirstName__c"
         },
         {  
            "type":"DATE",
            "label":"Birthday",
            "fieldId":"",
            "name":"vlocity_ins__Birthdate__c"
         },
         {  
            "type":"STRING",
            "label":"Last Name",
            "fieldId":"",
            "name":"vlocity_ins__LastName__c"
         },
         {  
            "options":[  
               {  
                  "value":"a2N4P000006ygEiUAI",
                  "type":"Medical",
                  "name":"rootProd"
               },
               {  
                  "value":"a2N4P000006ygEjUAI",
                  "type":"Dental",
                  "name":"rootProd2"
               }
            ],
            "type":"REFERENCE",
            "label":"Plan",
            "fieldId":"",
            "name":"vlocity_ins__ContractLineId__c"
         }
      ]
   },
   "lastOffset" : "a4C4P000000dNdeUAE"
}