RoomTemplates: GetRoomTemplates

This method returns a list of room templates that the user can use to create a new room. The response includes company and region-level templates.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}/room_templates

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The id of the account.

Optional Query Parameters
officeIdinteger

(Optional) The ID of the office for which the user wants to create a room. When you pass in a value for this parameter, only room templates that are valid for that office appear in the results. For users who are not Admins, the default is the id of the user's default office. However, you can specify a value if the user belongs to multiple offices.

If the user is an Admin, set the forAdmin search parameter to true instead and omit the officeId parameter.

onlyAssignableboolean

(Optional) When set to true, returns only the roles that the current user can assign to someone else. The default value is false.

countinteger

(Optional) The number of results to return. This value must be a number between 1 and 100 (default).

startPositioninteger

(Optional) The index position within the total result set from which to start returning values. The default value is 0.

Responses

CodeDescriptionReference
200

Successfully retrieved room templates for the caller

RoomTemplatesSummaryList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

RoomTemplates::GetRoomTemplates

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.

RoomTemplate

Contains details about a room template.

roomTemplateIdinteger

The id of the room template.

namestring

The name of the office.

taskTemplateCountinteger

The total number of task templates that the room template uses.

RoomTemplatesSummaryList

This complex type contains information about room templates.

roomTemplates[RoomTemplate]

An array of roomTemplate objects.

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.

}} />