GET api/LocationsNearBy?categoryID={categoryID}

Retrieves Near By Locations based on the provided category.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
categoryID

The ID of the category to filter the Locations.

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of Near by Locations matching the provided category ID.

Collection of NearByLocation
NameDescriptionTypeAdditional information
LocationID

Gets or sets the Location ID.

integer

None.

CategoryID

Gets or sets the category ID.

integer

None.

LocationName

Gets or sets the Location name.

string

None.

ImageURL

Gets or sets the item image URL.

string

None.

Address

Gets or sets the address.

string

None.

Latitude

Gets or sets the latitude.

string

None.

Longitude

Gets or sets the longitude.

string

None.

Description

Gets or sets the description.

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "LocationID": 1,
    "CategoryID": 2,
    "LocationName": "sample string 3",
    "ImageURL": "sample string 4",
    "Address": "sample string 5",
    "Latitude": "sample string 6",
    "Longitude": "sample string 7",
    "Description": "sample string 8"
  },
  {
    "LocationID": 1,
    "CategoryID": 2,
    "LocationName": "sample string 3",
    "ImageURL": "sample string 4",
    "Address": "sample string 5",
    "Latitude": "sample string 6",
    "Longitude": "sample string 7",
    "Description": "sample string 8"
  }
]

application/xml, text/xml

Sample:
<ArrayOfNearByLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OTJServices.Models">
  <NearByLocation>
    <Address>sample string 5</Address>
    <CategoryID>2</CategoryID>
    <Description>sample string 8</Description>
    <ImageURL>sample string 4</ImageURL>
    <Latitude>sample string 6</Latitude>
    <LocationID>1</LocationID>
    <LocationName>sample string 3</LocationName>
    <Longitude>sample string 7</Longitude>
  </NearByLocation>
  <NearByLocation>
    <Address>sample string 5</Address>
    <CategoryID>2</CategoryID>
    <Description>sample string 8</Description>
    <ImageURL>sample string 4</ImageURL>
    <Latitude>sample string 6</Latitude>
    <LocationID>1</LocationID>
    <LocationName>sample string 3</LocationName>
    <Longitude>sample string 7</Longitude>
  </NearByLocation>
</ArrayOfNearByLocation>