POST v1/beneficiaryGlobal/addGlobalBeneficiary

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
user_id		integer	None.
beneficiaries		Collection of beneficiaryDataItem	None.

Request Formats

application/json, text/json

Sample:

{
  "user_id": 1,
  "beneficiaries": [
    {
      "beneficiary_id": 1,
      "relationshipTypeCode": "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",
      "base64Picture": "sample string 9"
    },
    {
      "beneficiary_id": 1,
      "relationshipTypeCode": "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",
      "base64Picture": "sample string 9"
    }
  ]
}

application/xml, text/xml

Sample:

<addGlobalBeneficiaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.beneficiary">
  <beneficiaries>
    <beneficiaryDataItem>
      <base64Picture>sample string 9</base64Picture>
      <beneficiary_id>1</beneficiary_id>
      <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>
      <relationshipTypeCode>sample string 2</relationshipTypeCode>
      <sharePercentage>3</sharePercentage>
    </beneficiaryDataItem>
    <beneficiaryDataItem>
      <base64Picture>sample string 9</base64Picture>
      <beneficiary_id>1</beneficiary_id>
      <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>
      <relationshipTypeCode>sample string 2</relationshipTypeCode>
      <sharePercentage>3</sharePercentage>
    </beneficiaryDataItem>
  </beneficiaries>
  <user_id>1</user_id>
</addGlobalBeneficiaryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:

{"user_id":1,"beneficiaries":[{"beneficiary_id":1,"relationshipTypeCode":"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","base64Picture":"sample string 9"},{"beneficiary_id":1,"relationshipTypeCode":"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","base64Picture":"sample string 9"}]}

Response Information

Resource Description

addGlobalBeneficiaryResult

Name	Type	Additional information
success	boolean	None.
message	string	None.
errorMsg	string	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "message": "sample string 2",
  "errorMsg": "sample string 3"
}

application/xml, text/xml

Sample:

<addGlobalBeneficiaryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/unifiedApp.Models.beneficiary">
  <errorMsg>sample string 3</errorMsg>
  <message>sample string 2</message>
  <success>true</success>
</addGlobalBeneficiaryResult>

text/html

Sample:

{"success":true,"message":"sample string 2","errorMsg":"sample string 3"}