GET api/OfferRewards/ById/{id}

Get OfferReward by Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Id for the OfferReward

globally unique identifier

Required

Body Parameters

None.

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": "fe8a7ccb-bfc0-49bf-9207-a7218a1c643a",
  "OfferId": "b708d7b4-86c0-44b4-99fd-2f78c0a506ba",
  "Reward": "sample string 3",
  "RewardDescription": "sample string 4",
  "Sharing": true,
  "SharingFrequency": "sample string 6",
  "Redemption": true,
  "RedemptionFrequency": "sample string 8",
  "Offer": {
    "$id": "2",
    "Id": "a651df83-dee6-4042-96c4-aeaf732ed90e",
    "MerchantId": "34261965-801e-4cc0-8b5d-68c492e21a04",
    "AppId": "e35d3e3c-2e55-4411-830c-eb8497e11d3e",
    "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-20T18:43:05.8062989+00:00",
    "EndDate": "2018-09-20T18:43:05.8062989+00:00",
    "ExpiryDate": "2018-09-20T18:43:05.8062989+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-09-20T18:43:05.8062989+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "2a6fa3a3-4650-40e4-ac43-4e5b53ab47c6",
      "PlanId": "1b318dc1-66c4-43d9-a2eb-5eb0fd79ab3e",
      "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-20T18:43:05.8062989+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-09-20T18:43:05.8062989+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": "0d3f0233-357e-4f99-ad52-f298c2876ee1",
        "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": "20c25205-daba-4d35-b92e-0c1b44d40e66",
          "MerchantId": "a1945155-6930-4685-9c26-8e96b595b2bd",
          "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": "8ab5c958-8d29-4e36-80d1-0908d7508a65",
      "MerchantId": "5d94ae99-749c-41ba-a3b1-27e2291cbd5e",
      "KeyId": "a231bb6a-5908-4ad1-9a94-6eaf2a8ce521",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-09-20T18:43:05.8062989+00:00",
      "Modified": "2018-09-20T18:43:05.8062989+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "f544827b-33de-4a4a-b6f9-22d865fc0457",
        "MerchantId": "2d03c05e-0751-481f-9747-18a3c2c03300",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-09-20T18:43:05.8062989+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "04c5bb15-bba0-4d3c-85dc-ef57fce7c7c9",
        "FromConsumerId": "7f2f0d14-99e2-4820-b301-3dcfdfb2d422",
        "ToConsumerId": "a197dfc0-cb14-4f91-9497-5f8349632eeb",
        "OfferId": "fc90e711-30b3-4cf3-a77a-ee0318bc540f",
        "Redeemed": true,
        "Timestamp": "2018-09-20T18:43:05.8062989+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-09-20T18:43:05.8062989+00:00",
        "MerchantLocationId": "46bf8571-9fdc-4122-9c66-99c65e11ed4c",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "5fa95d50-aa4b-4150-bb6d-6d2dee796999",
          "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.