POST api/v1/Benefits/{token}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| token | string |
Required |
Body Parameters
PlanOptionAPI| Name | Description | Type | Additional information |
|---|---|---|---|
| ssn | string |
Required String length: inclusive between 9 and 10 |
|
| benid | string |
Required String length: inclusive between 0 and 50 |
|
| benDeduction | string |
Required String length: inclusive between 0 and 10 |
|
| totBenAmount | string |
Required String length: inclusive between 0 and 10 |
|
| inforceBenAmount | string |
Required String length: inclusive between 0 and 10 |
|
| benEffDate | date |
Required |
Request Formats
application/json, text/json
Sample:
{
"ssn": "sample string 1",
"benid": "sample string 2",
"benDeduction": "sample string 3",
"totBenAmount": "sample string 4",
"inforceBenAmount": "sample string 5",
"benEffDate": "2024-11-21T06:40:36.2713659+00:00"
}
application/xml, text/xml
Sample:
<PlanOptionAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ssn>sample string 1</ssn> <benid>sample string 2</benid> <benDeduction>sample string 3</benDeduction> <totBenAmount>sample string 4</totBenAmount> <inforceBenAmount>sample string 5</inforceBenAmount> <benEffDate>2024-11-21T06:40:36.2713659+00:00</benEffDate> </PlanOptionAPI>
Response Information
Resource Description
PlanOptionAPI| Name | Description | Type | Additional information |
|---|---|---|---|
| ssn | string |
Required String length: inclusive between 9 and 10 |
|
| benid | string |
Required String length: inclusive between 0 and 50 |
|
| benDeduction | string |
Required String length: inclusive between 0 and 10 |
|
| totBenAmount | string |
Required String length: inclusive between 0 and 10 |
|
| inforceBenAmount | string |
Required String length: inclusive between 0 and 10 |
|
| benEffDate | date |
Required |
Response Formats
application/json, text/json
Sample:
{
"ssn": "sample string 1",
"benid": "sample string 2",
"benDeduction": "sample string 3",
"totBenAmount": "sample string 4",
"inforceBenAmount": "sample string 5",
"benEffDate": "2024-11-21T06:40:36.2870189+00:00"
}
application/xml, text/xml
Sample:
<PlanOptionAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ssn>sample string 1</ssn> <benid>sample string 2</benid> <benDeduction>sample string 3</benDeduction> <totBenAmount>sample string 4</totBenAmount> <inforceBenAmount>sample string 5</inforceBenAmount> <benEffDate>2024-11-21T06:40:36.2870189+00:00</benEffDate> </PlanOptionAPI>