SpecialCircumstanceTypes: GetSpecialCircumstanceTypes

Returns a list of special circumstance types, such as Short Sale and Foreclosure. These are the values that you can select for the Special circumstances field that appears on the Room Details page.

Permissions

Anyone with a valid access token can call this method.

Request

HTTP request

GET /v2/special_circumstance_types

Parameters

Parameter NameValueDescription

Responses

CodeDescriptionReference
200

Request was successful.

GlobalSpecialCircumstanceTypes
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

GlobalResources::GetSpecialCircumstanceTypes

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

GlobalSpecialCircumstanceTypes

Contains a list of special circumstance types.

specialCircumstanceTypes[SpecialCircumstanceType]

A list of special circumstance types.

SpecialCircumstanceType

Contains information about a special circumstance type.

specialCircumstanceTypeIdstring

The id of the special circumstance type.

Example: ss (for Short Sale)

namestring

The name of the special circumstance type. Possible values are:

  • Short Sale
  • Foreclosure
  • Corporate Owned
  • Historical
  • Investor Owned
  • HUD
  • Estate Sale
  • Relocation
  • Contingency

}} />