> Software > Developer Tools > REST API > REST API Reference > Regions Operations

REST API - GET Region Details

This operation retrieves the details of a specific region.

Request

Syntax

Send the request using either XML or JSON.

GET webservice/Regions/regionId
Host: host name
Accept: application/xml
Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

regionId

The ID of the region for which you want to retrieve details.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or the Command Center used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

regionType

The type of region.

regions

regionId

The ID assigned to a region.

regionEntity

displayName

The display name assigned to a region.

regionEntity

regionName

The actual name of the region.

regionEntity

numOfPlans

The number of plans the region is associated with.

regionPLans

numOfClients

The number of clients the region is associated with.

regionClients

continent

The continent of the region.

zone

country

The country of the region.

zone

city

The city associated withthe region, if any.

zone

latitude

The latitude associated with the region.

zone

state

The state associated withthe region, if any.

zone

longitude

The longitude associated with the region.

zone

zoneId

The ID of the zone that is associated with the region.

zoneEntity

zoneName

The name of the zone that is associated with the region.

zoneEntity

Examples

Sample Request

GET webservice/Regions/59
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<Api_RegionResp>
  <regions regionType="2">
    <regionEntity regionId="59" displayName="Canada (Central) (ca-central-1)" regionName="ca-central-1" />
    <regionPlans numOfPlans="0" />
    <regionClients numOfClients="0" />
    <zones>
      <zone continent="North America" country="Canada" city="" latitude="56.1304" state="" longitude="-106.347">
      <zoneEntity zoneId="33" zoneName="Canada" />
      </zone>
    </zones>
  </regions>
</Api_RegionResp>]
×

Loading...