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": "88fce8fc-804f-4f11-a63f-2ffc16e7cf4b",
  "OfferId": "9b05ea74-c1a9-4671-8170-ff19bc44e4fe",
  "ConsumerId": "5023eed8-ddf9-4bd9-8328-3e21a7bf4c66",
  "BarcodeId": "0976bb03-59a9-4ee8-a902-137fd3768a6c",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2018-12-12T05:11:12.2605339+00:00",
  "Offer": {
    "$id": "2",
    "Id": "f47e73db-2457-415f-bccd-7c22b3260ed3",
    "MerchantId": "9213faf8-4a1a-4492-acc0-fd34371124f4",
    "AppId": "a28d2619-4788-4b21-b6eb-03c5640da197",
    "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-12-12T05:11:12.2605339+00:00",
    "EndDate": "2018-12-12T05:11:12.2605339+00:00",
    "ExpiryDate": "2018-12-12T05:11:12.2605339+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-12-12T05:11:12.2605339+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "01354440-d29e-4df0-8c02-31b84f9be9ff",
      "PlanId": "de4e36cf-c412-48f7-887f-d8557ab5b535",
      "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-12-12T05:11:12.2605339+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-12-12T05:11:12.2605339+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": "f68a3409-b450-453c-a5b6-e3ccd46ac503",
        "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": "9a1da66c-c8b3-482e-9bce-ef2885367d32",
          "MerchantId": "10563524-4f7b-465e-af55-337c7d12103c",
          "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": "37b0d26c-fcbd-41e2-b9d7-05dc013abec3",
      "MerchantId": "39e0f15d-95a5-4e53-b695-c5105490a950",
      "KeyId": "1cdb0bb7-82cf-4a5d-b00d-55f8e25786af",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-12-12T05:11:12.2605339+00:00",
      "Modified": "2018-12-12T05:11:12.2605339+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "bb198528-d649-4427-85d3-a381f949bf0e",
        "MerchantId": "63520c1f-2ccf-4606-a8fb-650ecc7b22d7",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-12-12T05:11:12.2605339+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "b71c5e36-428a-4a1d-b5ad-395615d86882",
        "FromConsumerId": "7184a619-4861-469d-97ab-0ffe5fca831e",
        "ToConsumerId": "dfee0bec-821a-4f35-a0ba-62972b56efb8",
        "OfferId": "2dc18d79-f545-49ed-8005-05c79b33781b",
        "Redeemed": true,
        "Timestamp": "2018-12-12T05:11:12.2605339+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-12-12T05:11:12.2605339+00:00",
        "MerchantLocationId": "b9251007-ab3b-4fa8-aede-3822a44261ae",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "8d55355c-c8d5-4711-bac8-52637db35503",
          "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": "b79a7560-f823-4bce-b8da-8b1be00eb86c",
    "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.