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": "2322b51c-2ee2-4ed2-8de1-445f1e55f126",
  "OfferId": "acda8b56-1fef-4317-9467-f3f26ab0750d",
  "ConsumerId": "3dbff816-9e55-4a41-b449-d1191ee22186",
  "BarcodeId": "f2218e0b-a42b-413d-b9c3-24363d33e493",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2018-12-12T05:11:20.2302907+00:00",
  "Offer": {
    "$id": "2",
    "Id": "3977593d-2cd1-4b95-8fdc-c0eee1c5d163",
    "MerchantId": "12c836b7-5217-427e-acc2-c04b61e3a322",
    "AppId": "c5e4ab79-7db6-4814-b78b-8108f00c09fb",
    "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-12-12T05:11:20.2302907+00:00",
    "EndDate": "2018-12-12T05:11:20.2302907+00:00",
    "ExpiryDate": "2018-12-12T05:11:20.2302907+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-12-12T05:11:20.2302907+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "44b0b712-d332-499c-a486-ef527b2463ef",
      "PlanId": "5f7c64d2-4275-4ad6-8b70-1242c044fb02",
      "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-12-12T05:11:20.2302907+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-12-12T05:11:20.2302907+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": "b5270d23-d7a4-40ae-8792-a878af58873d",
        "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": "7b2d8fda-f79d-48e2-bc03-64b135ca9150",
          "MerchantId": "a08fbb12-0804-4846-9510-f394a83a23e0",
          "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": "a8755f17-a30b-464c-9e64-997cb9655c6a",
      "MerchantId": "f393f318-803d-4d26-be55-0650b9742314",
      "KeyId": "5dd110a2-3ec1-4172-bf70-82ae63288faf",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-12-12T05:11:20.2302907+00:00",
      "Modified": "2018-12-12T05:11:20.2302907+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "04b93573-5285-4d56-9dbc-85fd9994c6b2",
        "MerchantId": "454f342b-2d0f-4535-8312-1cb342cbe64e",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-12-12T05:11:20.2302907+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "59c4817f-ffd0-4936-b0a4-2034bebe00ee",
        "FromConsumerId": "78d50be0-ed5b-4f3f-b482-72111d567ef9",
        "ToConsumerId": "1902094f-661d-4866-b453-15b829138345",
        "OfferId": "b8b7d4a1-a356-4ab7-8a61-45439daa9e4e",
        "Redeemed": true,
        "Timestamp": "2018-12-12T05:11:20.2302907+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-12-12T05:11:20.2302907+00:00",
        "MerchantLocationId": "2b082782-3bc9-4276-a1ab-5607fc9f25b7",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "31eb0ec2-1f61-42f6-b9ed-0f9e45e07ce2",
          "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": "71ff0627-bd0f-4446-be7a-61b212b55985",
    "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.