PUT api/SharedOffers

Update SharedOffer

Request Information

URI Parameters

None.

Body Parameters

The SharedOffer class

SharedOffer
NameDescriptionTypeAdditional information
Id

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

globally unique identifier

None.

FromConsumerId

The ConsumerId for the sharing Consumer. [NULLABLE]

globally unique identifier

None.

ToConsumerId

The ConsumerId for the Consumer being shared with. [NULLABLE]

globally unique identifier

None.

OfferId

The OfferId for the offer being shared. [REQUIRED]

globally unique identifier

None.

Redeemed

Indicates whether the SharedOffer has been redemeed. [NULLABLE]

boolean

None.

Timestamp

Indicates when the SharedOffer was created. [NULL]

date

None.

ReceiptImage

Image of the receipt or proof of the transaction. [NULL]

string

None.

TotalAmount

The total amount of the transaction. [NULL]

string

String length: inclusive between 0 and 50

RedeemedOn

The DateTime when the SharedOffer was redeemed. Assigned by system on redeem. [NULL]

date

None.

MerchantLocationId

The MerchantLocation where the SharedOffer was redeemed. Used by redemption process. [NULL]

globally unique identifier

None.

UserName

The user who redeemed the SharedOffer. Used by redemption process. [NULL]

string

String length: inclusive between 0 and 256

Consumer

Gets the sharing Consumer using ConsumerId.

Consumer

None.

Consumer1

Gets the Consumer being shared with using ConsumerId.

Consumer

None.

Offer

Gets the Offer being shared using OfferId.

Offer

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "57b63720-ae74-462b-bbb4-75a993917b96",
  "FromConsumerId": "9afc4c16-7089-417f-bd68-447dc0887d17",
  "ToConsumerId": "7482184a-7a48-4519-9ffc-abe59d707e8d",
  "OfferId": "1c8dd2ff-747b-46f5-8fd4-7785bdf1882f",
  "Redeemed": true,
  "Timestamp": "2018-09-18T11:42:47.8275602+00:00",
  "ReceiptImage": "sample string 4",
  "TotalAmount": "sample string 5",
  "RedeemedOn": "2018-09-18T11:42:47.8275602+00:00",
  "MerchantLocationId": "d91c0060-774c-497c-bb89-06f46c331dde",
  "UserName": "sample string 6",
  "Consumer": {
    "$id": "2",
    "Id": "d7e3d6bd-03c4-4c0e-ac4c-295ee98464c6",
    "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": "2"
  },
  "Offer": {
    "$id": "3",
    "Id": "7656cdbe-1c61-4654-8296-b032788ce777",
    "MerchantId": "794f5f65-131a-4aa9-8488-de0897257ef8",
    "AppId": "ad1b0743-3dc4-4ef3-ab8a-71d1dce63c69",
    "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-18T11:42:47.8275602+00:00",
    "EndDate": "2018-09-18T11:42:47.8275602+00:00",
    "ExpiryDate": "2018-09-18T11:42:47.8275602+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-09-18T11:42:47.8275602+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "4",
      "Id": "1d979107-99c2-470a-a9f0-ffe08a5afd11",
      "PlanId": "8fb9dd42-eba9-4f19-820d-0b81581938be",
      "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": "5",
        "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-18T11:42:47.8275602+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-09-18T11:42:47.8275602+00:00",
        "TermsConditions": true,
        "MobileNumber": "sample string 21",
        "ProfileImage": "sample string 22",
        "FullName": "sample string 12, sample string 11",
        "Roles": [
          {
            "$id": "6",
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Users": [
              {
                "$ref": "5"
              },
              {
                "$ref": "5"
              }
            ]
          },
          {
            "$ref": "6"
          }
        ]
      },
      "Plan": {
        "$id": "7",
        "Id": "b448e945-d2c6-4698-ac93-913a285aa1dd",
        "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": "8",
          "Id": "13518b6f-bc28-44a0-b894-92bdf63cf81a",
          "MerchantId": "96f5edd0-9e83-41f9-b53e-796125b80c6b",
          "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": "4"
          },
          "CompleteAddress": "sample string 5, sample string 6, sample string 7, sample string 8, sample string 9"
        },
        {
          "$ref": "8"
        }
      ]
    },
    "App": {
      "$id": "9",
      "Id": "196f7f2b-4258-4067-bff0-284bd8b43d0e",
      "MerchantId": "fd9acee5-6505-41c5-be7c-115f1b6b4255",
      "KeyId": "a34ea3cc-510b-43a4-b00d-8a078aa4e6d9",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-09-18T11:42:47.8275602+00:00",
      "Modified": "2018-09-18T11:42:47.8275602+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "4"
      },
      "Key": {
        "$id": "10",
        "Id": "0f1feb3a-518c-4b10-bf26-ae5556125b15",
        "MerchantId": "8e3d7d0b-44fa-4cb7-acce-3b001c82de16",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-09-18T11:42:47.8275602+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "4"
        }
      }
    },
    "Shares": [
      {
        "$ref": "1"
      },
      {
        "$ref": "1"
      }
    ]
  }
}

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 'SharedOffer'.

