Orders-orderId-account-attributes:PUT - Revision history

Mike.robski: 1 revision: Release 99

2014-10-14T15:06:55Z

1 revision: Release 99

Pa.dinh at 11:06, 29 September 2014

2014-09-29T11:06:13Z

Mike.robski at 18:55, 23 September 2014

2014-09-23T18:55:30Z

Mike.robski: 1 revision: Release 98

2014-09-15T13:51:31Z

1 revision: Release 98

Pa.dinh at 11:15, 10 September 2014

2014-09-10T11:15:41Z

Show changes

Mike.robski: 1 revision: Release 85

2013-09-27T21:31:46Z

1 revision: Release 85

Alexander.pyatkov: /* Parameters */

2013-09-27T13:48:01Z

Parameters

Mike.robski: 1 revision

2013-02-17T06:58:58Z

1 revision

Mike.robski at 23:01, 15 February 2013

2013-02-15T23:01:25Z

New page

= PUT /orders/''{orderId}''/account/attributes =
Set the list of attributes for an account in a given order.
__TOC__

== Request ==
<code>PUT /orders/''{orderId}''/account/attributes</code>

==== Request Parameters ====
{{UriParameter-OrderId}}

=== URI Parameters ===
None.

=== Request Headers ===
; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>

{{Cookie-OwnerId}}

=== Request Body ===
<nowiki>
[
{
"name": "{attributeName}",
"value": "{attributeValue}"
},
{
"name": "{attributeName}",
"value": "{attributeValue}"
}
]
</nowiki>

==== Parameters ====
; attributeName - ''string''
: The unique name of the attribute. The list of supported attribute names is specific to the franchise. The common attributes include:
:: '''partner_account_id''' - unique account identifier in the partner system. The value should be unique within the franchise.

; attributeValue - ''string''
: The value of the attribute max 200 characters. Should adhere to the rules for the attribute specified by the name.

== Response ==

=== Status Code ===
;204 No Content
: The account attributes were successfully set.

;400 Bad Request
: The request body format is invalid or the attribute name is not supported by the franchise.

;404 Not Found
: The specified order does not exist.

=== Response Body ===
None.

== See also ==
* [[Orders|Orders API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Ordering API]]

@@ Line 68: / Line 68: @@
 | align="center" | -
 | No owner Id specified or the specified owner is not authorized to add attributes for this account.
 |-
 | 404 Not Found
@@ Line 191: / Line 195: @@
      "code": 400,
      "details": ""
+   }
 }</nowiki>

@@ Line 39: / Line 39: @@
 ; attributeValue - ''string''
 : The value of the attribute max 200 characters. Should adhere to the rules for the attribute specified by the name.
-: The value of the "partner_account_id" attribute is max 100 characters
+: The value of the "partner_account_id" attribute is max 100 characters. Allowed characters are alphanumeric characters, underscore, dot and dash.
 == Response ==

@@ Line 39: / Line 39: @@
 ; attributeValue - ''string''
 : The value of the attribute max 200 characters. Should adhere to the rules for the attribute specified by the name.
 == Response ==
 === Status Code ===
-;204 No Content
+;204 No Content : The account attributes were successfully set.
 : The account attributes were successfully set.
-;400 Bad Request
+;400 Bad Request : The request body format is invalid, the attribute name is not supported by the franchise, the attribute value is invalid (e.g: too long, contains invalid characters, etc).
-: The request body format is invalid or the attribute name is not supported by the franchise.
-;404 Not Found
+;404 Not Found : The specified order does not exist.
 : The specified order does not exist.
 === Response Body ===