GET api/RentalProperties?field={field}&search={search}&exact={exact}

This returns properties where the specified field contains the specified search text or equals the search text if exact = true.

Request Information

Parameters

Name	Description	Additional information
field	The Name of the field to search against	Define this parameter in the request URI.
search	The text to search for	Define this parameter in the request URI.
exact	Set to true if match must be exact	Define this parameter in the request URI.

Response Information

filtered list of rental properties

Response body formats

text/html

Sample:

<div class="input-group">
    <label class="sr-only">Filter</label>
    <span class="input-group-addon">Filter</span>
    <input id="filter" type="text" class="form-control" placeholder="Filter..." />
</div>
<table class="hdc-table table default" data-filter="#filter">
    <thead>
        <tr>
            <th data-toggle="true" class="footable-first-column">
                Reference
            </th>
            <th>
                Property Area
            </th>
            <th>
                Property Type
            </th>
            <th>
                Rent Asked
            </th>
            <th data-hide="phone,tablet">
                Description
            </th>
            <th data-hide="phone,tablet">
                Telephone
            </th>
            <th data-hide="phone,tablet">
                Landlord Email Address
            </th>
            <th data-hide="phone,tablet">
                Status
            </th>
        </tr>
    </thead>
    <tbody>
            <tr>
                <td>
                    sample string 2
                </td>
                <td>
                    sample string 3
                </td>
                <td>
                    sample string 4
                </td>
                <td>
                    sample string 5
                </td>
                <td>
                    sample string 6
                </td>
                <td>
                    sample string 7
                </td>
                <td>
                    <a href="mailto:sample string 8">sample string 8</a>
                </td>
                <td>
                    sample string 13
                </td>
            </tr>
            <tr>
                <td>
                    sample string 2
                </td>
                <td>
                    sample string 3
                </td>
                <td>
                    sample string 4
                </td>
                <td>
                    sample string 5
                </td>
                <td>
                    sample string 6
                </td>
                <td>
                    sample string 7
                </td>
                <td>
                    <a href="mailto:sample string 8">sample string 8</a>
                </td>
                <td>
                    sample string 13
                </td>
            </tr>
            <tr>
                <td>
                    sample string 2
                </td>
                <td>
                    sample string 3
                </td>
                <td>
                    sample string 4
                </td>
                <td>
                    sample string 5
                </td>
                <td>
                    sample string 6
                </td>
                <td>
                    sample string 7
                </td>
                <td>
                    <a href="mailto:sample string 8">sample string 8</a>
                </td>
                <td>
                    sample string 13
                </td>
            </tr>
    </tbody>
    <tfoot class="hide-if-no-paging">
        <tr>
            <td colspan="6">
                <ul class="pagination pagination-centered hide-if-no-paging"></ul>
            </td>
        </tr>
    </tfoot>
</table>

application/json, text/json

Sample:

[
  {
    "id": 1,
    "reference": "sample string 2",
    "property_Area": "sample string 3",
    "property_Type": "sample string 4",
    "rent_Asked": "sample string 5",
    "description": "sample string 6",
    "telephone": "sample string 7",
    "email_address": "sample string 8",
    "address_of_Property": "sample string 9",
    "landlords_Address": "sample string 10",
    "let_Date": "2025-11-03T08:31:33.9618113+00:00",
    "name_of_Landlord": "sample string 11",
    "name_of_Tennant": "sample string 12",
    "status": "sample string 13",
    "uprn": 1.1,
    "via_Housing_Needs_": "sample string 14"
  },
  {
    "id": 1,
    "reference": "sample string 2",
    "property_Area": "sample string 3",
    "property_Type": "sample string 4",
    "rent_Asked": "sample string 5",
    "description": "sample string 6",
    "telephone": "sample string 7",
    "email_address": "sample string 8",
    "address_of_Property": "sample string 9",
    "landlords_Address": "sample string 10",
    "let_Date": "2025-11-03T08:31:33.9618113+00:00",
    "name_of_Landlord": "sample string 11",
    "name_of_Tennant": "sample string 12",
    "status": "sample string 13",
    "uprn": 1.1,
    "via_Housing_Needs_": "sample string 14"
  },
  {
    "id": 1,
    "reference": "sample string 2",
    "property_Area": "sample string 3",
    "property_Type": "sample string 4",
    "rent_Asked": "sample string 5",
    "description": "sample string 6",
    "telephone": "sample string 7",
    "email_address": "sample string 8",
    "address_of_Property": "sample string 9",
    "landlords_Address": "sample string 10",
    "let_Date": "2025-11-03T08:31:33.9618113+00:00",
    "name_of_Landlord": "sample string 11",
    "name_of_Tennant": "sample string 12",
    "status": "sample string 13",
    "uprn": 1.1,
    "via_Housing_Needs_": "sample string 14"
  }
]

