ClosingStatuses: GetClosingStatuses

Returns a list of closing statuses, or valid reasons for closing a room.

You do not specify an accountId or any other parameters with this method.

Permissions

Any user with a valid access token can use this method.

Request

HTTP request

GET /restapi/v2/closing_statuses

Parameters

Parameter NameValueDescription

Responses

CodeDescriptionReference
200

Request was successful.

GlobalClosingStatuses
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

GlobalResources::GetClosingStatuses

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.

ClosingStatus

Contains information about a closing status, or reason for closing a room.

closingStatusIdstring

The id of the closing status.

Example: exp

namestring

The name of the closing status.

Example: Listing Expired

GlobalClosingStatuses

Contains a list of valid closing statuses, or reasons for closing a room.

closingStatuses[ClosingStatus]

A list of closing statuses (reasons for closing a room).

}} />