Regions: GetRegions

This method returns a list of regions that are associated with a Rooms account.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The globally unique identifier (GUID) for the account.

Optional Query Parameters
countinteger

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

startPositioninteger

(Optional) The starting zero-based index position of the results set from which to begin returning values. The default value is 0.

managedOnlyboolean

(Optional) When set to true, only the regions that the current user manages are returned. The default value is false.

Responses

CodeDescriptionReference
200

Regions successfully retrieved.

RegionSummaryList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Regions::GetRegions

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.

RegionSummary

A complex element containing summary information on a region; the elements of this object are identical to those of the Regions object.

regionIdinteger

The id of the region. This is the id that the system generated when you created the region.

namestring

String that specifies the region name.

createdDatestring

UTC datetime that the region was created (for example "2019-06-27T19:32:46.943"). Note that the service assigns this value, so it is read-only.

RegionSummaryList

Object that contains a summary of information about a requested group of regions in the Rooms account.

regionSummaries[RegionSummary]

A list of RegionSummary objects containing summary information on a region; the elements of this object are identical to those of the Regions object.

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.

}} />