InsCensusServiceStd:getMembers

運作方式

此服務有兩個關鍵功能:

1. 根據該 fieldetName 來取回 GroupCensusMember 欄位和標題的清單。輸出一律有 PrimaryGroupCensusMemberId、RelationshipToPrimaryMember、SourceSystemIdentifier 和 PrimaryMemberSource,即使這些欄位未包含在 fieldsetName 中也是如此。

2. 此服務使用 ​censusId 來從 GroupCensusMember​​ 記錄提取普查成員清單。
   1. 如果位移有值,則會在位移之後,取用「主要 GroupCensusMember」列 (依識別碼排序),然後針對這些「主要成員」取用所有相依項目。

   2. 如果有限制值,則服務會取用不大於指定限制的主要 GroupCensusMember 列 (依識別碼排序)。接著會針對「主要成員」中所有的相依性。限制不可超過 500 個。

   3. 如果 searchKey 有值,則服務會將 GroupCensusMember 列 (依識別碼排序) 與對應的系列,其中 searchKey 作為子字串存在於其 FirstName 或 LastName 中。

   4. 如果 memberIds 含有值,則其會取用其 Id 屬於 memberIds 陣列一部分的 GroupCensusMember 列 (依識別碼排序)。必須在輸入中提供 memberIds 或 searchKey。

   5. 如果將 withPlans 設為 true,則服務會針對每個成員來取用所選計畫的清單。每個成員的有效 ContractGroupPlanId 由分號分隔,並以字串傳回。

   6. 針對每個成員的資訊是根據從 GroupCensusMember 取得的欄位。

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

服務行為

瞭解不同的輸入如何影響服務輸出。

遠端選項

輸入 JSON

此服務不會取得輸入 JSON。

輸出 JSON

服務會傳回輸出 JSON,其中包含欄位清單、成員清單和 lastOffSet 值。

{ 
   "census":{ 
      "members":[ 
         { 
            "Id":"a4C4P000000dNdbUAE",
            "LastName":member1,
            "FirstName":primary,
            "Birthdate":"1999-08-08"
         },
         { 
            "Id":"a4C4P000000dNdcUAE",
            "LastName":member1,
            "FirstName":dependent,
            "Birthdate":"1994-08-08"
         },
         { 
            "Id":"a4C4P000000dNdeUAE",
            "LastName":member2,
            "FirstName":primary,
            "Birthdate":"1985-08-08"
         }
      ],
      "headers":[ 
         { 
            "type":"STRING",
            "label":"First Name",
            "fieldId":"",
            "name":"FirstName"
         },
         { 
            "type":"DATE",
            "label":"Birthday",
            "fieldId":"",
            "name":"Birthdate"
         },
         { 
            "type":"STRING",
            "label":"Last Name",
            "fieldId":"",
            "name":"LastName"
         }
      ]
   },
   "lastOffset" : "a4C4P000000dNdeUAE"
}