application/xml, text/xml

Sample:

<ArrayOfRental_Property xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HDCAPIModel.Models">
  <Rental_Property>
    <Address_of_Property>sample string 9</Address_of_Property>
    <Description>sample string 6</Description>
    <ID>1</ID>
    <Landlords_Address>sample string 10</Landlords_Address>
    <Let_Date>2025-11-03T08:31:33.9618113+00:00</Let_Date>
    <Name_of_Landlord>sample string 11</Name_of_Landlord>
    <Name_of_Tennant>sample string 12</Name_of_Tennant>
    <Property_Area>sample string 3</Property_Area>
    <Property_Type>sample string 4</Property_Type>
    <Reference>sample string 2</Reference>
    <Rent_Asked>sample string 5</Rent_Asked>
    <Telephone>sample string 7</Telephone>
    <UPRN>1.1</UPRN>
    <Via_Housing_Needs_>sample string 14</Via_Housing_Needs_>
    <email_address>sample string 8</email_address>
    <status>sample string 13</status>
  </Rental_Property>
  <Rental_Property>
    <Address_of_Property>sample string 9</Address_of_Property>
    <Description>sample string 6</Description>
    <ID>1</ID>
    <Landlords_Address>sample string 10</Landlords_Address>
    <Let_Date>2025-11-03T08:31:33.9618113+00:00</Let_Date>
    <Name_of_Landlord>sample string 11</Name_of_Landlord>
    <Name_of_Tennant>sample string 12</Name_of_Tennant>
    <Property_Area>sample string 3</Property_Area>
    <Property_Type>sample string 4</Property_Type>
    <Reference>sample string 2</Reference>
    <Rent_Asked>sample string 5</Rent_Asked>
    <Telephone>sample string 7</Telephone>
    <UPRN>1.1</UPRN>
    <Via_Housing_Needs_>sample string 14</Via_Housing_Needs_>
    <email_address>sample string 8</email_address>
    <status>sample string 13</status>
  </Rental_Property>
  <Rental_Property>
    <Address_of_Property>sample string 9</Address_of_Property>
    <Description>sample string 6</Description>
    <ID>1</ID>
    <Landlords_Address>sample string 10</Landlords_Address>
    <Let_Date>2025-11-03T08:31:33.9618113+00:00</Let_Date>
    <Name_of_Landlord>sample string 11</Name_of_Landlord>
    <Name_of_Tennant>sample string 12</Name_of_Tennant>
    <Property_Area>sample string 3</Property_Area>
    <Property_Type>sample string 4</Property_Type>
    <Reference>sample string 2</Reference>
    <Rent_Asked>sample string 5</Rent_Asked>
    <Telephone>sample string 7</Telephone>
    <UPRN>1.1</UPRN>
    <Via_Housing_Needs_>sample string 14</Via_Housing_Needs_>
    <email_address>sample string 8</email_address>
    <status>sample string 13</status>
  </Rental_Property>
</ArrayOfRental_Property>

text/javascript

Sample:

([{"id":1,"reference":"sample string 2","property_Area":"sample string 3","property_Type":"sample string 4","rent_Asked":"sample string 5","description":"sample string 6","telephone":"sample string 7","email_address":"sample string 8","address_of_Property":"sample string 9","landlords_Address":"sample string 10","let_Date":"2025-11-03T08:31:33.9618113+00:00","name_of_Landlord":"sample string 11","name_of_Tennant":"sample string 12","status":"sample string 13","uprn":1.1,"via_Housing_Needs_":"sample string 14"},{"id":1,"reference":"sample string 2","property_Area":"sample string 3","property_Type":"sample string 4","rent_Asked":"sample string 5","description":"sample string 6","telephone":"sample string 7","email_address":"sample string 8","address_of_Property":"sample string 9","landlords_Address":"sample string 10","let_Date":"2025-11-03T08:31:33.9618113+00:00","name_of_Landlord":"sample string 11","name_of_Tennant":"sample string 12","status":"sample string 13","uprn":1.1,"via_Housing_Needs_":"sample string 14"},{"id":1,"reference":"sample string 2","property_Area":"sample string 3","property_Type":"sample string 4","rent_Asked":"sample string 5","description":"sample string 6","telephone":"sample string 7","email_address":"sample string 8","address_of_Property":"sample string 9","landlords_Address":"sample string 10","let_Date":"2025-11-03T08:31:33.9618113+00:00","name_of_Landlord":"sample string 11","name_of_Tennant":"sample string 12","status":"sample string 13","uprn":1.1,"via_Housing_Needs_":"sample string 14"}]);