Corinne.chui: 1 revision

2016-05-30T19:35:02Z

1 revision

Emanuela.mitreva at 15:12, 14 January 2016

2016-01-14T15:12:21Z

Show changes

Mike.robski: 1 revision: Release 111

2015-09-18T17:15:14Z

1 revision: Release 111

Jerry.dimitrov at 16:21, 26 May 2014

2014-05-26T16:21:35Z

New page

= GET /accounts/{account_number}/dedicatedServers =
Retrieves a list of fully provisioned dedicated servers
__TOC__

== Request ==
<code>GET /accounts/''{account_number}''/dedicatedServers</code>

<code>GET /accounts/''{account_number}''/dedicatedServers?page=page&pageSize=page-size&sortField=sortField&sortOrder=sortOrder</code>

==== Request Parameters ====
; account_number - ''string''
: The user account owning the dedicated servers

=== URI Parameters ===

; page - ''integer''
: Specifies which page should be displayed. Requires a pageSize parameter to also be provided.

; pageSize - ''integer''
: Specifies the number of entries to be displayed on a page. Requires a page parameter to also be provided

; sortField - ''string''
: Specifies if the resulting list is to be sorted by a given field. Allowed value is '''serverName'''. If the field is missing the list will be ordered by serverName.

; sortOrder - ''string''
: The order in which the sorting is to be done. Allowed values are '''asc''' and '''desc'''. If the field is missing the order is '''asc'''.

=== Request Headers ===

{{Authorization}}

== Response ==

=== Response Body ===
<nowiki>
{
"list": [
{
"serverName": "{serverName}",
"details": "http://{server_name}/accounts/{account_number}/dedicatedServers/{dedicated_server_id}",
}
],
"links":
[
{
"href" : "http://{server_name}/accounts/{account_number}/dedicatedServers?page=2&pageSize=2",
"rel" : "self"
},
{
"href" : "http://{server_name}/accounts/{account_number}/dedicatedServers?page=1&pageSize=2",
"rel" : "first"
},
{
"href" : "http://{server_name}/accounts/{account_number}/dedicatedServers?page=1&pageSize=2",
"rel" : "previous"
},
{
"href" : "http://{server_name}/accounts/{account_number}/dedicatedServers?page=1&pageSize=3",
"rel" : "next"
},
{
"href" : "http://{server_name}/accounts/{account_number}/dedicatedServers?page=1&pageSize=3",
"rel" : "last"
}
]
}
</nowiki>

==== Parameters ====
; serverName - ''string''
: The name of an individual dedicated server

; details - ''string''
: hypermedia to the give dedicated server

; links - ''list''
: [[Hypermedia]] for this resource. Link to self will preserve sorting and pagination set by the request. Links to the first, last, previous and next pages will also be included if applicable

=== Expected Response Codes ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid.

; 403 Forbidden
: The authorized user does not have permissions to access the resource. The only user(s) who has access to the dedicated servers list must be a sales agent, the account owner, or the account technical admin.

; 404 Not Found
: The account does not exist.

== Examples ==

=== Get a list of dedicated servers ===
'''Request'''
<nowiki>
GET accounts/test-account123/dedicatedServers
</nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"serverName": "Server Name 1",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-1"
},
{
"serverName": "Server Name 2",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-2"
},
{
"serverName": "Server Name 3",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-3"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/",
"rel": "self"
}
]
}
</nowiki>

=== Get a list of dedicated servers sorted by server name in an descending order ===
'''Request'''
<nowiki>
GET accounts/test-account123/dedicatedServers?sortField=serverName&sortOrder=desc
</nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"serverName": "Server Name 3",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-3"
},
{
"serverName": "Server Name 2",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-2"
},
{
"serverName": "Server Name 1",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-1"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers?sortField=serverName&sortOrder=desc",
"rel": "self"
}
]
}
</nowiki>

=== Get a list of dedicated servers with pagination ===
'''Request'''
<nowiki>
GET accounts/test-account123/test.com/dedicatedServers?page=2&pageSize=2
</nowiki>

'''Response'''
<nowiki>
{
"list": [
{
"serverName": "Server Name 1",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-1"
},
{
"username": "Server Name 2",
"details": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers/server-id-2"
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers?page=2&pageSize=2",
"rel": "self"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers?page=1&pageSize=2",
"rel": "first"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers?page=1&pageSize=2",
"rel": "previous"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers?page=3&pageSize=2",
"rel": "next"
},
{
"href": "{{APIBaseURL}}/accounts/test-account123/dedicatedServers?page=3&pageSize=2",
"rel": "last"
}
]
}
</nowiki>

== See also ==
* [[Dedicated_Server_API|Dedicated Server API]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Dedicated Server API]]

Accounts-account-dedicatedServers:GET - Revision history

Corinne.chui: 1 revision

Emanuela.mitreva at 15:12, 14 January 2016

Mike.robski: 1 revision: Release 111

Jerry.dimitrov at 16:21, 26 May 2014