PUT api/UniqueOffers

Update UniqueOffer

Request Information

URI Parameters

None.

Body Parameters

The UniqueOffer class

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.

Request Formats

application/json, text/json

Sample:
{
  "Id": "ec51c3b8-49bd-421c-92c0-d5eacaae0c92",
  "OfferId": "56859eba-2009-43b3-9d2e-d2487bc0b1f4",
  "ConsumerId": "6fa58376-6b22-4820-9611-74f65dcb2b3e",
  "BarcodeId": "b4e25f5c-8529-450d-b5dd-f28ce8b84d96",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2018-09-18T13:37:05.7774832+00:00",
  "Offer": {
    "$id": "2",
    "Id": "29c48c7a-13a7-4d8e-b29f-ef8c9dc9395b",
    "MerchantId": "6e8de87a-cc15-4ea1-afc6-f0856d26ae9a",
    "AppId": "92177d75-4a14-4768-80f7-630d96b89793",
    "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-18T13:37:05.7774832+00:00",
    "EndDate": "2018-09-18T13:37:05.7774832+00:00",
    "ExpiryDate": "2018-09-18T13:37:05.7774832+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-09-18T13:37:05.7774832+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "88f449f0-968e-457c-b8cb-f6433854b29a",
      "PlanId": "8fc1f08d-86b9-4f9f-a676-549c2768bf81",
      "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-18T13:37:05.7774832+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-09-18T13:37:05.7774832+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": "352f81be-c7af-40c8-ac91-cea6804a1190",
        "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": "0ce30d72-8b4d-46e4-81e5-70e5db757454",
          "MerchantId": "c379bb80-9348-4b81-970d-cf1023521476",
          "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": "cbf0b13b-6f88-4e39-af9b-f79c26c58009",
      "MerchantId": "102200f7-7214-4693-89b3-e3317a768d16",
      "KeyId": "8a65429c-9f4f-43ff-8b25-bc03db64294e",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-09-18T13:37:05.7774832+00:00",
      "Modified": "2018-09-18T13:37:05.7774832+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "6dca81af-ed04-498b-9d46-d24a7d8942ef",
        "MerchantId": "8c37b390-68cd-4866-aa45-c28dc8a1040f",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-09-18T13:37:05.7774832+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "63fca3cb-c008-4b18-98fb-30e6bde67e7d",
        "FromConsumerId": "0d237692-2866-46d0-aa95-126e695c5845",
        "ToConsumerId": "d28a870f-061d-46a4-b8ca-c5be4b6f55fe",
        "OfferId": "dea91743-59c6-4e7d-9f22-b1ea5a3bd024",
        "Redeemed": true,
        "Timestamp": "2018-09-18T13:37:05.7774832+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-09-18T13:37:05.7774832+00:00",
        "MerchantLocationId": "62deaefd-581e-4036-9219-53951086e1f3",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "b675ecbe-1558-4a51-8a68-5a40a23ed4a0",
          "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": "fa1150bd-39ee-405d-8d63-46bb0ab8bf4f",
    "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.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UniqueOffer'.

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": "441a3d73-0de3-440d-81bd-59363bf48af2",
  "OfferId": "f48d2bff-f876-43b1-a92b-ed38d4b524c3",
  "ConsumerId": "f3a6cf46-ceff-4e36-b698-6d0fe8cc9b97",
  "BarcodeId": "d22d922e-4216-4e58-bba4-94403781c15d",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2018-09-18T13:37:05.886277+00:00",
  "Offer": {
    "$id": "2",
    "Id": "3fe36398-3add-410f-a3bb-06310ee613e7",
    "MerchantId": "c4df5a4e-58b5-4e6a-b93a-3518f1ac505e",
    "AppId": "efb1ca0d-7e91-4888-be3a-fcfbe19c73c1",
    "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-18T13:37:05.886277+00:00",
    "EndDate": "2018-09-18T13:37:05.886277+00:00",
    "ExpiryDate": "2018-09-18T13:37:05.886277+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-09-18T13:37:05.886277+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "991e8415-b307-4261-82ec-a1303720620b",
      "PlanId": "e9b87e8d-88ed-421b-ad30-0b890f50ddcd",
      "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-18T13:37:05.886277+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-09-18T13:37:05.886277+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": "efd273ca-f433-424f-8cfe-18600fe67e46",
        "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": "38cef51b-523e-418a-a499-056ba95da946",
          "MerchantId": "8d151494-39f7-4a80-a795-587ab5473360",
          "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": "575615b0-d225-41b9-a593-43d453d01e1d",
      "MerchantId": "1f3e6a43-326a-4721-810a-bf2c9c711758",
      "KeyId": "12184295-08bd-4ec2-a500-597e7476650e",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-09-18T13:37:05.886277+00:00",
      "Modified": "2018-09-18T13:37:05.886277+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "9dec2cd7-5629-4b36-8ff1-985d8f344206",
        "MerchantId": "5f01f405-5d2e-4366-a5db-b75e8a49d79c",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-09-18T13:37:05.886277+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "2d0887e4-6d87-444f-97f8-eeaca2064eac",
        "FromConsumerId": "bc067009-433e-4bb0-b9ac-7d6e0bab040c",
        "ToConsumerId": "4ba66407-aa42-4fed-9eb5-225d96eda0e5",
        "OfferId": "f18f6d67-e880-480f-9e10-fb0d2a05cc24",
        "Redeemed": true,
        "Timestamp": "2018-09-18T13:37:05.886277+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-09-18T13:37:05.886277+00:00",
        "MerchantLocationId": "42f4fde1-7ea5-46b5-b3fb-053acb66ff0c",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "a5da8cc7-7209-4870-a22d-efc778a928a5",
          "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": "311f906f-c437-4bdd-8c72-c4a8bcda2efe",
    "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.