GET rest/recipients/{couponRecipientId}

Gets coupon recipient identified by recipientId.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
couponRecipientId

integer

Required

Body Parameters

None.

Response Information

Resource Description

CouponRecipient
NameDescriptionTypeAdditional 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": "81cb4be2-c6ce-44a3-9110-bb7248476f68",
  "couponId": "dc013adc-aa7f-401a-b69d-cd5ca4b17815",
  "couponCode": "sample string 2",
  "couponUrl": "sample string 3",
  "validFromUtc": "2018-12-18T23:27:36.9216335Z",
  "recipient": "sample string 4",
  "recipientType": "sample string 5",
  "externalId": "sample string 6",
  "batchId": "sample string 7",
  "state": "sample string 8",
  "regDateUtc": "2018-12-18T23:27:36.9216335Z",
  "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>81cb4be2-c6ce-44a3-9110-bb7248476f68</CodeBookId>
  <CouponCode>sample string 2</CouponCode>
  <CouponId>dc013adc-aa7f-401a-b69d-cd5ca4b17815</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>2018-12-18T23:27:36.9216335+00:00</RegDateUtc>
  <State>sample string 8</State>
  <ValidFromUtc>2018-12-18T23:27:36.9216335+00:00</ValidFromUtc>
</CouponRecipient>