Mike.robski: 1 revision: Release 109

2015-07-24T18:12:39Z

1 revision: Release 109

Stephen.botha: /* See also */

2015-04-21T16:53:00Z

Mike.robski: 1 revision: Release 86

2013-10-11T17:01:24Z

1 revision: Release 86

Velimira.metodieva: /* GET /partnerAccounts/{partnerAccountId}/attributes/{attribute} */

2013-10-07T12:06:37Z

GET /partnerAccounts/{partnerAccountId}/attributes/{attribute}

New page

= GET /partnerAccounts/''{partnerAccountId}''/attributes/''{attribute}'' =
Get attribute data.
__TOC__
== Request ==
<code>GET /partnerAccounts/''{partnerAccountId}''/attributes/''{attribute}''</code>

==== Parameters ====
; partnerAccountId - ''string''
: The Id of the partner account.

=== URI Parameters ===
; attribute - ''string''

=== 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 partner 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>
{
"name": "{name}",
"value": {value},
"links": [
{
"location": "{APIBaseURL}/partnerAccounts/{partnerAccountId}/attributes/{attribute}/",
"rel": "self"
}
]
}
</nowiki>

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

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

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

== Examples ==

=== Sending unauthorized request ===
''Request''
<nowiki>
GET /partnerAccounts/partner-account-id/attributes/test_attribute
</nowiki>

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

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

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

=== Requesting not existing attribute ===
'''Request'''
<nowiki>
GET /partnerAccounts/partner-account-id/attributes/not_existing_attribute
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
</nowiki>

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

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

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

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

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

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

@@ Line 119: / Line 119: @@
 == See also ==
 * [[Account|Account Management API]]
 * [[Common Features]]

PartnerAccounts-partnerAccountId-attributes-attribute:GET - Revision history

Mike.robski: 1 revision: Release 109

Stephen.botha: /* See also */

Mike.robski: 1 revision: Release 86

Velimira.metodieva: /* GET /partnerAccounts/{partnerAccountId}/attributes/{attribute} */