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": "4cb976a3-24da-4cd2-8b40-12f58f39f471",
  "OfferId": "08a84afe-6dc2-4b64-b28f-e8c54b8b21f2",
  "ConsumerId": "9ffebc2b-1f82-4be7-8fe7-4473b11b856c",
  "BarcodeId": "754e557a-7d99-4a1b-be9a-dee770cff802",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2018-09-21T19:32:53.5916166+00:00",
  "Offer": {
    "$id": "2",
    "Id": "527e34b1-1d0b-4a27-88b5-2cf10e319bf2",
    "MerchantId": "40646f38-d1ec-4120-8401-924c5ab0f3ca",
    "AppId": "379ae05b-7ac6-44db-a6d3-8f0efe3e0b99",
    "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:32:53.5916166+00:00",
    "EndDate": "2018-09-21T19:32:53.5916166+00:00",
    "ExpiryDate": "2018-09-21T19:32:53.5916166+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-09-21T19:32:53.5916166+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "b97548be-b3ed-403f-a4ac-a9cb9516a173",
      "PlanId": "c4b24c02-9f72-48ab-b9af-a2481a55b917",
      "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:32:53.5916166+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-09-21T19:32:53.5916166+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": "46f77420-245f-463a-a9ce-809ba06b23d9",
        "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": "fc6c4a81-cd6f-47ee-a56e-31aa412f85c2",
          "MerchantId": "14c5033e-2aaa-4acc-9171-50ec73c14b61",
          "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": "cc40ef38-e907-4933-871b-aecf1db4e477",
      "MerchantId": "2d59410c-18c6-4749-a68b-ef9c116309cb",
      "KeyId": "8beebbb5-45f4-4f08-9617-92326d76bd52",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-09-21T19:32:53.5916166+00:00",
      "Modified": "2018-09-21T19:32:53.5916166+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "2829b0cf-334a-49f5-89ff-cae5b0c5a814",
        "MerchantId": "9ea02ada-86b9-4261-bb53-4f90a00889c0",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-09-21T19:32:53.5916166+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "99308013-fcd3-44e7-8ca2-d38c6e1815cf",
        "FromConsumerId": "f60a34ed-d1e3-48c9-9075-7da502be41cb",
        "ToConsumerId": "79bb1fc9-5412-4f30-8bf7-26850a34481e",
        "OfferId": "f0d725d2-c1b9-48bb-b40e-c9c7b244c778",
        "Redeemed": true,
        "Timestamp": "2018-09-21T19:32:53.5916166+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-09-21T19:32:53.5916166+00:00",
        "MerchantLocationId": "81bde67e-06fb-4620-b32f-1e0014be5bc0",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "1c4d920d-7fdc-456c-8e3f-362578c393e7",
          "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": "edd203f4-c511-4218-8bf0-0f685642fe30",
    "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.