GET api/UniqueOffers/ById/{uniqueOfferId}

Get UniqueOffer by Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
uniqueOfferId

Id 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": "ebcbd794-4b92-4fb4-badb-03afa5597cc2",
  "OfferId": "b2dfa924-433c-4cdb-9159-df80825728e0",
  "ConsumerId": "eb45d3fe-a85c-48ad-8f8b-c61999a8d3d1",
  "BarcodeId": "1619abc4-ad81-41ea-b68c-357c456d4948",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2019-03-21T01:37:21.7208781+00:00",
  "Offer": {
    "$id": "2",
    "Id": "7f43d6e4-97ff-40b6-ac04-fcc267f96ae9",
    "MerchantId": "fffc17e6-eeed-4be3-9bee-2d84b027d21d",
    "AppId": "da110507-b174-4990-87d5-e617aed7a93e",
    "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:21.7208781+00:00",
    "EndDate": "2019-03-21T01:37:21.7208781+00:00",
    "ExpiryDate": "2019-03-21T01:37:21.7208781+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2019-03-21T01:37:21.7208781+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "54ce5a62-7ab5-4719-ad89-63e7339c3218",
      "PlanId": "a7894bf5-6f74-4295-9620-ea17a364b26e",
      "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:21.7208781+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2019-03-21T01:37:21.7208781+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": "17b420ca-0fa6-46bb-b94d-c2f72f07e424",
        "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": "4e48ecf5-b182-4206-bf45-47d3d1b209d3",
          "MerchantId": "23cd220e-1ab4-471f-8f79-1844bb013786",
          "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": "39c69b72-a861-48b7-941c-c53f36caf810",
      "MerchantId": "e2ccd20b-ca81-4047-bd5b-129719d35537",
      "KeyId": "29c7c05d-18a0-49bd-8598-fad14f2c4dd5",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2019-03-21T01:37:21.7208781+00:00",
      "Modified": "2019-03-21T01:37:21.7208781+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "7cf46700-debd-4cdc-9f9a-37aac2fe6234",
        "MerchantId": "b0176f59-197b-4109-b37d-71f47b412222",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2019-03-21T01:37:21.7208781+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "fd14cdc3-08ef-4d1f-b71a-544c07c650c3",
        "FromConsumerId": "3bfeaa62-df39-45ef-8dce-d0e8d3426585",
        "ToConsumerId": "805fe180-b403-4f87-ad9f-063bed5ef4db",
        "OfferId": "7daeb265-a86a-48a2-859e-815ffac621b6",
        "Redeemed": true,
        "Timestamp": "2019-03-21T01:37:21.7208781+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2019-03-21T01:37:21.7208781+00:00",
        "MerchantLocationId": "f18cf659-60ae-4ccc-8484-5ea244c62313",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "453d58e3-2677-49a5-a632-6c356eeeab08",
          "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": "6079b6b2-2ff9-47ea-b77f-c747dfc18dee",
    "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.