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": "84589e88-96da-4616-a83f-4f61f265a50c",
  "OfferId": "1af2fe94-a765-485f-ae39-e7f0bf4c0f2b",
  "ConsumerId": "54c6a2cc-39c2-47a4-9e8a-108c1790c0b3",
  "BarcodeId": "26792039-ce3e-49c9-90bc-6538d0cacfa4",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2018-06-14T17:36:34.5336877+00:00",
  "Offer": {
    "$id": "2",
    "Id": "30b2d2c6-d095-4429-9caf-0f678a9f704c",
    "MerchantId": "aaa81cbe-6121-41d5-b69c-6f08a7818dad",
    "AppId": "9174627b-8eb1-488b-aff6-6bc0c7e7ff87",
    "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-14T17:36:34.5336877+00:00",
    "EndDate": "2018-06-14T17:36:34.5336877+00:00",
    "ExpiryDate": "2018-06-14T17:36:34.5336877+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-06-14T17:36:34.5336877+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "16692d17-ffda-46a8-a9c4-1e135a987bb5",
      "PlanId": "fd8230fd-affe-4a94-9491-78692257024b",
      "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-14T17:36:34.5336877+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-06-14T17:36:34.5336877+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": "c79982e3-b1c2-4de7-b19a-541bf94bb3c5",
        "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": "941d44f7-3f6e-461c-9b47-abb1f1f9ed6d",
          "MerchantId": "19ea3ba7-3dfb-4674-ae6a-3a067cdbfe18",
          "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": "81146314-b684-4ed6-8a05-b91d9128b0cf",
      "MerchantId": "20681728-5b4d-44f1-a27a-cbbda7b9ac5c",
      "KeyId": "a7c2fd38-1041-4ad5-b48e-301f8c278947",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-06-14T17:36:34.5336877+00:00",
      "Modified": "2018-06-14T17:36:34.5336877+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "5742587f-380d-4824-a874-3adac6252dbe",
        "MerchantId": "308e7654-1e36-4c9a-9168-8c71a70411b8",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-06-14T17:36:34.5336877+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "c5386577-9e85-4cc5-98ac-872c41594c40",
        "FromConsumerId": "96b88982-9aaa-4189-a0de-6f4a11e55990",
        "ToConsumerId": "2e5d04d1-442b-47bf-8608-34486064e792",
        "OfferId": "53beced5-b0bb-4a89-bfd8-a6752a911a69",
        "Redeemed": true,
        "Timestamp": "2018-06-14T17:36:34.5336877+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-06-14T17:36:34.5336877+00:00",
        "MerchantLocationId": "4b298c03-f4f3-4fb2-9c40-4302dcd1a149",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "391daf98-2129-4ba3-b468-75127088b01f",
          "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": "2c21d335-eef8-4cbb-b0ea-f696088cb3e2",
    "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": "8b991b56-8272-42eb-9090-f4fa6542ca01",
  "OfferId": "888dba83-195e-40cb-8404-cc28107bf668",
  "ConsumerId": "944afb59-b5f8-49ac-969b-31da4c43b0c5",
  "BarcodeId": "6794a06e-2713-4247-8b80-9d1aa1d5ff45",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2018-06-14T17:36:34.7055617+00:00",
  "Offer": {
    "$id": "2",
    "Id": "90ab43a8-4d5c-4f03-8783-0316b33517ea",
    "MerchantId": "25e4f626-2d5f-44a2-99a9-685bfa83affe",
    "AppId": "fcbc766e-8fbd-4341-b750-cdfddd18c57f",
    "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-14T17:36:34.7055617+00:00",
    "EndDate": "2018-06-14T17:36:34.7055617+00:00",
    "ExpiryDate": "2018-06-14T17:36:34.7055617+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-06-14T17:36:34.7055617+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "77978604-a5c6-44fa-bd23-9c6c03fd6f50",
      "PlanId": "d67ba49c-ba90-4184-b24c-37f850eea111",
      "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-14T17:36:34.7055617+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-06-14T17:36:34.7055617+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": "755334fb-8834-430f-9afa-9c3f9b625ac5",
        "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": "f3609dee-5401-4a12-8c83-fde5f273ee9c",
          "MerchantId": "cb1f3536-d560-493d-8512-ab5386257ea6",
          "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": "fc27ab19-7241-4193-a2eb-f74e9be18cd3",
      "MerchantId": "47c7ea65-cc30-4316-bcdd-ffabda2b3969",
      "KeyId": "9c337e4f-8d15-48f8-9856-0a64a7305665",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-06-14T17:36:34.7055617+00:00",
      "Modified": "2018-06-14T17:36:34.7055617+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "36562c5c-2378-4507-983f-1df0d080a481",
        "MerchantId": "613c2fe8-90b7-431f-9c1f-17105b8ffa4b",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-06-14T17:36:34.7055617+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "ac098204-9960-42ff-8ce9-b15d9d2743cf",
        "FromConsumerId": "83c8938b-3587-4d54-ab52-5b3cae91a2ac",
        "ToConsumerId": "799807b8-9a0f-4264-b5ee-83b93be596d5",
        "OfferId": "4e31b0bb-8d37-4933-9dbb-d9f3810cd505",
        "Redeemed": true,
        "Timestamp": "2018-06-14T17:36:34.7055617+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-06-14T17:36:34.7055617+00:00",
        "MerchantLocationId": "f0b78999-97fa-4cd8-9eac-517e5f82fd4d",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "007afdfd-878a-43b2-aa11-f6578b534777",
          "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": "9a49e211-2008-4c26-b5ef-ec1a778c8abc",
    "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.