PUT api/OfferRewards

Update OfferReward

Request Information

URI Parameters

None.

Body Parameters

The OfferReward class

OfferReward
NameDescriptionTypeAdditional information
Id

GUID Id for OfferReward. Assigned by system on Create. [REQUIRED]

globally unique identifier

None.

OfferId

Guid OfferId for Offer. [REQUIRED]

globally unique identifier

None.

Reward

The amount of the OfferReward. Example: 10.00 for DollarOff, .10 for PercentageOff or BOGO for BOGO [NULL]

string

None.

RewardDescription

The descripton for the OfferReward. [NULL]

string

None.

Sharing

Indicates whether the sharing OfferReward is being used. [REQUIRED]

boolean

None.

SharingFrequency

Indicates the number of times before the sharing Reward is earned. [NULL]

string

None.

Redemption

Indicates whether the redemption OfferReward is being used. [REQUIRED]

boolean

None.

RedemptionFrequency

Indicates the numer of times before the redemption Reward is earned. [NULL]

string

None.

Offer

Gets the Offer using OfferId.

Offer

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "cb0743bf-72aa-412f-862b-de1436efb20d",
  "OfferId": "677ae8ce-f854-455b-a7a0-86ae7e415700",
  "Reward": "sample string 3",
  "RewardDescription": "sample string 4",
  "Sharing": true,
  "SharingFrequency": "sample string 6",
  "Redemption": true,
  "RedemptionFrequency": "sample string 8",
  "Offer": {
    "$id": "2",
    "Id": "4f7e7b9c-1999-47c9-9606-3492bd506b99",
    "MerchantId": "67ce7578-0fa0-4696-89c3-74587efaaecd",
    "AppId": "c083063a-9d3c-4480-8ddd-e89ff4847025",
    "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-19T00:24:58.6804801+00:00",
    "EndDate": "2018-09-19T00:24:58.6804801+00:00",
    "ExpiryDate": "2018-09-19T00:24:58.6804801+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-09-19T00:24:58.6804801+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "eee7eca8-8bf2-4bb6-87f1-3d4c32a0ae2f",
      "PlanId": "316759a6-6787-49e2-b61b-a7144853bf53",
      "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-19T00:24:58.6804801+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-09-19T00:24:58.6804801+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": "a7d91214-0f76-47b1-a865-b40ae1582f03",
        "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": "b494ff3a-5c55-4ecc-a689-98a118e196d8",
          "MerchantId": "4b6088e9-f245-4562-ad45-b45d3fde8f46",
          "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": "aad7765d-5492-40fb-9a49-3c061ddf4668",
      "MerchantId": "df77bc4b-c691-491c-97ec-93b1d5db0150",
      "KeyId": "48e6e56e-8c24-4012-a389-2b8d5a65cab2",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-09-19T00:24:58.699124+00:00",
      "Modified": "2018-09-19T00:24:58.699124+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "c4cb21ac-c007-42fa-98d2-9ce3f7b58719",
        "MerchantId": "c86877fa-4151-4bd0-9cc3-f3be2e56a4e4",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-09-19T00:24:58.699124+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "0704f0e4-5bfb-4403-a6d4-5c05236255ed",
        "FromConsumerId": "54881391-9f0f-47ce-a1d2-c47e4680dc2f",
        "ToConsumerId": "46e990aa-a205-4856-aa5b-d47b632e774b",
        "OfferId": "8156416a-33ca-4116-9531-805ac31a6063",
        "Redeemed": true,
        "Timestamp": "2018-09-19T00:24:58.699124+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-09-19T00:24:58.699124+00:00",
        "MerchantLocationId": "f8aff7b0-34e3-4136-a3e0-9a9e90eb5db8",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "366b3e6c-1afa-4475-9a07-63775aa61f00",
          "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"
      }
    ]
  }
}

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.MerchantConsumer, 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.MerchantConsumer, 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 'OfferReward'.

Response Information

Resource Description

Returns an OfferReward

OfferReward
NameDescriptionTypeAdditional information
Id

GUID Id for OfferReward. Assigned by system on Create. [REQUIRED]

globally unique identifier

None.

OfferId

Guid OfferId for Offer. [REQUIRED]

globally unique identifier

None.

Reward

The amount of the OfferReward. Example: 10.00 for DollarOff, .10 for PercentageOff or BOGO for BOGO [NULL]

string

None.

RewardDescription

The descripton for the OfferReward. [NULL]

string

None.

Sharing

Indicates whether the sharing OfferReward is being used. [REQUIRED]

boolean

None.

SharingFrequency

Indicates the number of times before the sharing Reward is earned. [NULL]

string

None.

Redemption

Indicates whether the redemption OfferReward is being used. [REQUIRED]

boolean

None.

RedemptionFrequency

Indicates the numer of times before the redemption Reward is earned. [NULL]

string

None.

Offer

Gets the Offer using OfferId.

Offer

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "a7dd3e30-42c9-4266-b9eb-0cd0ae0a39b1",
  "OfferId": "6a1c2e06-ce1c-484b-9d83-32c52d54abe7",
  "Reward": "sample string 3",
  "RewardDescription": "sample string 4",
  "Sharing": true,
  "SharingFrequency": "sample string 6",
  "Redemption": true,
  "RedemptionFrequency": "sample string 8",
  "Offer": {
    "$id": "2",
    "Id": "7af65423-3ebb-4411-9c27-b48961196779",
    "MerchantId": "8cc7dd67-6a67-4798-b7c9-b9c3deb26669",
    "AppId": "e3a2f31b-1096-457f-8181-4b15d106c7d2",
    "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-19T00:24:58.867984+00:00",
    "EndDate": "2018-09-19T00:24:58.867984+00:00",
    "ExpiryDate": "2018-09-19T00:24:58.867984+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-09-19T00:24:58.867984+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "6b9cf142-d83f-42e6-93c6-38e3be0f4943",
      "PlanId": "663efe7d-39e6-4062-8f0a-8de7993cc021",
      "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-19T00:24:58.867984+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-09-19T00:24:58.867984+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": "7e17deb2-1c2a-4220-97eb-382dfd0ab181",
        "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": "71778df0-aacc-4e29-adb7-b6be9810ecea",
          "MerchantId": "19b844ef-70b8-45bf-97e7-28a30dee46f9",
          "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": "db678acb-8556-45d2-a1b1-0d88b5b40755",
      "MerchantId": "fabc487c-4c4a-442a-aa07-27f8955a82f9",
      "KeyId": "1d0abd8f-2ca6-4eca-bfbb-9995523ac336",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-09-19T00:24:58.867984+00:00",
      "Modified": "2018-09-19T00:24:58.867984+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "2046df72-ede5-43a1-b9ad-e49db3417cf6",
        "MerchantId": "5fe27f02-df56-40bb-9668-6e31699bc5fb",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-09-19T00:24:58.867984+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "6cbdf29f-876c-4e73-ab37-919de8b87c5f",
        "FromConsumerId": "acacba02-ae2c-401a-9fc4-dab5f6d4bc12",
        "ToConsumerId": "8dbd5637-6345-41ab-8741-169884c71834",
        "OfferId": "190de7d1-5482-413c-9b45-e02b12491d1b",
        "Redeemed": true,
        "Timestamp": "2018-09-19T00:24:58.867984+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-09-19T00:24:58.867984+00:00",
        "MerchantLocationId": "96cfa29e-9450-41a6-b3da-95c70798dfc0",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "b059f5e7-4f5c-4ece-9173-e370c71276b0",
          "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"
      }
    ]
  }
}

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.MerchantConsumer, 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.MerchantConsumer, FaceOffers.Entities, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.