GET rest/coupons/booksgriddata?couponUsage={couponUsage}
Gets a list of coupons or booklets and their count (Supports OData 4.0).
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
couponUsage |
Valid for coupons and booklets. |
CouponUsage |
None. |
Body Parameters
None.
Response Information
Resource Description
BookResponseName | Description | Type | Additional information |
---|---|---|---|
Items |
Books collection |
Collection of Link |
None. |
TotalCount |
Total count of the Books |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "items": [ { "id": "9c521402-15c1-4a7c-8430-197f65e76f2f", "version": 64, "type": "sample string 3", "isInCouponBook": true, "name": "sample string 5", "description": "sample string 6", "created": 1653044990749, "from": "2022-05-20T11:09:50.7497509Z", "to": "2022-05-20T11:09:50.7497509Z", "count": 1, "uniqueViews": 1, "aggregatedTotalCouponViews": 1, "totalCouponViews": 1, "uniqueCouponViews": 1, "aggregatedUniqueCouponViews": 1, "totalCouponBookViews": 1, "uniqueCouponBookViews": 1, "uniqueRedemptions": 1, "generatedCount": 1, "aggregatedTotalCouponRedemptions": 1, "totalCouponRedemptions": 1, "aggregatedUniqueCouponRedemptions": 1, "uniqueCouponRedemptions": 1, "href": "sample string 8", "recipientCount": 1, "isActive": true, "isExpired": true, "isActiveSoon": true, "viewRatio": 1.0, "redeemRatio": 12.0, "shared": true, "sharedWithMe": true }, { "id": "9c521402-15c1-4a7c-8430-197f65e76f2f", "version": 64, "type": "sample string 3", "isInCouponBook": true, "name": "sample string 5", "description": "sample string 6", "created": 1653044990749, "from": "2022-05-20T11:09:50.7497509Z", "to": "2022-05-20T11:09:50.7497509Z", "count": 1, "uniqueViews": 1, "aggregatedTotalCouponViews": 1, "totalCouponViews": 1, "uniqueCouponViews": 1, "aggregatedUniqueCouponViews": 1, "totalCouponBookViews": 1, "uniqueCouponBookViews": 1, "uniqueRedemptions": 1, "generatedCount": 1, "aggregatedTotalCouponRedemptions": 1, "totalCouponRedemptions": 1, "aggregatedUniqueCouponRedemptions": 1, "uniqueCouponRedemptions": 1, "href": "sample string 8", "recipientCount": 1, "isActive": true, "isExpired": true, "isActiveSoon": true, "viewRatio": 1.0, "redeemRatio": 12.0, "shared": true, "sharedWithMe": true } ], "totalCount": 1 }
application/xml, text/xml
Sample:
<BookResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Coupons.Model"> <Items xmlns:d2p1="http://schemas.linkmobility.com/common/coupons"> <d2p1:Link> <d2p1:AggregatedTotalCouponRedemptions>1</d2p1:AggregatedTotalCouponRedemptions> <d2p1:AggregatedTotalCouponViews>1</d2p1:AggregatedTotalCouponViews> <d2p1:AggregatedUniqueCouponRedemptions>1</d2p1:AggregatedUniqueCouponRedemptions> <d2p1:AggregatedUniqueCouponViews>1</d2p1:AggregatedUniqueCouponViews> <d2p1:Count>1</d2p1:Count> <d2p1:Description>sample string 6</d2p1:Description> <d2p1:From>2022-05-20T11:09:50.7497509+00:00</d2p1:From> <d2p1:GeneratedCount>1</d2p1:GeneratedCount> <d2p1:Href>sample string 8</d2p1:Href> <d2p1:Id>9c521402-15c1-4a7c-8430-197f65e76f2f</d2p1:Id> <d2p1:IsActive>true</d2p1:IsActive> <d2p1:IsActiveSoon>true</d2p1:IsActiveSoon> <d2p1:IsExpired>true</d2p1:IsExpired> <d2p1:IsInCouponBook>true</d2p1:IsInCouponBook> <d2p1:Name>sample string 5</d2p1:Name> <d2p1:RecipientCount>1</d2p1:RecipientCount> <d2p1:RedeemRatio>12</d2p1:RedeemRatio> <d2p1:Shared>true</d2p1:Shared> <d2p1:SharedWithMe>true</d2p1:SharedWithMe> <d2p1:To>2022-05-20T11:09:50.7497509+00:00</d2p1:To> <d2p1:TotalCouponBookViews>1</d2p1:TotalCouponBookViews> <d2p1:TotalCouponRedemptions>1</d2p1:TotalCouponRedemptions> <d2p1:TotalCouponViews>1</d2p1:TotalCouponViews> <d2p1:Type>sample string 3</d2p1:Type> <d2p1:UniqueCouponBookViews>1</d2p1:UniqueCouponBookViews> <d2p1:UniqueCouponRedemptions>1</d2p1:UniqueCouponRedemptions> <d2p1:UniqueCouponViews>1</d2p1:UniqueCouponViews> <d2p1:UniqueRedemptions>1</d2p1:UniqueRedemptions> <d2p1:UniqueViews>1</d2p1:UniqueViews> <d2p1:Version>64</d2p1:Version> <d2p1:ViewRatio>1</d2p1:ViewRatio> <d2p1:created>2022-05-20T11:09:50.7497509+00:00</d2p1:created> </d2p1:Link> <d2p1:Link> <d2p1:AggregatedTotalCouponRedemptions>1</d2p1:AggregatedTotalCouponRedemptions> <d2p1:AggregatedTotalCouponViews>1</d2p1:AggregatedTotalCouponViews> <d2p1:AggregatedUniqueCouponRedemptions>1</d2p1:AggregatedUniqueCouponRedemptions> <d2p1:AggregatedUniqueCouponViews>1</d2p1:AggregatedUniqueCouponViews> <d2p1:Count>1</d2p1:Count> <d2p1:Description>sample string 6</d2p1:Description> <d2p1:From>2022-05-20T11:09:50.7497509+00:00</d2p1:From> <d2p1:GeneratedCount>1</d2p1:GeneratedCount> <d2p1:Href>sample string 8</d2p1:Href> <d2p1:Id>9c521402-15c1-4a7c-8430-197f65e76f2f</d2p1:Id> <d2p1:IsActive>true</d2p1:IsActive> <d2p1:IsActiveSoon>true</d2p1:IsActiveSoon> <d2p1:IsExpired>true</d2p1:IsExpired> <d2p1:IsInCouponBook>true</d2p1:IsInCouponBook> <d2p1:Name>sample string 5</d2p1:Name> <d2p1:RecipientCount>1</d2p1:RecipientCount> <d2p1:RedeemRatio>12</d2p1:RedeemRatio> <d2p1:Shared>true</d2p1:Shared> <d2p1:SharedWithMe>true</d2p1:SharedWithMe> <d2p1:To>2022-05-20T11:09:50.7497509+00:00</d2p1:To> <d2p1:TotalCouponBookViews>1</d2p1:TotalCouponBookViews> <d2p1:TotalCouponRedemptions>1</d2p1:TotalCouponRedemptions> <d2p1:TotalCouponViews>1</d2p1:TotalCouponViews> <d2p1:Type>sample string 3</d2p1:Type> <d2p1:UniqueCouponBookViews>1</d2p1:UniqueCouponBookViews> <d2p1:UniqueCouponRedemptions>1</d2p1:UniqueCouponRedemptions> <d2p1:UniqueCouponViews>1</d2p1:UniqueCouponViews> <d2p1:UniqueRedemptions>1</d2p1:UniqueRedemptions> <d2p1:UniqueViews>1</d2p1:UniqueViews> <d2p1:Version>64</d2p1:Version> <d2p1:ViewRatio>1</d2p1:ViewRatio> <d2p1:created>2022-05-20T11:09:50.7497509+00:00</d2p1:created> </d2p1:Link> </Items> <TotalCount>1</TotalCount> </BookResponse>