POST v1/api/enrollee/purchaseAdditionalBenefit

Request Information

URI Parameters

None.

Body Parameters

purchaseAdditionalBenefitRequest
NameDescriptionTypeAdditional information
addOn

boolean

None.

enrolleeNo

string

None.

schemeCode

string

None.

planName

string

None.

baseAmount

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "addOn": true,
  "enrolleeNo": "sample string 2",
  "schemeCode": "sample string 3",
  "planName": "sample string 4",
  "baseAmount": 5.0
}

application/xml, text/xml

Sample:
<purchaseAdditionalBenefitRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/enrrolleeApp.Models.purchaseAdditionalBenefit">
  <addOn>true</addOn>
  <baseAmount>5</baseAmount>
  <enrolleeNo>sample string 2</enrolleeNo>
  <planName>sample string 4</planName>
  <schemeCode>sample string 3</schemeCode>
</purchaseAdditionalBenefitRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:
{"addOn":true,"enrolleeNo":"sample string 2","schemeCode":"sample string 3","planName":"sample string 4","baseAmount":5.0}

Response Information

Resource Description

purchaseAdditionalBenefitResult
NameDescriptionTypeAdditional 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:
<purchaseAdditionalBenefitResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/enrrolleeApp.Models.purchaseAdditionalBenefit">
  <errorMsg>sample string 2</errorMsg>
  <message>sample string 3</message>
  <success>true</success>
</purchaseAdditionalBenefitResult>

text/html

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