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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"results":[{"id":0,"name":"String","description":"String","effectiveDate":"0001-01-01T00:00:00.0000000","discountType":"String","productDiscounts":{"String":0}}]}