ApexERPHost

<back to all web services

GetCouponsByType

Requires Authentication
The following routes are available for this service:
GET/Coupons/ByType
GET/Coupons/ByType/{Type}
GetCouponsByType Parameters:
NameParameterData TypeRequiredDescription
Typepathint?No
GetCouponsByTypeResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CouponformList<Coupon>No
Coupon Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodeformstringNo
CouponTypeformintNo
ExpirationDateformDateTimeNo
VoidedformboolNo
UsedformboolNo
UseTimeformDateTime?No
DataformCouponDataNo
CouponStatusformint?No
ActivateIdformGuid?No
SpendIdformGuid?No
CouponData Parameters:
NameParameterData TypeRequiredDescription
ProdsformList<CouponProd>No
CouponProd Parameters:
NameParameterData TypeRequiredDescription
ProdIdformstringNo
IsServiceformintNo
TypeformintNo
SCountformdecimalNo
ValueTypeformintNo
ValueformdecimalNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Coupons/ByType HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCouponsByTypeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services.Warehousing">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Coupon>
    <Coupon>
      <Id>0</Id>
      <Code>String</Code>
      <CouponType>0</CouponType>
      <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
      <Voided>false</Voided>
      <Used>false</Used>
      <UseTime>0001-01-01T00:00:00</UseTime>
      <Data>
        <Prods>
          <CouponProd>
            <ProdId>String</ProdId>
            <IsService>0</IsService>
            <Type>0</Type>
            <SCount>0</SCount>
            <ValueType>0</ValueType>
            <Value>0</Value>
          </CouponProd>
        </Prods>
      </Data>
      <CouponStatus>0</CouponStatus>
      <ActivateId>00000000-0000-0000-0000-000000000000</ActivateId>
      <SpendId>00000000-0000-0000-0000-000000000000</SpendId>
    </Coupon>
  </Coupon>
</GetCouponsByTypeResponse>