Accounts:GET - Revision history

Mike.robski: 1 revision: Release 101

2014-12-17T04:49:33Z

1 revision: Release 101

Jerry.dimitrov: /* Paginated request when more then one account is returned */

2014-11-14T13:12:38Z

Paginated request when more then one account is returned

Mike.robski: 1 revision: Release 91

2014-03-11T16:57:40Z

1 revision: Release 91

Velimira.metodieva: /* Examples */

2014-02-04T16:04:02Z

Examples

Mike.robski: 1 revision: Release 90

2014-01-31T18:23:43Z

1 revision: Release 90

Velimira.metodieva: /* Paginated request when more then one account is returned */

2014-01-30T11:59:44Z

Paginated request when more then one account is returned

New page

= GET /accounts =
Retrieves a list of all accounts authorized for access with the provided credentials.
__TOC__
== Request ==
<code>GET /accounts</code>

=== URI Parameters ===
; filterStatus - ''string''
: Optional. Only accounts with status matching the value of the parameter will be returned. Allowed values are '''pending''', '''open''', '''suspended''', '''closed'''.

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

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

=== Request Headers ===
{{Authorization}}

== Response ==

=== Status Code ===
;200 OK
: Success

;400 Bad Request
:

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation.

; 403 Forbidden
: Forbidden access to a user not authorized for such access.

; 415 Unsupported Media Type
: The Content-Type header was not specified or the specified type is not supported. Use application/json.

=== Response Body ===
<nowiki>
{
"list" : [{
"status" : "{status}",
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{account-number}/",
"rel" : "self"
}],
"accountNumber" : "{account-number}"
}],
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize={pageSize}&page={page}",
"rel" : "self"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize={pageSize}&page={page}",
"rel" : "next"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize={pageSize}&page={page}",
"rel" : "last"
}]
}
</nowiki>

==== Parameters ====
; list - ''list''
: A collection of dictionaries containing information about specific account

:; status - ''string''
:: Describes the status of the account. Valid values are '''pending''', '''open''', '''suspended''', '''closed'''

:; accountNumber - ''string''
:: The Id of the account

:; links - ''list''
:: [[Hypermedia]] for this account resource. Links to the account.

; links - ''list''
: [[Hypermedia]] Link to self and other resources relevant to the account lists

== Examples ==

=== Listing current account only when provided credentials don't give elevated access ===
'''Request'''
<nowiki>
GET /accounts
</nowiki>

'''Response'''
<nowiki>
{
"list": [{
"status": "open",
"links": [{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account/",
"rel": "self"
}],
"accountNumber": "test-account"
}],
"links": [{
"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts",
"rel": "self"
}]
}
</nowiki>

=== Paginated request when more then one account is returned ===
'''Request'''
<nowiki>
GET /accounts?pageSize=2&page=1
</nowiki>

'''Response'''
<nowiki>
{
"list" : [{
"status" : "open",
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account-1/",
"rel" : "self"
}],
"accountNumber" : "test-account-1"
},
"status" : "closed",
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts/test-account-2/",
"rel" : "self"
}],
"accountNumber" : "test-account-2"
}],
"links" : [{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>/accounts?pageSize=2&page=1",
"rel" : "self"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>?pageSize=2&page=2",
"rel" : "next"
},
{
"href" : "</nowiki>{{APIBaseURL}}<nowiki>?pageSize=2&page=11637",
"rel" : "last"
}]
}
</nowiki>

== See also ==
* [[Account|Account Management API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Account Management API]]

@@ Line 46: / Line 46: @@
      }],
      "accountNumber" : "{account-number}",
-     "createdDate" : "{created-date}"
+     "createdDate" : "{created-date}",
    }],
    "links" : [{
@@ Line 75: / Line 76: @@
 :; createdDate - ''date''
 :: The date account was created in format Y-m-d
 :;  links - ''list''
@@ Line 100: / Line 104: @@
        }],
        "accountNumber": "test-account",
-       "createdDate": "2009-12-07"
+       "createdDate": "2009-12-07",
     }],
     "links": [{
@@ Line 108: / Line 113: @@
+}
   </nowiki>
 === Paginated request when more then one account is returned ===
@@ Line 126: / Line 130: @@
           }],
           "accountNumber" : "test-account-1",
-          "createdDate": "2009-12-07"
+          "createdDate": "2009-12-07",
        },
           "status" : "closed",
@@ Line 134: / Line 139: @@
           }],
           "accountNumber" : "test-account-2",
-          "createdDate": "20012-11-01"
+          "createdDate": "20012-11-01",
        }],
     "links" : [{