GET api/UniqueOffers/ByOfferId/{offerId}

Get UniqueOffers by OfferId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
offerId

Id for the Offer

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns a list of UniqueOffers

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": "2e1cdda3-45be-4d0a-a23d-8108d1e76e22",
  "OfferId": "76d8e02c-a577-41a4-bdb7-009e3feba47b",
  "ConsumerId": "ca2cf034-e7f9-44eb-971b-6da2788e51dc",
  "BarcodeId": "c0255c78-ed46-4e76-b28f-c888b40a9dd8",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2018-12-12T06:09:43.6016403+00:00",
  "Offer": {
    "$id": "2",
    "Id": "50ee9b2e-6c10-42df-9478-e9fb1f501de5",
    "MerchantId": "f4417e53-b562-4944-8bea-20323ae9b9b4",
    "AppId": "ed163152-7cdd-47cd-b373-367cd032c43b",
    "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-12T06:09:43.6016403+00:00",
    "EndDate": "2018-12-12T06:09:43.6016403+00:00",
    "ExpiryDate": "2018-12-12T06:09:43.6016403+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-12-12T06:09:43.6016403+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "fc3e7d03-013b-4b17-ac6e-e48ac5d1ecfd",
      "PlanId": "163535cd-4a63-4131-a556-1dfcffe2fd0e",
      "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-12T06:09:43.6016403+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-12-12T06:09:43.6016403+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": "9741ce68-0f98-4dbf-b6e2-6d96bdc10b49",
        "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": "037f0e39-d7c7-40b9-ae3f-926bad4e32c9",
          "MerchantId": "e3edd7c7-24dd-4b62-aefc-c50b331487b0",
          "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": "e55993de-616b-4d72-b37f-9efbdb181156",
      "MerchantId": "416f09f2-d405-4875-a064-f96bd0d87dca",
      "KeyId": "840ec111-c673-403f-99e9-6a747f063a18",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-12-12T06:09:43.6016403+00:00",
      "Modified": "2018-12-12T06:09:43.6016403+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "f5d28ec1-7427-4fb3-8b71-c013fe13fc9e",
        "MerchantId": "d92967bc-9eb2-49fd-986b-9aa0310b2371",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-12-12T06:09:43.6016403+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "4d607968-3eb7-4dd3-a817-bdb9e618f0b4",
        "FromConsumerId": "59494466-62b5-4792-864d-8f2e137c8414",
        "ToConsumerId": "66275b38-faa2-4022-8984-7b44c4396c70",
        "OfferId": "b7bd91e3-dfcc-4d94-b6f9-87a891783f07",
        "Redeemed": true,
        "Timestamp": "2018-12-12T06:09:43.6016403+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-12-12T06:09:43.6016403+00:00",
        "MerchantLocationId": "420d97d6-cd59-4132-b4da-9415fbc7e8b9",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "fc07faf2-79a6-4c8f-9580-4cc790499aa3",
          "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": "8548ba45-8412-46f1-8207-8cf4c072e61c",
    "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.