GET api/OfferLocations/ByOfferId/{offerId}

Get OfferLocations by OfferId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
offerId

Id for the Offer

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Returns a list of OfferLocations

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": "da9c6a5e-b353-487b-8f75-76a5decc8b01",
  "OfferId": "dbe3de4d-6e5b-4538-969d-7cbb39043a94",
  "MerchantLocationId": "e7f28798-ebcd-4565-9bcb-c99c22b669c4",
  "Deleted": true,
  "Offer": {
    "$id": "2",
    "Id": "0fd78435-07a8-466c-91d7-ccc0ecceea84",
    "MerchantId": "18566a74-f12d-435e-836c-56c43d18a0fa",
    "AppId": "ffa3e20c-c432-49b1-9612-3a27c0e951a7",
    "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": "2019-03-21T00:25:03.9639595+00:00",
    "EndDate": "2019-03-21T00:25:03.9639595+00:00",
    "ExpiryDate": "2019-03-21T00:25:03.9639595+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2019-03-21T00:25:03.9639595+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "a27551d0-c469-4486-bd4d-b3e8ee05204a",
      "PlanId": "d5d1f15e-f7ae-4c2c-b83f-1f1f8e1a0d76",
      "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": "2019-03-21T00:25:03.9639595+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2019-03-21T00:25:03.9639595+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": "e1354ab2-7802-4e77-a0db-fce1f0d361f3",
        "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": "e3650998-17d5-4ffd-be96-7f9df18bb7f5",
          "MerchantId": "0d7f301c-e1c3-4973-bd2f-2489fa1e0e18",
          "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": "325247cc-3bc9-41e0-b7a7-c955abb40588",
      "MerchantId": "7a6110bc-2106-4ac0-8ba5-caf76b0a0653",
      "KeyId": "f6d22e6c-be2a-4252-842a-b3c5cb5e5bc4",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2019-03-21T00:25:03.9639595+00:00",
      "Modified": "2019-03-21T00:25:03.9639595+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "20950d66-a122-46e5-b700-6c2b712042f4",
        "MerchantId": "a24fd63e-0062-409d-a87a-dc089f584441",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2019-03-21T00:25:03.9639595+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "0d6fcaa5-36b5-49a7-b052-24b04835a25b",
        "FromConsumerId": "4d392387-25da-45fe-906a-829d4c250ea1",
        "ToConsumerId": "8b935de1-353d-4dea-901d-d51d56454de5",
        "OfferId": "2cb55d4d-1540-42e1-b113-46579bb45338",
        "Redeemed": true,
        "Timestamp": "2019-03-21T00:25:03.9639595+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2019-03-21T00:25:03.9639595+00:00",
        "MerchantLocationId": "ea8f3082-f4da-490e-92df-cccaed1e063b",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "0561613f-83bd-460d-a5a0-64f46a86f8d0",
          "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.