Response Information

Resource Description

Returns a SharedOffer

SharedOffer
NameDescriptionTypeAdditional information
Id

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

globally unique identifier

None.

FromConsumerId

The ConsumerId for the sharing Consumer. [NULLABLE]

globally unique identifier

None.

ToConsumerId

The ConsumerId for the Consumer being shared with. [NULLABLE]

globally unique identifier

None.

OfferId

The OfferId for the offer being shared. [REQUIRED]

globally unique identifier

None.

Redeemed

Indicates whether the SharedOffer has been redemeed. [NULLABLE]

boolean

None.

Timestamp

Indicates when the SharedOffer was created. [NULL]

date

None.

ReceiptImage

Image of the receipt or proof of the transaction. [NULL]

string

None.

TotalAmount

The total amount of the transaction. [NULL]

string

String length: inclusive between 0 and 50

RedeemedOn

The DateTime when the SharedOffer was redeemed. Assigned by system on redeem. [NULL]

date

None.

MerchantLocationId

The MerchantLocation where the SharedOffer was redeemed. Used by redemption process. [NULL]

globally unique identifier

None.

UserName

The user who redeemed the SharedOffer. Used by redemption process. [NULL]

string

String length: inclusive between 0 and 256

Consumer

Gets the sharing Consumer using ConsumerId.

Consumer

None.

Consumer1

Gets the Consumer being shared with using ConsumerId.

Consumer

None.

Offer

Gets the Offer being shared using OfferId.

Offer

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "b7293114-1337-4400-a43c-8032c93a7cd7",
  "FromConsumerId": "2a72ac2e-1560-4b53-a7f6-a22159eaac73",
  "ToConsumerId": "7d2c6353-e567-4f47-a19a-7c890ce82c91",
  "OfferId": "3bad048c-f2de-4b66-ba0f-b868a3103b28",
  "Redeemed": true,
  "Timestamp": "2018-09-18T11:42:47.9525594+00:00",
  "ReceiptImage": "sample string 4",
  "TotalAmount": "sample string 5",
  "RedeemedOn": "2018-09-18T11:42:47.9525594+00:00",
  "MerchantLocationId": "ae9a7f2a-4b59-4308-aa7f-e159c7b949b5",
  "UserName": "sample string 6",
  "Consumer": {
    "$id": "2",
    "Id": "dbcc1c17-9007-4046-8cf1-530af72aa95f",
    "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": "2"
  },
  "Offer": {
    "$id": "3",
    "Id": "b1f1f957-e785-4c74-8ee4-2f3abd026667",
    "MerchantId": "60ae98be-3ada-4fe3-abc4-73fa535fa6d2",
    "AppId": "47c37709-b1fd-466a-bd7b-33f75539de47",
    "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-18T11:42:47.9525594+00:00",
    "EndDate": "2018-09-18T11:42:47.9525594+00:00",
    "ExpiryDate": "2018-09-18T11:42:47.9525594+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-09-18T11:42:47.9525594+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "4",
      "Id": "07bae49f-a0ea-4331-8469-ca98b0a36a36",
      "PlanId": "c210763e-5e6a-46b5-a72b-92ac10ee7e42",
      "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": "5",
        "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-18T11:42:47.9525594+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-09-18T11:42:47.9525594+00:00",
        "TermsConditions": true,
        "MobileNumber": "sample string 21",
        "ProfileImage": "sample string 22",
        "FullName": "sample string 12, sample string 11",
        "Roles": [
          {
            "$id": "6",
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Users": [
              {
                "$ref": "5"
              },
              {
                "$ref": "5"
              }
            ]
          },
          {
            "$ref": "6"
          }
        ]
      },
      "Plan": {
        "$id": "7",
        "Id": "00b77881-0915-439a-82d9-b39982853015",
        "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": "8",
          "Id": "a8d1a1c5-430a-43e2-8e87-b62e890d33a6",
          "MerchantId": "dc13f3d5-072f-427f-8062-f8e96872513e",
          "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": "4"
          },
          "CompleteAddress": "sample string 5, sample string 6, sample string 7, sample string 8, sample string 9"
        },
        {
          "$ref": "8"
        }
      ]
    },
    "App": {
      "$id": "9",
      "Id": "5a878a5c-3cc1-4bd7-8cef-e5e221c85fd2",
      "MerchantId": "6bccdf06-d28f-49a9-9720-cdcef407cc36",
      "KeyId": "e1c46c71-9096-46cd-895f-38529066b1f8",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-09-18T11:42:47.9525594+00:00",
      "Modified": "2018-09-18T11:42:47.9525594+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "4"
      },
      "Key": {
        "$id": "10",
        "Id": "10f7317f-5b96-4044-a37d-fb8b01491a94",
        "MerchantId": "c8f6c922-b65b-40ec-9834-1be409acfeed",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-09-18T11:42:47.9525594+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "4"
        }
      }
    },
    "Shares": [
      {
        "$ref": "1"
      },
      {
        "$ref": "1"
      }
    ]
  }
}

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.