GET api/couponcodes/ListByExpiryDate?ExpiryDate={ExpiryDate}

Get a list of unique coupon codes

Request Information

URI Parameters

Name	Description	Type	Additional information
ExpiryDate	The campaign id for which the codes have to be listed	date	Required

Body Parameters

Response Information

Resource Description

getcodesfordevicesresult

Name	Description	Type	Additional information
success	Indicates if the action was successfull	boolean	None.
remark	A description regarding the result	string	None.
codesfordevices	Returns an array of unique customer devices	Collection of codesfordevice	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<getcodesfordevicesresult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechnoDataSystems.Enterprise.TotalWash.Web.API">
  <codesfordevices>
    <codesfordevice>
      <codes>
        <code>
          <code>sample string 1</code>
          <description>sample string 4</description>
          <licenceplate>sample string 3</licenceplate>
          <redeemed>true</redeemed>
          <timestamp>2024-11-24T12:34:30.2119122+01:00</timestamp>
          <validuntil>2024-11-24T12:34:30.2119122+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:34:30.2119122+01:00</timestamp>
          <validuntil>2024-11-24T12:34:30.2119122+01:00</validuntil>
        </code>
      </codes>
      <identification>sample string 1</identification>
    </codesfordevice>
    <codesfordevice>
      <codes>
        <code>
          <code>sample string 1</code>
          <description>sample string 4</description>
          <licenceplate>sample string 3</licenceplate>
          <redeemed>true</redeemed>
          <timestamp>2024-11-24T12:34:30.2119122+01:00</timestamp>
          <validuntil>2024-11-24T12:34:30.2119122+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:34:30.2119122+01:00</timestamp>
          <validuntil>2024-11-24T12:34:30.2119122+01:00</validuntil>
        </code>
      </codes>
      <identification>sample string 1</identification>
    </codesfordevice>
  </codesfordevices>
  <remark>sample string 2</remark>
  <success>true</success>
</getcodesfordevicesresult>