RoomFolders: GetRoomFolders

Gets a list of room folders in the specified room that are accessible to the current user.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/room_folders

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

The id of the room.

accountIdstring

The globally unique identifier (GUID) for the account.

Optional Query Parameters
startPositioninteger

The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is 0.

countinteger

The number of results. When this property is used as a request parameter specifying the number of results to return, the value must be a number between 1 and 100 (default).

Responses

CodeDescriptionReference
200

Room folders successfully retrieved.

RoomFolderList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Rooms::GetRoomFolders

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.

RoomFolder

Information about a room folder.

roomFolderIdinteger

The ID of the folder.

namestring

The name of the folder.

isDefaultboolean

When true, this is the default folder.

RoomFolderList

A list of room folder results.

folders[RoomFolder]

An array of room folders.

resultSetSizeinteger

The number of results returned in this response.

startPositioninteger

The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is 0.

endPositioninteger

The last zero-based index position in the result set.

nextUristring

The URI for the next chunk of records based on the search request. This property is null for the last set of search results.

priorUristring

The URI for the previous chunk of records based on the search request. This property is null for the first set of search results.

}} />