GET v1/beneficiaryGlobal/listBeneficiaries?user_id={user_id}&policyNo={policyNo}

Request Information

URI Parameters

Name	Description	Type	Additional information
user_id		integer	Required
policyNo		string	Required

Body Parameters

None.

Response Information

Resource Description

listBeneficiariesResult

Name	Type	Additional information
success	boolean	None.
message	string	None.
errorMsg	string	None.
beneficiaries	Collection of beneficiaryDataDisplayItem	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "message": "sample string 2",
  "errorMsg": "sample string 3",
  "beneficiaries": [
    {
      "beneficiary_id": 1,
      "relationshipType": "sample string 2",
      "sharePercentage": 3.0,
      "emailAddress": "sample string 4",
      "mobileNo": "sample string 5",
      "firstName": "sample string 6",
      "lastName": "sample string 7",
      "dateOfBirth": "sample string 8",
      "picture_url": "sample string 9",
      "createdDate": "sample string 10"
    },
    {
      "beneficiary_id": 1,
      "relationshipType": "sample string 2",
      "sharePercentage": 3.0,
      "emailAddress": "sample string 4",
      "mobileNo": "sample string 5",
      "firstName": "sample string 6",
      "lastName": "sample string 7",
      "dateOfBirth": "sample string 8",
      "picture_url": "sample string 9",
      "createdDate": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample:

<listBeneficiariesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.beneficiary">
  <beneficiaries>
    <listBeneficiariesResult.beneficiaryDataDisplayItem>
      <beneficiary_id>1</beneficiary_id>
      <createdDate>sample string 10</createdDate>
      <dateOfBirth>sample string 8</dateOfBirth>
      <emailAddress>sample string 4</emailAddress>
      <firstName>sample string 6</firstName>
      <lastName>sample string 7</lastName>
      <mobileNo>sample string 5</mobileNo>
      <picture_url>sample string 9</picture_url>
      <relationshipType>sample string 2</relationshipType>
      <sharePercentage>3</sharePercentage>
    </listBeneficiariesResult.beneficiaryDataDisplayItem>
    <listBeneficiariesResult.beneficiaryDataDisplayItem>
      <beneficiary_id>1</beneficiary_id>
      <createdDate>sample string 10</createdDate>
      <dateOfBirth>sample string 8</dateOfBirth>
      <emailAddress>sample string 4</emailAddress>
      <firstName>sample string 6</firstName>
      <lastName>sample string 7</lastName>
      <mobileNo>sample string 5</mobileNo>
      <picture_url>sample string 9</picture_url>
      <relationshipType>sample string 2</relationshipType>
      <sharePercentage>3</sharePercentage>
    </listBeneficiariesResult.beneficiaryDataDisplayItem>
  </beneficiaries>
  <errorMsg>sample string 3</errorMsg>
  <message>sample string 2</message>
  <success>true</success>
</listBeneficiariesResult>

text/html

Sample:

{"success":true,"message":"sample string 2","errorMsg":"sample string 3","beneficiaries":[{"beneficiary_id":1,"relationshipType":"sample string 2","sharePercentage":3.0,"emailAddress":"sample string 4","mobileNo":"sample string 5","firstName":"sample string 6","lastName":"sample string 7","dateOfBirth":"sample string 8","picture_url":"sample string 9","createdDate":"sample string 10"},{"beneficiary_id":1,"relationshipType":"sample string 2","sharePercentage":3.0,"emailAddress":"sample string 4","mobileNo":"sample string 5","firstName":"sample string 6","lastName":"sample string 7","dateOfBirth":"sample string 8","picture_url":"sample string 9","createdDate":"sample string 10"}]}