Mike.robski: 1 revision: Release 109

2015-07-24T18:12:40Z

1 revision: Release 109

Petre.popescu: Created page with "= GET /accounts/''{accountId}''/attributes = Get attributes list. TOC == Request == `GET /accounts/''{accountId}''/attributes` ==== Parameters ==== ; accountId..."

2015-04-28T18:13:33Z

Created page with "= GET /accounts/''{accountId}''/attributes = Get attributes list. __TOC__ == Request == <code>GET /accounts/''{accountId}''/attributes</code> ==== Parameters ==== ; accountId..."

New page

= GET /accounts/''{accountId}''/attributes =
Get attributes list.
__TOC__
== Request ==
<code>GET /accounts/''{accountId}''/attributes</code>

==== Parameters ====
; accountId - ''string''
: The Id of the Hostway account.

=== URI Parameters ===
None.

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

; Content-Type
: application/json

== Response ==

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

; 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.

; 404 Not Found
: The account Id or attribute were not found.

; 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": [
"name": "{name}",
"value": "{value}",
"links" : [{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/attributes/{name}", "rel": "related"}]
],
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountId}/attributes", "rel": "self"}
]
}
</nowiki>

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

:; name - ''string''
:: Descriptive name of the attribute

:; value - ''string''
:: Value of the attribute

: NOTE: The "partner_account_id" attribute will not be returned in this list.

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

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

== Examples ==

=== Sending unauthorized request ===
''Request''
<nowiki>
GET /accounts/account-id/attributes
</nowiki>

''Response''
<nowiki>
401 Unauthorized
</nowiki>

=== Sending request without setting Content-Type ===
''Request''
<nowiki>
GET /accounts/account-id/attributes
Authorization: Basic base64_encode(username:password)
</nowiki>

''Response''
<nowiki>
415 Unsupported Media Type
</nowiki>

=== Getting list of attributes of not existing account ===
'''Request'''
<nowiki>
GET /accounts/not-existing-account-id/attributes
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
</nowiki>

'''Response'''
<nowiki>
404 Not Found
</nowiki>

=== Success scenario ===
'''Request'''
<nowiki>
GET /accounts/account-id/attributes
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
</nowiki>

'''Response'''
<nowiki>
200 OK

{
"list": [
{
"name": "test_attribute",
"value": "123",
"links": [{"href": "{{APIBaseURL}}/accounts/account-id/attributes/test_attribute/", "rel": "related"}]
}
],
"links": [
{
"href": "{{APIBaseURL}}/accounts/account-id/attributes/",
"rel": "self"
}
]
}
</nowiki>

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

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

Accounts-accountId-attributes:GET - Revision history

Mike.robski: 1 revision: Release 109

Petre.popescu: Created page with "= GET /accounts/''{accountId}''/attributes = Get attributes list. __TOC__ == Request == GET /accounts/''{accountId}''/attributes ==== Parameters ==== ; accountId..."

Petre.popescu: Created page with "= GET /accounts/''{accountId}''/attributes = Get attributes list. TOC == Request == `GET /accounts/''{accountId}''/attributes` ==== Parameters ==== ; accountId..."