POST v1/beneficiaryGlobal/AddBeneficiary
Request Information
URI Parameters
None.
Body Parameters
AddBeneficiaryRequestName | Description | Type | Additional information |
---|---|---|---|
user_id | integer |
None. |
|
policyNo | string |
None. |
|
beneficiaries | Collection of beneficiaryDataItem |
None. |
Request Formats
application/json, text/json
Sample:
{ "user_id": 1, "policyNo": "sample string 2", "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:
<AddBeneficiaryRequest 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> <policyNo>sample string 2</policyNo> <user_id>1</user_id> </AddBeneficiaryRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
text/html
Sample:
{"user_id":1,"policyNo":"sample string 2","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
AddBeneficiaryResultName | Description | 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:
<AddBeneficiaryResult 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> </AddBeneficiaryResult>
text/html
Sample:
{"success":true,"message":"sample string 2","errorMsg":"sample string 3"}