GET api/RealEstate?categoryID={categoryID}

Retrieves Real Estates based on the provided category Name.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
categoryID

The ID of the category to filter the Real Estate.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of Real Estate matching the provided category ID.

Collection of RealEstate
NameDescriptionTypeAdditional information
Id

Gets or sets the ID of the real estate object.

 integer

None.
Address

Gets or sets the address of the real estate object.

 string

None.
Longitude

Gets or sets the longitude of the real estate object.

 decimal number

None.
Latitude

Gets or sets the latitude of the real estate object.

 decimal number

None.
City

Gets or sets the city of the real estate object.

 string

None.
State

Gets or sets the state of the real estate object.

 string

None.
ZipCode

Gets or sets the zip code of the real estate object.

 string

None.
Price

Gets or sets the price of the real estate object.

 decimal number

None.
PublishedDate

Gets or sets the published date of the real estate object.

 string

None.
Distance

Gets or sets the distance of the real estate object.

 decimal number

None.
DaysOld

Gets or sets the age of the real estate object in days.

 decimal number

None.
Correlation

Gets or sets the correlation value of the real estate object.

 decimal number

None.
County

Gets or sets the county of the real estate object.

 string

None.
Bedrooms

Gets or sets the number of bedrooms in the real estate object.

 integer

None.
Bathrooms

Gets or sets the number of bathrooms in the real estate object.

 integer

None.
PropertyType

Gets or sets the type of the real estate property.

 string

None.
SquareFootage

Gets or sets the square footage of the real estate object.

 integer

None.
YearBuilt

Gets or sets the year the real estate object was built.

 integer

None.
HouseImage

Gets or sets the URL of the house image for the real estate object.

 string

None.
starRatings

The star review rating of the item, It's an array where each rating captured separately.

 Collection of integer

None.
CategoryID

Gets or sets the category of the real estate object.

 integer

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "Address": "sample string 2",
    "Longitude": 3.1,
    "Latitude": 4.1,
    "City": "sample string 5",
    "State": "sample string 6",
    "ZipCode": "sample string 7",
    "Price": 8.0,
    "PublishedDate": "sample string 9",
    "Distance": 10.1,
    "DaysOld": 11.1,
    "Correlation": 12.1,
    "County": "sample string 13",
    "Bedrooms": 14,
    "Bathrooms": 15,
    "PropertyType": "sample string 16",
    "SquareFootage": 17,
    "YearBuilt": 18,
    "HouseImage": "sample string 19",
    "starRatings": [
      1,
      2
    ],
    "CategoryID": 20
  },
  {
    "Id": 1,
    "Address": "sample string 2",
    "Longitude": 3.1,
    "Latitude": 4.1,
    "City": "sample string 5",
    "State": "sample string 6",
    "ZipCode": "sample string 7",
    "Price": 8.0,
    "PublishedDate": "sample string 9",
    "Distance": 10.1,
    "DaysOld": 11.1,
    "Correlation": 12.1,
    "County": "sample string 13",
    "Bedrooms": 14,
    "Bathrooms": 15,
    "PropertyType": "sample string 16",
    "SquareFootage": 17,
    "YearBuilt": 18,
    "HouseImage": "sample string 19",
    "starRatings": [
      1,
      2
    ],
    "CategoryID": 20
  }
]

application/xml, text/xml

Sample: 
<ArrayOfRealEstate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OTJServices.Models">
  <RealEstate>
    <Address>sample string 2</Address>
    <Bathrooms>15</Bathrooms>
    <Bedrooms>14</Bedrooms>
    <CategoryID>20</CategoryID>
    <City>sample string 5</City>
    <Correlation>12.1</Correlation>
    <County>sample string 13</County>
    <DaysOld>11.1</DaysOld>
    <Distance>10.1</Distance>
    <HouseImage>sample string 19</HouseImage>
    <Id>1</Id>
    <Latitude>4.1</Latitude>
    <Longitude>3.1</Longitude>
    <Price>8</Price>
    <PropertyType>sample string 16</PropertyType>
    <PublishedDate>sample string 9</PublishedDate>
    <SquareFootage>17</SquareFootage>
    <State>sample string 6</State>
    <YearBuilt>18</YearBuilt>
    <ZipCode>sample string 7</ZipCode>
    <starRatings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </starRatings>
  </RealEstate>
  <RealEstate>
    <Address>sample string 2</Address>
    <Bathrooms>15</Bathrooms>
    <Bedrooms>14</Bedrooms>
    <CategoryID>20</CategoryID>
    <City>sample string 5</City>
    <Correlation>12.1</Correlation>
    <County>sample string 13</County>
    <DaysOld>11.1</DaysOld>
    <Distance>10.1</Distance>
    <HouseImage>sample string 19</HouseImage>
    <Id>1</Id>
    <Latitude>4.1</Latitude>
    <Longitude>3.1</Longitude>
    <Price>8</Price>
    <PropertyType>sample string 16</PropertyType>
    <PublishedDate>sample string 9</PublishedDate>
    <SquareFootage>17</SquareFootage>
    <State>sample string 6</State>
    <YearBuilt>18</YearBuilt>
    <ZipCode>sample string 7</ZipCode>
    <starRatings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </starRatings>
  </RealEstate>
</ArrayOfRealEstate>