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": "30a571dd-28bf-48da-89f5-62f8836b13ee",
  "OfferId": "669197f2-3534-4ccb-a55f-8752740c280b",
  "ConsumerId": "e9f384ec-0746-4d61-a984-4819c9b09407",
  "BarcodeId": "c3fc9e37-7d77-451b-b74e-bae15cae9c13",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2018-06-14T16:29:41.997465+00:00",
  "Offer": {
    "$id": "2",
    "Id": "0f0806b2-9be5-4343-9d23-cc9ebb259828",
    "MerchantId": "80286739-9e70-484b-89ba-1db8813e74ac",
    "AppId": "dc57e6f4-91dd-4bb9-b44c-b707582cb638",
    "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-06-14T16:29:41.997465+00:00",
    "EndDate": "2018-06-14T16:29:41.997465+00:00",
    "ExpiryDate": "2018-06-14T16:29:41.997465+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-06-14T16:29:41.997465+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "4a599585-781d-48ef-b927-1266217299f3",
      "PlanId": "5f35adb8-d59f-45f9-a5f9-ab58a45ceb65",
      "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-06-14T16:29:41.997465+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-06-14T16:29:41.997465+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": "e9c2bfc7-3de0-40b0-bdbc-302b2efb4a3d",
        "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": "6c4b37de-2e6d-4ebb-980a-eb74407e97ea",
          "MerchantId": "0d2c87fd-cdb8-4915-b990-4f18f7a4b125",
          "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,
          "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": "9404d2c1-0892-47b8-be47-6ca2fc4ebe97",
      "MerchantId": "86f10b3c-2e48-4d18-a3b2-dd156a9bfc1f",
      "KeyId": "b7184494-2d8f-47fb-9757-fdd47bff81e7",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-06-14T16:29:41.997465+00:00",
      "Modified": "2018-06-14T16:29:41.997465+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "648cb808-48bf-4307-9c43-01c7c3fd0be7",
        "MerchantId": "a956ce96-625b-4819-bc86-9a81e1fcc164",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-06-14T16:29:41.997465+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "6b52fdb5-eea3-445c-a71c-c91a61f3a807",
        "FromConsumerId": "d4a56d6b-e86f-4567-8c39-ccb597bbaaf3",
        "ToConsumerId": "7a401fef-4c1a-4183-854f-3bec08c9af87",
        "OfferId": "0319ccb7-46d7-49f9-8c2c-357d7659983d",
        "Redeemed": true,
        "Timestamp": "2018-06-14T16:29:41.997465+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-06-14T16:29:41.997465+00:00",
        "MerchantLocationId": "61351995-038c-46e2-927d-6c2e0c9ac3a7",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "694b824c-285a-4c5e-acb4-e4e6d3ab5ac4",
          "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": "0c006ade-457f-4d3c-86a2-21704197fffa",
    "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.