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": "0a4d4158-7ea3-4dab-90af-e0fdb68cb71c",
  "OfferId": "28af0c39-8221-4c93-83e5-99c72a5116c7",
  "ConsumerId": "e0d48b05-e413-4d39-83d1-288eef6f1974",
  "BarcodeId": "8b343a2a-85f1-4588-84c6-eb6a636de70f",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2018-09-21T19:57:58.0613118+00:00",
  "Offer": {
    "$id": "2",
    "Id": "658a90cf-6604-4b51-96d1-175fc85896e5",
    "MerchantId": "29ed8cda-1d40-4eef-a7b1-8dd4e3e2f7d5",
    "AppId": "d3c6e2b6-8e0b-47a0-90c8-3fe95b6deeb6",
    "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-09-21T19:57:58.0613118+00:00",
    "EndDate": "2018-09-21T19:57:58.0613118+00:00",
    "ExpiryDate": "2018-09-21T19:57:58.0613118+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-09-21T19:57:58.0613118+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "c1225336-6f75-4f1d-9f85-4ccdab5f10b3",
      "PlanId": "8b31f658-4fc8-4b65-a267-f1cdd4f46b69",
      "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-09-21T19:57:58.0613118+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-09-21T19:57:58.0613118+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": "12e41333-e1a7-4e7d-a62c-ff39188a3c50",
        "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": "6e28c99c-8ba9-4837-8bfe-aaa224478353",
          "MerchantId": "6af47466-a34b-4b97-8923-c5f62e3fd5d8",
          "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,
          "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": "d23c1f43-c177-4211-906a-deb8dcc15833",
      "MerchantId": "1cb9f12b-aec6-49a7-ad7d-6756c450b245",
      "KeyId": "d8819120-451d-4d01-9e40-97b25946a5cb",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-09-21T19:57:58.0613118+00:00",
      "Modified": "2018-09-21T19:57:58.0613118+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "95a4434b-d20a-4932-b1a2-1313c2d3d689",
        "MerchantId": "adf3a83b-0780-42b9-96d4-58f1ab47e6dc",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-09-21T19:57:58.0613118+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "1c06f79e-bbe4-4c8f-b276-c91aaad45975",
        "FromConsumerId": "a4fdaf0e-b9ca-42fe-9537-8e49b1109743",
        "ToConsumerId": "ab1102c9-7706-4e9b-a9b4-acbe13a1caec",
        "OfferId": "d849dee3-269b-407f-8628-4dbcf6f103cd",
        "Redeemed": true,
        "Timestamp": "2018-09-21T19:57:58.0613118+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-09-21T19:57:58.0613118+00:00",
        "MerchantLocationId": "c1c17ae8-76c0-4071-a022-8f81257573b6",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "cd84e466-ab67-4d45-8b24-9aa57df40e26",
          "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": "75a4f7ba-8b73-4515-92cf-395980c231d6",
    "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.