Latest revision as of 12:12, 24 July 2015

[edit] GET /partnerAccounts/{partnerAccountId}/attributes/{attribute}

Get attribute data.

[edit] Request

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

[edit] Parameters

partnerAccountId - string

The Id of the partner account.

[edit] URI Parameters

attribute - string

[edit] Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Content-Type

application/json

[edit] Response

[edit] 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.

[edit] Response Body

{ 
   "name": "{name}", 
   "value": {value},
   "links": [
      {
         "location": "{APIBaseURL}/partnerAccounts/{partnerAccountId}/attributes/{attribute}/", 
         "rel": "self"
      }
   ]
}
 

[edit] Parameters

name - string

Descriptive name of the attribute

value - string

Value of the attribute

links - list

Hypermedia for this resource. Links to self.

[edit] Examples

[edit] Sending unauthorized request

Request

GET /partnerAccounts/partner-account-id/attributes/test_attribute
 

Response

401 Unauthorized
 

[edit] Sending request without setting Content-Type

Request

GET /partnerAccounts/partner-account-id/attributes/test_attribute
Authorization: Basic base64_encode(username:password)
 

Response

415 Unsupported Media Type
 

[edit] Requesting not existing attribute

Request

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

Response

404 Not Found
 

[edit] Success scenario

Request

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

Response

200 OK

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

[edit] See also

• Account Attribute Management
• Account Management API
• Common Features