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": "a4c43694-62fb-4253-b1d5-a6189aa40253",
  "OfferId": "28227257-26a8-48d9-abe0-782dc5360dcf",
  "ConsumerId": "4796faa7-fdf2-46da-817e-1ad1158122d4",
  "BarcodeId": "00c0b4f0-c69b-40b6-b780-93791add1a2d",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2019-03-21T01:37:34.8971486+00:00",
  "Offer": {
    "$id": "2",
    "Id": "6787695f-9a48-42f6-b4bb-76eb0280b5d6",
    "MerchantId": "2afe68eb-4ad1-4040-bb8b-6f1f76ff1f64",
    "AppId": "741b2f8d-4a7d-4247-bca9-6f7fe8cb7008",
    "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": "2019-03-21T01:37:34.8971486+00:00",
    "EndDate": "2019-03-21T01:37:34.8971486+00:00",
    "ExpiryDate": "2019-03-21T01:37:34.8971486+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2019-03-21T01:37:34.8971486+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "75d08bb6-5ff1-4426-bad9-571bc1710814",
      "PlanId": "ad0fc484-9c53-4cbe-9bd8-191e93283d13",
      "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": "2019-03-21T01:37:34.8971486+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2019-03-21T01:37:34.8971486+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": "006f84d2-8ef2-41d1-8d98-e25966b45a0f",
        "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": "84822c2d-e4a1-4a29-bc00-c63c09a5f35f",
          "MerchantId": "6d02a89b-4fda-479b-84f7-f791b0ce8b8b",
          "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,
          "GeoSpot": true,
          "StoreLocationId": "sample string 14",
          "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": "4c2b06d3-795d-4804-ad0a-4b42d1b0365d",
      "MerchantId": "10b2dd51-a7a7-4484-bfba-8107ab80f691",
      "KeyId": "174dfaaa-e2a4-4c28-b6fc-d225d773f77f",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2019-03-21T01:37:34.8971486+00:00",
      "Modified": "2019-03-21T01:37:34.8971486+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "747277ca-2cd0-4808-b823-4205ca0a051e",
        "MerchantId": "4f2ac740-544e-45f0-ad97-9368ec84cd60",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2019-03-21T01:37:34.8971486+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "85c9a903-66b7-406e-8d3e-8c4c0bc17278",
        "FromConsumerId": "663cc33a-2e72-474d-8fa3-9a1ed5ac5df9",
        "ToConsumerId": "9953bcc9-e5ea-4848-81ae-f6a1688d9c71",
        "OfferId": "4aa96fe7-7c58-4a84-9202-e9411a2d512c",
        "Redeemed": true,
        "Timestamp": "2019-03-21T01:37:34.8971486+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2019-03-21T01:37:34.8971486+00:00",
        "MerchantLocationId": "b4e1fae5-5932-4227-9a73-7451462501ef",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "5b28d990-0436-418a-aa71-3c23572b2a26",
          "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": "b0b703ac-d098-4d45-8e7f-e05261ed42e1",
    "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.