Accounts-accountId-attributes:GET

From Hostway API Documentation
Jump to: navigation, search

GET /accounts/{accountId}/attributes

Get attributes list.

Contents

Request

GET /accounts/{accountId}/attributes

Parameters

accountId - string
The Id of the Hostway account.

URI Parameters

None.

Request Headers

Authorization - HTTP Authorization header [1]
The Authentication credentials of the client application.
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

{
  "list": [
    "name": "{name}",
    "value": "{value}",
    "links" : [{"href": "https://api.hostway.com/accounts/{accountId}/attributes/{name}", "rel": "related"}]
  ],
  "links": [
    {"href": "https://api.hostway.com/accounts/{accountId}/attributes", "rel": "self"}
  ]
}
 

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

GET /accounts/account-id/attributes
 

Response

401 Unauthorized
 

Sending request without setting Content-Type

Request

GET /accounts/account-id/attributes
Authorization: Basic base64_encode(username:password)
 

Response

415 Unsupported Media Type
 

Getting list of attributes of not existing account

Request

GET /accounts/not-existing-account-id/attributes
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
 

Response

404 Not Found
 

Success scenario

Request

GET /accounts/account-id/attributes
Authorization: Basic base64_encode(username:password)
Content-Type: application/json
 

Response

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"
        }
    ]
}
 

See also


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox