GET v1/api/enrollee/listBeneficiaries?enrolleeNo={enrolleeNo}&addPrincipal={addPrincipal}

Request Information

URI Parameters

Name	Description	Type	Additional information
enrolleeNo		string	Required
addPrincipal		boolean	Required

Body Parameters

None.

Response Information

Resource Description

listBeneficiariesResult

Name	Type	Additional information
success	boolean	None.
errorMsg	string	None.
insuredList	Collection of dependantList	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "errorMsg": "sample string 2",
  "insuredList": [
    {
      "no_preAuth": true,
      "planName": "sample string 2",
      "emailAddress": "sample string 3",
      "dob": "sample string 4",
      "enrolleeNo": "sample string 5",
      "title": "sample string 6",
      "otherName": "sample string 7",
      "surname": "sample string 8",
      "insureType": "sample string 9",
      "relationshipType": "sample string 10",
      "temp_id": 11,
      "expiryDate": "sample string 12",
      "picUrl": "sample string 13"
    },
    {
      "no_preAuth": true,
      "planName": "sample string 2",
      "emailAddress": "sample string 3",
      "dob": "sample string 4",
      "enrolleeNo": "sample string 5",
      "title": "sample string 6",
      "otherName": "sample string 7",
      "surname": "sample string 8",
      "insureType": "sample string 9",
      "relationshipType": "sample string 10",
      "temp_id": 11,
      "expiryDate": "sample string 12",
      "picUrl": "sample string 13"
    }
  ]
}

application/xml, text/xml

Sample:

<listBeneficiariesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/enrrolleeApp.Models.listBeneficiaries">
  <errorMsg>sample string 2</errorMsg>
  <insuredList>
    <listBeneficiariesResult.dependantList>
      <dob>sample string 4</dob>
      <emailAddress>sample string 3</emailAddress>
      <enrolleeNo>sample string 5</enrolleeNo>
      <expiryDate>sample string 12</expiryDate>
      <insureType>sample string 9</insureType>
      <no_preAuth>true</no_preAuth>
      <otherName>sample string 7</otherName>
      <picUrl>sample string 13</picUrl>
      <planName>sample string 2</planName>
      <relationshipType>sample string 10</relationshipType>
      <surname>sample string 8</surname>
      <temp_id>11</temp_id>
      <title>sample string 6</title>
    </listBeneficiariesResult.dependantList>
    <listBeneficiariesResult.dependantList>
      <dob>sample string 4</dob>
      <emailAddress>sample string 3</emailAddress>
      <enrolleeNo>sample string 5</enrolleeNo>
      <expiryDate>sample string 12</expiryDate>
      <insureType>sample string 9</insureType>
      <no_preAuth>true</no_preAuth>
      <otherName>sample string 7</otherName>
      <picUrl>sample string 13</picUrl>
      <planName>sample string 2</planName>
      <relationshipType>sample string 10</relationshipType>
      <surname>sample string 8</surname>
      <temp_id>11</temp_id>
      <title>sample string 6</title>
    </listBeneficiariesResult.dependantList>
  </insuredList>
  <success>true</success>
</listBeneficiariesResult>

text/html

Sample:

{"success":true,"errorMsg":"sample string 2","insuredList":[{"no_preAuth":true,"planName":"sample string 2","emailAddress":"sample string 3","dob":"sample string 4","enrolleeNo":"sample string 5","title":"sample string 6","otherName":"sample string 7","surname":"sample string 8","insureType":"sample string 9","relationshipType":"sample string 10","temp_id":11,"expiryDate":"sample string 12","picUrl":"sample string 13"},{"no_preAuth":true,"planName":"sample string 2","emailAddress":"sample string 3","dob":"sample string 4","enrolleeNo":"sample string 5","title":"sample string 6","otherName":"sample string 7","surname":"sample string 8","insureType":"sample string 9","relationshipType":"sample string 10","temp_id":11,"expiryDate":"sample string 12","picUrl":"sample string 13"}]}