GET rest/recipients/{couponRecipientId}
Gets coupon recipient identified by recipientId.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
couponRecipientId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CouponRecipientName | Description | Type | Additional information |
---|---|---|---|
CodeBookId |
Id of coupon book, must be unique. |
globally unique identifier |
None. |
CouponId |
Id of coupon, must be unique. |
globally unique identifier |
None. |
CouponCode |
Coupon code. |
string |
None. |
CouponUrl |
Coupon url. |
string |
None. |
ValidFromUtc |
When the coupon should start being active. |
date |
None. |
Recipient |
Recipient phone/email/appId++. |
string |
None. |
RecipientType |
Type of recipient (MOBILE/MAIL/APP) |
string |
None. |
ExternalId |
External id of recipient. |
string |
None. |
BatchId |
Batch id of recipient. |
string |
None. |
State |
Id of state |
string |
None. |
RegDateUtc |
When the coupon code was created. |
date |
None. |
RedeemedCount |
Redeemed count |
byte |
None. |
Response Formats
application/json, text/json
Sample:
{ "codeBookId": "24cbcee7-e461-4595-9f29-fa3b40ca2923", "couponId": "2f9af51a-1906-418a-b886-fea583f40107", "couponCode": "sample string 2", "couponUrl": "sample string 3", "validFromUtc": "2022-08-03T23:34:38.3198675Z", "recipient": "sample string 4", "recipientType": "sample string 5", "externalId": "sample string 6", "batchId": "sample string 7", "state": "sample string 8", "regDateUtc": "2022-08-03T23:34:38.3198675Z", "redeemedCount": 64 }
application/xml, text/xml
Sample:
<CouponRecipient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.linkmobility.com/common/coupons"> <BatchId>sample string 7</BatchId> <CodeBookId>24cbcee7-e461-4595-9f29-fa3b40ca2923</CodeBookId> <CouponCode>sample string 2</CouponCode> <CouponId>2f9af51a-1906-418a-b886-fea583f40107</CouponId> <CouponUrl>sample string 3</CouponUrl> <ExternalId>sample string 6</ExternalId> <Recipient>sample string 4</Recipient> <RecipientType>sample string 5</RecipientType> <RedeemedCount>64</RedeemedCount> <RegDateUtc>2022-08-03T23:34:38.3198675+00:00</RegDateUtc> <State>sample string 8</State> <ValidFromUtc>2022-08-03T23:34:38.3198675+00:00</ValidFromUtc> </CouponRecipient>