POST api/admin/coupon/Create
Request Information
URI Parameters
None.
Body Parameters
CouponBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CouponID | string |
None. |
|
| Description | string |
None. |
|
| ExpirationDate | string |
None. |
|
| SetupTimeStart | string |
None. |
|
| SetupTimeStartTime | string |
None. |
|
| RecurTimeStartTime | string |
None. |
|
| RecurPeriodTime | string |
None. |
|
| PlanPeriodTime | string |
None. |
|
| SetupAmount | string |
None. |
|
| RecurTimeStart | string |
None. |
|
| RecurAmount | string |
None. |
|
| RecurPeriod | string |
None. |
|
| PlanPeriod | string |
None. |
|
| AutoRenew | string |
None. |
|
| IgnoreCC | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"couponID": "sample string 1",
"description": "sample string 2",
"expirationDate": "sample string 3",
"setupTimeStart": "sample string 4",
"setupTimeStartTime": "sample string 5",
"recurTimeStartTime": "sample string 6",
"recurPeriodTime": "sample string 7",
"planPeriodTime": "sample string 8",
"setupAmount": "sample string 9",
"recurTimeStart": "sample string 10",
"recurAmount": "sample string 11",
"recurPeriod": "sample string 12",
"planPeriod": "sample string 13",
"autoRenew": "sample string 14",
"ignoreCC": true
}
text/html
Sample:
{"couponID":"sample string 1","description":"sample string 2","expirationDate":"sample string 3","setupTimeStart":"sample string 4","setupTimeStartTime":"sample string 5","recurTimeStartTime":"sample string 6","recurPeriodTime":"sample string 7","planPeriodTime":"sample string 8","setupAmount":"sample string 9","recurTimeStart":"sample string 10","recurAmount":"sample string 11","recurPeriod":"sample string 12","planPeriod":"sample string 13","autoRenew":"sample string 14","ignoreCC":true}
application/xml, text/xml
Sample:
<CouponBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ps.BusinessObjects.BindingModels.Coupon"> <AutoRenew>sample string 14</AutoRenew> <CouponID>sample string 1</CouponID> <Description>sample string 2</Description> <ExpirationDate>sample string 3</ExpirationDate> <IgnoreCC>true</IgnoreCC> <PlanPeriod>sample string 13</PlanPeriod> <PlanPeriodTime>sample string 8</PlanPeriodTime> <RecurAmount>sample string 11</RecurAmount> <RecurPeriod>sample string 12</RecurPeriod> <RecurPeriodTime>sample string 7</RecurPeriodTime> <RecurTimeStart>sample string 10</RecurTimeStart> <RecurTimeStartTime>sample string 6</RecurTimeStartTime> <SetupAmount>sample string 9</SetupAmount> <SetupTimeStart>sample string 4</SetupTimeStart> <SetupTimeStartTime>sample string 5</SetupTimeStartTime> </CouponBindingModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
DataActionResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| Data | Object |
None. |
Response Formats
application/json, text/json
Sample:
{
"isSuccessful": true,
"errorMessage": "sample string 2",
"data": {}
}
text/html
Sample:
{"isSuccessful":true,"errorMessage":"sample string 2","data":{}}
application/xml, text/xml
Sample:
<DataActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ps.CoreUtilities.Framework.Exceptions"> <Data /> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </DataActionResponse>