GET api/UniqueOffers/ByConsumer/{consumerId}

Get UniqueOffers By ConsumerId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
consumerId

Id for the Consumer

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns a list of UniqueOffers

UniqueOffer
NameDescriptionTypeAdditional information
Id

GUID Id for UniqueOffer. Assigned by system on Create. [REQUIRED]

globally unique identifier

None.

OfferId

The OfferId for the Offer. [NULLABLE]

globally unique identifier

None.

ConsumerId

The ConsumerId for the Consumer. [NULLABLE]

globally unique identifier

None.

BarcodeId

The BarcodeId for the Barcode. [NULLABLE]

globally unique identifier

None.

Discount

The OfferReward Reward. [NULL]

string

String length: inclusive between 0 and 255

ShareDiscount

The OfferReward Reward once the share reward has been earned. [NULL]

string

None.

RedeemDiscount

The OfferReward Reward once the redemption reward has been earned. [NULL]

string

String length: inclusive between 0 and 255

Timestamp

Indicates when the UniqueOffer was created. [NULLABLE]

date

None.

Offer

Gets the Offer using OfferId.

Offer

None.

Consumer

Gets the Consumer using ConsumerId.

Consumer

None.

Barcode

Gets the Bardcode using BarcodeId.

Barcode

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "508f43aa-8412-4f13-8152-48d6b7029dc6",
  "OfferId": "02708f29-5d9f-4774-813d-72dad2a7abcc",
  "ConsumerId": "6dec392d-2199-4eeb-8672-85dfb37d81f3",
  "BarcodeId": "15e319d1-4207-4f80-a992-940f43afbf56",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2018-06-14T16:43:09.8739634+00:00",
  "Offer": {
    "$id": "2",
    "Id": "26848f6a-e9a5-4cef-88e3-fc241514afa8",
    "MerchantId": "0380728b-d3aa-4074-93d2-20c37f36afda",
    "AppId": "b23d6fdc-3052-425c-86c6-5a9af8865186",
    "Type": 0,
    "Reward": "sample string 4",
    "IsRewardBased": true,
    "Name": "sample string 5",
    "Description": "sample string 6",
    "TermsConditions": "sample string 7",
    "Tags": "sample string 8",
    "StartDate": "2018-06-14T16:43:09.8739634+00:00",
    "EndDate": "2018-06-14T16:43:09.8739634+00:00",
    "ExpiryDate": "2018-06-14T16:43:09.8739634+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-06-14T16:43:09.8739634+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "1d7562c2-af28-43fa-ad05-6dede4a1a688",
      "PlanId": "c245a961-0c2b-4eff-8ea8-82862df58f7a",
      "StripeToken": "sample string 2",
      "StripeCustomerId": "sample string 3",
      "CompanyName": "sample string 4",
      "UserId": "sample string 5",
      "Active": true,
      "Deleted": true,
      "TimeZone": "sample string 8",
      "User": {
        "$id": "4",
        "Id": "sample string 1",
        "Email": "sample string 2",
        "EmailConfirmed": true,
        "UserName": "sample string 10",
        "FirstName": "sample string 11",
        "LastName": "sample string 12",
        "Address1": "sample string 13",
        "Address2": "sample string 14",
        "City": "sample string 15",
        "State": "sample string 16",
        "Country": "sample string 17",
        "ZipCode": "sample string 18",
        "DateRegistered": "2018-06-14T16:43:09.8739634+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-06-14T16:43:09.8739634+00:00",
        "TermsConditions": true,
        "MobileNumber": "sample string 21",
        "ProfileImage": "sample string 22",
        "FullName": "sample string 12, sample string 11",
        "Roles": [
          {
            "$id": "5",
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Users": [
              {
                "$ref": "4"
              },
              {
                "$ref": "4"
              }
            ]
          },
          {
            "$ref": "5"
          }
        ]
      },
      "Plan": {
        "$id": "6",
        "Id": "d75c2ee5-954b-4d47-8f2f-6df4ec3f5f4b",
        "PlanName": "sample string 2",
        "Description": "sample string 3",
        "LimitedApps": true,
        "AppLimit": 1,
        "LimitedLocations": true,
        "LocationLimit": 1,
        "LimitedOffers": true,
        "OfferLimit": 1,
        "Amount": 1,
        "WithCall": true,
        "SortNo": 8,
        "Billable": true
      },
      "MerchantLocations": [
        {
          "$id": "7",
          "Id": "c236978d-451b-48df-8c8d-b0d1202bc3d0",
          "MerchantId": "3f264689-af66-4e60-a04d-0fa509b3a0e2",
          "Active": true,
          "Name": "sample string 4",
          "Address1": "sample string 5",
          "Address2": "sample string 6",
          "City": "sample string 7",
          "State": "sample string 8",
          "ZipCode": "sample string 9",
          "PhoneNumber": "sample string 10",
          "Deleted": true,
          "Main": true,
          "Latitude": 1.1,
          "Longitude": 1.1,
          "GeoLocation": null,
          "Merchant": {
            "$ref": "3"
          },
          "CompleteAddress": "sample string 5, sample string 6, sample string 7, sample string 8, sample string 9"
        },
        {
          "$ref": "7"
        }
      ]
    },
    "App": {
      "$id": "8",
      "Id": "0edce81f-4116-46b3-8c80-3b3c684789ca",
      "MerchantId": "42babb45-2f21-4615-9466-ee4ff12ed523",
      "KeyId": "66f36bea-853f-44a7-956c-8a7b7b86afd0",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-06-14T16:43:09.8739634+00:00",
      "Modified": "2018-06-14T16:43:09.8739634+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "af2deee6-8255-4584-9a23-89df4b247b5b",
        "MerchantId": "d7911a82-d924-4313-890a-4e585ce25e19",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-06-14T16:43:09.8739634+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "2001f3b9-a0da-485e-b4ea-bb8f1e5c2e1b",
        "FromConsumerId": "a3987f71-2c81-4df1-9402-1d52fdd1b32b",
        "ToConsumerId": "b98bc239-b543-4c94-a1e5-566ac69be9ba",
        "OfferId": "ab90fcf0-7e30-4168-987c-6a39304cb3fa",
        "Redeemed": true,
        "Timestamp": "2018-06-14T16:43:09.8739634+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-06-14T16:43:09.8739634+00:00",
        "MerchantLocationId": "e67d78fc-ec27-4415-a23d-607d57650f2e",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "85d0df83-3ad9-4faf-b23b-a3ec1b6151b3",
          "Gender": "sample string 2",
          "Address1": "sample string 3",
          "Address2": "sample string 4",
          "City": "sample string 5",
          "State": "sample string 6",
          "ZipCode": "sample string 7",
          "Image": "sample string 8",
          "Deleted": true
        },
        "Consumer1": {
          "$ref": "11"
        },
        "Offer": {
          "$ref": "2"
        }
      },
      {
        "$ref": "10"
      }
    ]
  },
  "Consumer": {
    "$ref": "11"
  },
  "Barcode": {
    "$id": "12",
    "Id": "38d06a13-a246-4e82-a000-33dcea72ed49",
    "Type": 1,
    "Code": "sample string 2",
    "Deleted": true
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[FaceOffers.Entities.UniqueOffer, FaceOffers.Entities, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[FaceOffers.Entities.UniqueOffer, FaceOffers.Entities, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.