GET api/UniqueOffers/ByBarcodeId/{barcodeId}

Get UniqueOffer by BarcodeId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
barcodeId

BarcodeId for the UniqueOffer

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns a UniqueOffer

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": "845f325e-4161-4a02-88d5-8bb0910745c0",
  "OfferId": "40a9b319-4390-4b5b-b388-fd8260429419",
  "ConsumerId": "49aa11d6-640b-4876-a9ad-24d166656544",
  "BarcodeId": "d832abf7-cdb6-44a5-a514-0cdd9e8ca672",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2019-03-21T01:47:42.3678198+00:00",
  "Offer": {
    "$id": "2",
    "Id": "0921b6a1-10a4-47a1-bcb6-01d76315c7a1",
    "MerchantId": "3304df07-4922-4725-9775-86365c8e29a8",
    "AppId": "a7b83a83-c07a-4345-9ed4-cdc483b777d6",
    "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:47:42.3678198+00:00",
    "EndDate": "2019-03-21T01:47:42.3678198+00:00",
    "ExpiryDate": "2019-03-21T01:47:42.3678198+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2019-03-21T01:47:42.3678198+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "33173ed2-2192-4d39-b453-976e51997908",
      "PlanId": "ce9674b0-473c-45f6-9d83-a329bccff21c",
      "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:47:42.3678198+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2019-03-21T01:47:42.3678198+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": "f37adadd-6180-4a8e-a063-4c7cb192eac4",
        "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": "52167f8c-3062-4785-851a-0ddfbd94e94e",
          "MerchantId": "42e2a982-1a37-4097-8d0c-c79743b48e3d",
          "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": "7bc57182-25d5-46cd-b871-1493be60aebd",
      "MerchantId": "a41d51f4-46ac-46ab-8380-370d9c231752",
      "KeyId": "9acff287-a09c-4e2a-8651-7fc0e0c65fe6",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2019-03-21T01:47:42.3678198+00:00",
      "Modified": "2019-03-21T01:47:42.3678198+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "2bc510a5-d2d2-4237-99b4-7d8805aaff7a",
        "MerchantId": "05042f7c-1383-4a7a-8e3c-c862013a325c",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2019-03-21T01:47:42.3678198+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "ffc3ccd2-7ee0-467e-aef9-2d397af7bcb1",
        "FromConsumerId": "9f1426f5-3c8f-4682-8bed-225c9b718168",
        "ToConsumerId": "1add87c1-cc39-47c4-b4aa-d28fa5eb45a7",
        "OfferId": "a362469b-01bb-4f0a-bb37-a2b2d092271c",
        "Redeemed": true,
        "Timestamp": "2019-03-21T01:47:42.3678198+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2019-03-21T01:47:42.3678198+00:00",
        "MerchantLocationId": "992868cc-e043-4213-b691-6cd46c3d917d",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "b7030f1b-0943-4bd4-9d48-ea253dc0d8ca",
          "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": "8f150a94-2568-41dd-bdea-1ca9c41fc314",
    "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.