POST v1/api/enrollee/addBeneficiary
Request Information
URI Parameters
None.
Body Parameters
addBeneficiaryRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| principalEnrolleeNo | string |
None. |
|
| enrolleeNo | string |
None. |
|
| firstName | string |
None. |
|
| lastName | string |
None. |
|
| emailAddress | string |
None. |
|
| mobileNo | string |
None. |
|
| update | boolean |
None. |
|
| dob_mm_dd_yyyy | string |
None. |
|
| RelationshipType | string |
None. |
|
| picture | documentUploadRequest |
None. |
Request Formats
application/json, text/json
Sample:
{
"principalEnrolleeNo": "sample string 1",
"enrolleeNo": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"emailAddress": "sample string 5",
"mobileNo": "sample string 6",
"update": true,
"dob_mm_dd_yyyy": "sample string 8",
"RelationshipType": "sample string 9",
"picture": {
"base64String": "sample string 1",
"fileFormat": "sample string 2",
"docName": "sample string 3"
}
}
application/xml, text/xml
Sample:
<addBeneficiaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/enrrolleeApp.Models.addBeneficiary">
<RelationshipType>sample string 9</RelationshipType>
<dob_mm_dd_yyyy>sample string 8</dob_mm_dd_yyyy>
<emailAddress>sample string 5</emailAddress>
<enrolleeNo>sample string 2</enrolleeNo>
<firstName>sample string 3</firstName>
<lastName>sample string 4</lastName>
<mobileNo>sample string 6</mobileNo>
<picture xmlns:d2p1="http://schemas.datacontract.org/2004/07/enrrolleeApp.Models">
<d2p1:base64String>sample string 1</d2p1:base64String>
<d2p1:docName>sample string 3</d2p1:docName>
<d2p1:fileFormat>sample string 2</d2p1:fileFormat>
</picture>
<principalEnrolleeNo>sample string 1</principalEnrolleeNo>
<update>true</update>
</addBeneficiaryRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
text/html
Sample:
{"principalEnrolleeNo":"sample string 1","enrolleeNo":"sample string 2","firstName":"sample string 3","lastName":"sample string 4","emailAddress":"sample string 5","mobileNo":"sample string 6","update":true,"dob_mm_dd_yyyy":"sample string 8","RelationshipType":"sample string 9","picture":{"base64String":"sample string 1","fileFormat":"sample string 2","docName":"sample string 3"}}
Response Information
Resource Description
addBeneficiaryResult| Name | Description | Type | Additional information |
|---|---|---|---|
| success | boolean |
None. |
|
| errorMsg | string |
None. |
|
| message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"success": true,
"errorMsg": "sample string 2",
"message": "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/enrrolleeApp.Models.addBeneficiary"> <errorMsg>sample string 2</errorMsg> <message>sample string 3</message> <success>true</success> </addBeneficiaryResult>
text/html
Sample:
{"success":true,"errorMsg":"sample string 2","message":"sample string 3"}