GET api/couponcodes/GetCode?Code={Code}
Get coupon code
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Code |
The unique code of the coupon |
string |
Required |
Body Parameters
Response Information
Resource Description
getcoderesultName | Description | Type | Additional information |
---|---|---|---|
success |
Indicates if the action was successfull |
boolean |
None. |
remark |
A description regarding the result |
string |
None. |
code |
Returns an array of code objects |
code |
None. |
campaign |
The identification of the campaign |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "success": true, "remark": "sample string 2", "code": { "code": "sample string 1", "redeemed": true, "timestamp": "2024-11-24T13:03:10.4022659+01:00", "validuntil": "2024-11-24T13:03:10.4022659+01:00", "licenceplate": "sample string 3", "description": "sample string 4" }, "campaign": "sample string 3" }
application/xml, text/xml
Sample:
<getcoderesult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechnoDataSystems.Enterprise.TotalWash.Web.API"> <campaign>sample string 3</campaign> <code> <code>sample string 1</code> <description>sample string 4</description> <licenceplate>sample string 3</licenceplate> <redeemed>true</redeemed> <timestamp>2024-11-24T13:03:10.4022659+01:00</timestamp> <validuntil>2024-11-24T13:03:10.4022659+01:00</validuntil> </code> <remark>sample string 2</remark> <success>true</success> </getcoderesult>