Hmx Accounts

<back to all web services

GetCoupons

The following routes are available for this service:
GET/api/couponsSearch for coupons
GetCoupons Parameters:
NameParameterData TypeRequiredDescription
NamequerystringNo
FromDatequeryDateTime?No
ToDatequeryDateTime?No
DiscountTypequerystringNo
GetCouponsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<CouponDto>No
CouponDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
EffectiveDateformDateTimeNo
DiscountTypeformstringNo
ProductDiscountsformDictionary<string, decimal>No

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 /api/coupons HTTP/1.1 
Host: accounts.dev.healthmonix.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCouponsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hmx.Accounts.ServiceModels">
  <Results>
    <CouponDto>
      <Description>String</Description>
      <DiscountType>String</DiscountType>
      <EffectiveDate>0001-01-01T00:00:00</EffectiveDate>
      <Id>0</Id>
      <Name>String</Name>
      <ProductDiscounts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringdecimal>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:KeyValueOfstringdecimal>
      </ProductDiscounts>
    </CouponDto>
  </Results>
</GetCouponsResponse>