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": "c6958514-f9ae-4b1e-a14d-5202c916366f",
  "OfferId": "dabddd4a-2916-4fec-bed1-7612eb76d4a8",
  "MerchantLocationId": "7f63f73f-7301-4b43-9556-cf8f73a38b9f",
  "Deleted": true,
  "Offer": {
    "$id": "2",
    "Id": "4b0dcfa0-cfba-4e04-bff2-755a3205c0c7",
    "MerchantId": "8505246d-f264-4bfa-8cdc-3faa4b169688",
    "AppId": "059bd790-b411-4c46-8352-7916ce89abd3",
    "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-19T04:35:49.246805+00:00",
    "EndDate": "2018-09-19T04:35:49.246805+00:00",
    "ExpiryDate": "2018-09-19T04:35:49.246805+00:00",
    "Limited": true,
    "RedemptionLimit": 10,
    "Share": true,
    "Created": "2018-09-19T04:35:49.246805+00:00",
    "Deleted": true,
    "Published": true,
    "OfferImage": "sample string 14",
    "Pause": true,
    "Private": true,
    "Merchant": {
      "$id": "3",
      "Id": "0cf1e493-e316-4581-a1f2-ae3a5e824fa7",
      "PlanId": "7a72123c-ff2b-4783-877b-32894c6ea26f",
      "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-19T04:35:49.246805+00:00",
        "RegistrationCompleted": true,
        "LastLogin": "2018-09-19T04:35:49.246805+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": "3430a911-f91a-4e2b-976e-4b26cc1c89b0",
        "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": "31ff53b2-a291-42a1-9cec-d9bb38df91aa",
          "MerchantId": "3b88ce82-b8aa-46ee-9f52-6b410e65a23b",
          "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": "9f8a4d41-28e8-4e74-a139-88650bee777c",
      "MerchantId": "25e4bf3c-916f-4dae-84a5-961310fec8d9",
      "KeyId": "eeb115fa-8b50-47d8-8698-7b334ec3cdfa",
      "Name": "sample string 4",
      "Description": "sample string 5",
      "Created": "2018-09-19T04:35:49.246805+00:00",
      "Modified": "2018-09-19T04:35:49.246805+00:00",
      "Photo": "sample string 7",
      "Deleted": true,
      "Merchant": {
        "$ref": "3"
      },
      "Key": {
        "$id": "9",
        "Id": "6428d44d-d137-494b-934f-5dee03063f36",
        "MerchantId": "76e1d0bd-c829-4aa4-89b5-41b8c4e5dde6",
        "Name": "sample string 3",
        "SecretKey": "sample string 4",
        "Created": "2018-09-19T04:35:49.246805+00:00",
        "Deleted": true,
        "Assigned": true,
        "Merchant": {
          "$ref": "3"
        }
      }
    },
    "Shares": [
      {
        "$id": "10",
        "Id": "714f40ce-80a0-4b0a-b5c0-6a3d7de3118f",
        "FromConsumerId": "bdaea10a-06ea-4ef1-b5a2-9c6950d7c487",
        "ToConsumerId": "ec7468af-4159-49cb-9ebe-60011ed08183",
        "OfferId": "b63a898c-d29b-43b6-8d88-3780d8901a99",
        "Redeemed": true,
        "Timestamp": "2018-09-19T04:35:49.246805+00:00",
        "ReceiptImage": "sample string 4",
        "TotalAmount": "sample string 5",
        "RedeemedOn": "2018-09-19T04:35:49.246805+00:00",
        "MerchantLocationId": "24fcaaf9-fbcb-4424-9e0a-ba64e2ebd3f3",
        "UserName": "sample string 6",
        "Consumer": {
          "$id": "11",
          "Id": "888200cd-ae00-4590-a698-af7533cfbc4a",
          "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.