Latest revision as of 11:00, 11 October 2013

[edit] GET /accounts/{accountId}/flexcloud/zone

Returns all available zones for the specified account.

[edit] Request

GET /accounts/{accountId}/flexcloud/zone

[edit] Request Parameters

accountId - string

The selected account Id.

[edit] Response

[edit] Status Code

200 OK

Success

401 Unauthorized

Failure - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

403 Forbidden

Failure - The resource is forbidden for this user

404 itemNotFound

Failure - When trying to get the zones with invalid account number

[edit] Response Body

{
  "account_number":[
    {
      "zone": "zone_id",
      "location": "zone_location"
    },
    {
      "zone": "zone_id",
      "location": "zone_location"
    }
  ]
}

[edit] Parameters

account_number - string

Account for which the zones are available. There can be several accounts per response.

zone - string

Zone Id.

location - string

Location of the zone.

[edit] Examples

[edit] Successfully get the zones

Request

GET /accounts/smith1234/flexcloud/zone
Authorization: Basic {Base64-encoded username:password string}

Response

200 OK

{
  "smith1234":[
    {
      "zone": "USOTE-2012-TAMPA",
      "location": "ote.2012.tampa"
    }
  ]
}

[edit] Failure while trying to make an unauthorized request

Request

GET /accounts/smith1234/flexcloud/zone
Authorization: Basic {invalid authorization}

Response

401 Unauthorized

[edit] Permission denied failure

Request

GET /accounts/smith1234/flexcloud/zone
Authorization: Basic {Base64-encoded username:password string}

Response

403 Forbidden

{
  "forbidden": {
    "message": "forbidden", 
    "code": 403, 
    "details": "",
    "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
  }
}

[edit] Account Number not found

Request

GET /accounts/fake/flexcloud/zone
Authorization: Basic {Base64-encoded username:password string}

Response

{
    "itemNotFound": {
        "guid": "23684df5-0532-4794-802d-fdc82e4e7e7c",
        "message": "Resource not found",
        "code": 404,
        "details": ""
    }
}

[edit] Alternative URI /zones

An alternative way to execute this call is to omit the accountId portion of the URI. In this case the system assumes the request is executed for the account identified in the authorization header.

GET /zones

[edit] See also

• FlexCloud Server API
• Common Features