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": "ccb90728-9e2d-48d6-b9f5-270ae1ffafba",
  "OfferId": "242d3ba2-3f22-45a4-b5af-bcc6a6060bbe",
  "MerchantLocationId": "9094671c-557f-469e-a378-3fd6c7a6f322",
  "Deleted": true,
  "Offer": {
    "$id": "2",
    "Id": "2dd6f6fb-42c8-4ce9-93f5-8983efde64f1",
    "MerchantId": "bb8f3dba-bd12-4c3c-9f61-042514d2293b",
    "AppId": "1e054877-1061-4cc6-8479-9b525b682aeb",
    "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:09:56.0648461+00:00",
    "EndDate": "2018-12-12T05:09:56.0648461+00:00",
    "ExpiryDate": "2018-12-12T05:09:56.0648461+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-12-12T05:09:56.0648461+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "ab566794-0d4a-48fb-8f8f-069082dcd362",
      "PlanId": "864b1fd1-1f73-4d58-ac6f-46e517c4b5f6",
      "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:09:56.0648461+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-12-12T05:09:56.0648461+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": "dfee35cf-c534-4806-86ce-3e9a73501f37",
        "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": "b5cfe829-08f8-417c-b666-be1c279448a9",
          "MerchantId": "c008b379-05dc-4239-b880-26e343577bf0",
          "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": "bce20d4e-6b27-46a0-b29d-9f274ec20535",
      "MerchantId": "2eecc069-cfc7-4e92-affc-2a8ecd226a4a",
      "KeyId": "4cc642af-1277-4690-b862-646731c31ba6",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-12-12T05:09:56.0648461+00:00",
      "Modified": "2018-12-12T05:09:56.0648461+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "e91056ba-ea2e-4a5b-8d19-5f01a52b3a23",
        "MerchantId": "63cae651-af63-44f0-8fe5-1147c848e301",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-12-12T05:09:56.0648461+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "1d09a37e-e12a-43c1-8e45-44c2650921d2",
        "FromConsumerId": "1d421c1b-b756-4e8e-b875-428f6cef53e6",
        "ToConsumerId": "b1fc0a74-595c-48ff-8af6-d44ce6fc3cba",
        "OfferId": "ae0661f1-4ec8-434f-abfa-18823d2ad141",
        "Redeemed": true,
        "Timestamp": "2018-12-12T05:09:56.0648461+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-12-12T05:09:56.0648461+00:00",
        "MerchantLocationId": "44760cb4-ec5d-4074-9c8a-98d9f4b49886",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "2b766e3a-a944-4ae7-8788-bb656e74f5a7",
          "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.