Zone - Revision history

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:54Z

1 revision: Release 86

Emanuela.mitreva at 13:25, 11 July 2013

2013-07-11T13:25:18Z

Administrator: /* GET /zones */

2013-06-27T00:54:43Z

GET /zones

Mike.robski: 1 revision

2013-05-24T19:46:53Z

1 revision

Mike.robski at 19:45, 24 May 2013

2013-05-24T19:45:18Z

Show changes

Mike.robski: 1 revision

2013-05-24T15:24:58Z

1 revision

Mike.robski at 13:09, 20 May 2013

2013-05-20T13:09:43Z

New page

This operation will return all zones per account

'''GET''' /zones

== Result ==
=== JSON ===
<nowiki>
{
"account_number":[
{
"zone": "zone_textkey",
"location": "location_zone"
},
{
"zone": "zone_textkey2",
"location": "location_zone2"
}
]
}
</nowiki>
; account_number - ''string''
: Account number for which are the zones. There can be several accounts per user.

; zone - ''string''
: Zone textkey

; location - ''string''
: Location of the zone

== Response Codes ==
; Success:
:''HTTP/1.1 200 OK''

; Failure:
:''HTTP/1.1 401 Unauthorized'' - 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.
:''HTTP/1.1 403 Forbidden'' - The resource is forbidden for this user

== Examples ==
'''Successfully get the zones'''
:'''GET''' <nowiki>http://{api_server}/zones</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 200 OK</pre>

''Response Body:''
<nowiki>
{
"smith1234":[
{
"zone": "USOTE-2012-TAMPA",
"location": "ote.2012.tampa"
}
]
}
</nowiki>

'''Failure while trying to make an unauthorized request'''
:'''GET''' <nowiki>http://{api_server}/zones</nowiki>

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded <span style="color:red">fake_authentication_string</span>

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
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.

'''Permission denied failure'''
:'''GET''' http(s)://{api_server}/zones

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Response Code:''
<pre>HTTP/1.1 403 Forbidden</pre>

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

[[Category:Hostway API]]
[[Category:FlexCloud Server API]]

@@ Line 1: / Line 1: @@
-= GET /zones =
+= GET /accounts/''{accountId}''/flexcloud/zone =
-This operation will return all available zones for the authorized user.
+Returns all available zones for the specified account.
 __TOC__
 == Request ==
-<code>GET /zones</code>
+<code>GET /accounts/''{accountId}''/flexcloud/zone</code>
 == Response ==
@@ Line 16: / Line 20: @@
 ; 403 Forbidden
 : Failure - The resource is forbidden for this user
 === Response Body ===
@@ Line 30: / Line 37: @@
+     }
+   ]
 }</nowiki>
 </nowiki>
 ==== Parameters ====
@@ Line 48: / Line 54: @@
 '''Request'''
   <nowiki>
-GET /zones
+GET /accounts/smith1234/flexcloud/zone
-Authorization: Basic {Base64-encoded username:password string}
+Authorization: Basic {Base64-encoded username:password string}</nowiki>
- </nowiki>
 '''Response'''
@@ Line 63: / Line 68: @@
+     }
+   ]
 }</nowiki>
 </nowiki>
 === Failure while trying to make an unauthorized request ===
 '''Request'''
   <nowiki>
-GET /zones
+GET /accounts/smith1234/flexcloud/zone
-Authorization: Basic {invalid authorization}
+Authorization: Basic {invalid authorization}</nowiki>
- </nowiki>
 '''Response'''
   <nowiki>
-Unauthorized
+Unauthorized</nowiki>
- </nowiki>
 === Permission denied failure ===
 '''Request'''
   <nowiki>
-GET /zones
+GET /accounts/smith1234/flexcloud/zone
-Authorization: Basic {Base64-encoded username:password string}
+Authorization: Basic {Base64-encoded username:password string}</nowiki>
- </nowiki>
 '''Response'''
@@ Line 96: / Line 97: @@
      "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
+   }
+}</nowiki>
   </nowiki>
 == See also ==

@@ Line 1: / Line 1: @@
 = GET /zones =
-Returns all available zones for the authorized user.
+This operation will return all available zones for the authorized user.
 __TOC__
 == Request ==