• Articles
  • Api Documentation
Show / Hide Table of Contents
  • Setting up the API Client
  • Using the API Client
    • Getting started
  • Customers
    • Adding a customer
  • Branch Users
    • Managing branch users
  • List data
    • Getting list data
  • Properties
    • Referring a property
    • Searching for properties
    • Getting property details
  • Property Images
    • Listing property images
    • Adding property images
    • Removing property images
  • Property Notes
    • Listing property notes
  • Viewings
    • Listing property viewings
    • Creating a viewing
    • Rescheduling a viewing
    • Cancelling a viewing
    • Adding viewing feedback

Getting list data

In order to correctly refer a property, you will need to get lists of several list properties, specifically:

  • Parking Types

and for residential properties:

  • Residential Property Types
  • Central Heating Types

and for commercial properties:

  • Commercial Property Types
  • Commercial Business Types

All of these lists are simple Id/Name pairs, and can be retrieved from the API client as IReadOnlyList<T> objects.

Parking Types

The Parking Type options can be accessed from the APIClient as follows:

var parkingTypes = await client.ParkingTypes.GetAllAsync();

Residential Property Types

The Residential Property Type options can be accessed from the APIClient as follows:

var residentialPropertyTypes = await client.ResidentialPropertyTypes.GetAllAsync();

Central Heating Types

The Central Heating Type options can be accessed from the APIClient as follows:

var centralHeatingTypes = await client.CentralHeatingTypes.GetAllAsync();

Commercial Property Types

The Commercial Property Type options can be accessed from the APIClient as follows:

var commercialPropertyTypes = await client.CommercialPropertyTypes.GetAllAsync();

Commercial Business Types

The Commercial Business Type options can be accessed from the APIClient as follows:

var commercialBusinessTypes = await client.CommercialBusinessTypes.GetAllAsync();
In This Article
Back to top Generated by DocFX