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": "3f737f29-2b5a-4ba6-a530-3b586fbba2ae",
  "OfferId": "d6ff90f9-aa1f-4ab3-b0f7-8890726bc293",
  "ConsumerId": "79e8dd7a-4879-4d90-ba5e-28f21589ea99",
  "BarcodeId": "8764dd86-ad63-4d12-bfd2-c7de6130b50c",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2019-03-21T01:38:42.998674+00:00",
  "Offer": {
    "$id": "2",
    "Id": "65896819-032d-4fb9-9b17-3df094b99efd",
    "MerchantId": "79c62220-ae71-4364-b2f6-254331e712bf",
    "AppId": "ffdcdf18-089c-4686-95c2-d71f927abeb1",
    "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": "2019-03-21T01:38:42.998674+00:00",
    "EndDate": "2019-03-21T01:38:42.998674+00:00",
    "ExpiryDate": "2019-03-21T01:38:42.998674+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2019-03-21T01:38:42.998674+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "7341a53b-c1a0-4846-a008-003157e2e9de",
      "PlanId": "d0b58ad0-3d50-49c2-8e29-e544c07a4810",
      "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": "2019-03-21T01:38:42.998674+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2019-03-21T01:38:42.998674+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": "bf1c22f1-567e-4183-a4e0-f5ce0e0f9c5f",
        "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": "536f6d0b-66ac-4c14-9d5d-ba4250008709",
          "MerchantId": "719f4254-e8a7-4db2-9652-cf44e0c40f78",
          "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": "9b5abc51-a419-45e3-93da-ed32f55e09c2",
      "MerchantId": "1028503c-e249-404f-b592-35fa504fff12",
      "KeyId": "5e902fd0-ba13-4b26-9a81-734257520b82",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2019-03-21T01:38:42.998674+00:00",
      "Modified": "2019-03-21T01:38:42.998674+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "829c84a8-84d8-4884-a820-81d10a39b1fd",
        "MerchantId": "1351ff81-b52d-4fff-ac82-1463fde2ae6c",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2019-03-21T01:38:42.998674+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "3f3e688d-aa06-4f86-9668-27daa4e1749b",
        "FromConsumerId": "135f5446-fb81-458d-abb3-65adaecc9430",
        "ToConsumerId": "94046ba5-f20b-4d6d-b7ed-18723c2fb92f",
        "OfferId": "ecdbfd0f-d331-4537-902d-8a9788bbe78b",
        "Redeemed": true,
        "Timestamp": "2019-03-21T01:38:42.998674+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2019-03-21T01:38:42.998674+00:00",
        "MerchantLocationId": "0213b675-fa21-4673-ac3e-2356ff196529",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "b9d79737-4ba8-4f50-864a-bfa691e4af86",
          "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": "0dca37e6-4776-45e7-8fd7-9cd18a01b26d",
    "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": "d43be700-5c12-4a71-81c7-836b15ee4978",
  "OfferId": "6f2d7747-168f-45e5-a908-0de54cf88ec1",
  "ConsumerId": "9514764f-7344-441c-97bc-db9fbf3999ca",
  "BarcodeId": "66183ce0-b4e6-4b7d-a85a-7ecb3ffeb643",
  "Discount": "sample string 2",
  "ShareDiscount": "sample string 3",
  "RedeemDiscount": "sample string 4",
  "Timestamp": "2019-03-21T01:38:43.1393154+00:00",
  "Offer": {
    "$id": "2",
    "Id": "6bd03ed8-f8bb-4264-99cd-b675c50b08e0",
    "MerchantId": "4260accf-b4ae-4db5-be61-eddc92b1e8db",
    "AppId": "db8c8e6f-85b2-4189-a88e-fe5823127993",
    "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": "2019-03-21T01:38:43.1393154+00:00",
    "EndDate": "2019-03-21T01:38:43.1393154+00:00",
    "ExpiryDate": "2019-03-21T01:38:43.1393154+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2019-03-21T01:38:43.1393154+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "a44eb758-be38-4a5b-b761-a541cae7398b",
      "PlanId": "5ca70481-4588-4972-90e5-1a09955b5aa4",
      "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": "2019-03-21T01:38:43.1393154+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2019-03-21T01:38:43.1393154+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": "2e923fb9-c1d1-4d31-b605-6f381bcd7db7",
        "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": "7a19f96b-2cbc-4d62-a179-03f8211fd15d",
          "MerchantId": "2c60df29-3f9b-44cf-bbf2-23ddb2ab5567",
          "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": "5e29c59a-f4b6-48de-9c31-7d283647bd0d",
      "MerchantId": "70433106-f336-4ff3-b63a-a9ae081b6120",
      "KeyId": "e767b9f6-210b-44b7-9a08-4da894a6240b",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2019-03-21T01:38:43.1393154+00:00",
      "Modified": "2019-03-21T01:38:43.1393154+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "c6613389-60d8-4507-aab6-be73a24ddd4a",
        "MerchantId": "b2b15399-920b-4610-8d10-603244422d77",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2019-03-21T01:38:43.1393154+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "953b7b96-1c37-43ce-9009-d64399eb228d",
        "FromConsumerId": "1f7ad7e9-3d59-4630-8dfe-3c224d7f248e",
        "ToConsumerId": "1fef9f60-b2f6-439f-bc87-5e67f188b6ab",
        "OfferId": "7a536972-1c27-4ccf-80a7-5fd92975cc34",
        "Redeemed": true,
        "Timestamp": "2019-03-21T01:38:43.1393154+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2019-03-21T01:38:43.1393154+00:00",
        "MerchantLocationId": "ef70bbe5-6953-46ce-951b-7b0909aa0fbb",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "a1a956a7-14e9-49a6-976c-afb1cc67ca3d",
          "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": "3ba4a25e-1ddd-44bf-b5db-fe9e2469def7",
    "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.