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": "d5212a80-80a5-4f48-b243-e0e621001e8a",
  "OfferId": "b8b80c9f-f1f1-44d4-a2ea-1074323ba05e",
  "Reward": "sample string 3",
  "RewardDescription": "sample string 4",
  "Sharing": true,
  "SharingFrequency": "sample string 6",
  "Redemption": true,
  "RedemptionFrequency": "sample string 8",
  "Offer": {
    "$id": "2",
    "Id": "cece21b9-dcf5-4a17-ada2-e637eb181c0e",
    "MerchantId": "c2db20f3-8e5b-4ab5-aa53-0474039e8749",
    "AppId": "1edba02d-f455-40b9-83d9-3ba3ccc617a3",
    "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-12T05:11:06.3390169+00:00",
    "EndDate": "2018-12-12T05:11:06.3390169+00:00",
    "ExpiryDate": "2018-12-12T05:11:06.3390169+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-12-12T05:11:06.3390169+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "9a87cdd0-f1b6-483d-b2d0-49e89623843a",
      "PlanId": "50e49d27-bbe6-437c-ad63-b23940e64d3a",
      "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-12T05:11:06.3390169+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-12-12T05:11:06.3390169+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": "481ec0a3-9b4c-459a-8d99-f50bb60e5a11",
        "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": "85d70d4a-7bf9-498d-b93f-f3715c63339d",
          "MerchantId": "4f666327-4561-4a96-8a8b-3dc23ba6be08",
          "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": "79e21aba-4e77-489a-8b54-d26fd9385cfb",
      "MerchantId": "691d2900-eab3-43e6-87ee-c65ecef88928",
      "KeyId": "6d18ecf1-fc88-4a46-9b8c-ea6ae34f710f",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-12-12T05:11:06.3390169+00:00",
      "Modified": "2018-12-12T05:11:06.3390169+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "ff184de1-b240-429f-b33f-47b3a3a511cc",
        "MerchantId": "f0429cd2-d445-4cda-8df9-a208c96bbced",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-12-12T05:11:06.3390169+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "81ae530e-7ff6-465e-b9bc-a74256e8c007",
        "FromConsumerId": "f245f200-5d97-4ac9-9d9f-000714e68d69",
        "ToConsumerId": "0c8be76e-a965-4ceb-aa3a-86b6c747fed4",
        "OfferId": "489fbd4f-1aba-4d51-ac3d-9d7da74a54b9",
        "Redeemed": true,
        "Timestamp": "2018-12-12T05:11:06.3390169+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-12-12T05:11:06.3390169+00:00",
        "MerchantLocationId": "9f70b575-b1c9-49ed-9bb6-a589f359ec00",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "4cc6d74a-7006-4918-9ae8-a690b9a4001e",
          "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": "e9a4d470-665a-463c-be2f-b4c6b27c65e5",
  "OfferId": "9a6d4732-7edc-4ed5-b9b5-793c10260f5b",
  "Reward": "sample string 3",
  "RewardDescription": "sample string 4",
  "Sharing": true,
  "SharingFrequency": "sample string 6",
  "Redemption": true,
  "RedemptionFrequency": "sample string 8",
  "Offer": {
    "$id": "2",
    "Id": "d47cb8d0-8518-43cb-882c-9af187de8918",
    "MerchantId": "922067aa-4292-4bb6-a348-9f4680d93542",
    "AppId": "413a0139-531a-4e9d-a2da-de491be5e02a",
    "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-12T05:11:06.4952783+00:00",
    "EndDate": "2018-12-12T05:11:06.4952783+00:00",
    "ExpiryDate": "2018-12-12T05:11:06.4952783+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-12-12T05:11:06.4952783+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "e6cf70e2-3e9e-4906-9047-a2a247b0986d",
      "PlanId": "caaf78d8-556f-4c2c-9946-2565e2e6cfd7",
      "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-12T05:11:06.4952783+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-12-12T05:11:06.4952783+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": "6b4fdae4-dfc5-486e-ae2e-cb1121fe9adf",
        "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": "ef1bb63d-78ec-48ed-a83f-08698eabc05f",
          "MerchantId": "60430c73-a5cc-4907-a5e7-039bd8d16f4c",
          "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": "f5b4d2eb-669a-4290-88c6-63f2dadbc416",
      "MerchantId": "74536c5d-3a78-4654-957e-8419a595d992",
      "KeyId": "4adbb03a-c899-4b30-9105-86851e15b995",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-12-12T05:11:06.4952783+00:00",
      "Modified": "2018-12-12T05:11:06.4952783+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "8f1a2606-17ca-44a2-a917-e97d852d77a5",
        "MerchantId": "bf79636d-03fd-4ba7-a826-698d40d41d14",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-12-12T05:11:06.4952783+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "47d978bf-0626-4ab8-8144-60797a39de47",
        "FromConsumerId": "7da8a237-aab4-4e04-884f-6a4f042354da",
        "ToConsumerId": "272ac60f-407d-498e-b604-c4047f0cee0d",
        "OfferId": "4c03b97b-beeb-4086-8d3c-2d76bb4db43f",
        "Redeemed": true,
        "Timestamp": "2018-12-12T05:11:06.4952783+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-12-12T05:11:06.4952783+00:00",
        "MerchantLocationId": "a492cdde-003d-4d62-8472-c622aed91caa",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "a20efd52-6dc6-460b-ab6f-4480c6087e99",
          "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.