GET api/couponcodes/List?CampaignId={CampaignId}&Redeemed={Redeemed}&TimeStampBegin={TimeStampBegin}&TimeStampEnd={TimeStampEnd}

Get a list of unique coupon codes

Request Information

URI Parameters

Name	Description	Type	Additional information
CampaignId	The campaign id for which the codes have to be listed	string	Required
Redeemed		boolean	None.
TimeStampBegin	The start timestamp, this	date	None.
TimeStampEnd	The end timestamp	date	None.

Body Parameters

Response Information

Resource Description

getcodesresult

Name	Description	Type	Additional information
success	Indicates if the action was successfull	boolean	None.
remark	A description regarding the result	string	None.
codes	Returns an array of code objects	Collection of code	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "remark": "sample string 2",
  "codes": [
    {
      "code": "sample string 1",
      "redeemed": true,
      "timestamp": "2024-11-24T12:30:49.8928517+01:00",
      "validuntil": "2024-11-24T12:30:49.8928517+01:00",
      "licenceplate": "sample string 3",
      "description": "sample string 4"
    },
    {
      "code": "sample string 1",
      "redeemed": true,
      "timestamp": "2024-11-24T12:30:49.8928517+01:00",
      "validuntil": "2024-11-24T12:30:49.8928517+01:00",
      "licenceplate": "sample string 3",
      "description": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<getcodesresult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechnoDataSystems.Enterprise.TotalWash.Web.API">
  <codes>
    <code>
      <code>sample string 1</code>
      <description>sample string 4</description>
      <licenceplate>sample string 3</licenceplate>
      <redeemed>true</redeemed>
      <timestamp>2024-11-24T12:30:49.8928517+01:00</timestamp>
      <validuntil>2024-11-24T12:30:49.8928517+01:00</validuntil>
    </code>
    <code>
      <code>sample string 1</code>
      <description>sample string 4</description>
      <licenceplate>sample string 3</licenceplate>
      <redeemed>true</redeemed>
      <timestamp>2024-11-24T12:30:49.8928517+01:00</timestamp>
      <validuntil>2024-11-24T12:30:49.8928517+01:00</validuntil>
    </code>
  </codes>
  <remark>sample string 2</remark>
  <success>true</success>
</getcodesresult>