GET api/OfferLocations/ById/{id}

Get OfferLocation by Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Id for the OfferLocation

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns an OfferLocation

OfferLocation
NameDescriptionTypeAdditional information
Id

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

globally unique identifier

None.

OfferId

Guid OfferId for OfferLocation. [NULLABLE]

globally unique identifier

None.

MerchantLocationId

Guid MerchantLocationId for OfferLocation. [NULLABLE]

globally unique identifier

None.

Deleted

Indicates whether the OfferLocation has been deleted or not. Set to false on Create by system. Set to true on delete by system. [REQUIRED]

boolean

None.

Offer

Gets the Offer using OfferId.

Offer

None.

MerchantLocation

Gets the MerchantLocation using MerchantLocationId.

MerchantLocation

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "b21bb210-19a1-4183-aa68-1ac0996575b7",
  "OfferId": "303a434f-fa1f-46f0-9873-2489d74f9502",
  "MerchantLocationId": "bb59b1d9-5c4d-4027-a223-a95e990dd6d8",
  "Deleted": true,
  "Offer": {
    "$id": "2",
    "Id": "931d4141-7b17-44be-95ee-a4fdce01d585",
    "MerchantId": "f0d811a7-b5ee-4777-a841-43cc22b5ae38",
    "AppId": "7979d192-300b-4a6c-b818-4d1246a93fcf",
    "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-21T19:51:47.7548593+00:00",
    "EndDate": "2018-09-21T19:51:47.7548593+00:00",
    "ExpiryDate": "2018-09-21T19:51:47.7548593+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-09-21T19:51:47.7548593+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "16b14299-2c18-41c1-b718-510589874081",
      "PlanId": "d407011c-9c43-4bb3-8c6b-adc8ea7a0759",
      "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-21T19:51:47.7548593+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-09-21T19:51:47.7548593+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": "9fe7b3f0-a7dd-4e27-9e7e-33a0bd663e08",
        "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": "5b31aafb-a36e-48ef-8c7d-1e937774e730",
          "MerchantId": "8831e0a0-cd06-4868-99fd-4295870f9024",
          "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": "feb659c4-9fd1-4f7c-a9c8-85942b60a2de",
      "MerchantId": "4bd32a0d-d035-4d84-b3b2-8b0b2d879607",
      "KeyId": "18fb8bda-9a5d-466e-a560-99b8ed28f89f",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-09-21T19:51:47.7548593+00:00",
      "Modified": "2018-09-21T19:51:47.7548593+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "d237e802-14bf-4d9c-9134-d8485e38b8d4",
        "MerchantId": "5d47a42b-b382-4f4b-bbd6-42fa63e9d5c9",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-09-21T19:51:47.7548593+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "0bef2ab1-bc00-47e6-bac6-2a6853c2bd73",
        "FromConsumerId": "79c2feea-2439-471e-bd8b-a62bd1af71e4",
        "ToConsumerId": "b3f8cd24-485a-4e55-b87a-004271a5fc06",
        "OfferId": "23b9f8b5-e5d9-4915-9541-40e272548bf3",
        "Redeemed": true,
        "Timestamp": "2018-09-21T19:51:47.7548593+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-09-21T19:51:47.7548593+00:00",
        "MerchantLocationId": "57c41001-f61c-44f5-ad23-d9db396a1503",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "fa3df566-e447-46fb-bbb2-19f01dc40c22",
          "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"
      }
    ]
  },
  "MerchantLocation": {
    "$ref": "7"
  }
}

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 'FaceOffers.Entities.Consumer' 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 'FaceOffers.Entities.Consumer' contains cycles and cannot be serialized if reference tracking is disabled.