Orders-orderId-attributes:PUT - Revision history

Mike.robski: 1 revision: Release 99

2014-10-14T15:07:00Z

1 revision: Release 99

Pa.dinh at 09:39, 1 October 2014

2014-10-01T09:39:03Z

Mike.robski: 1 revision: Release 98

2014-09-15T13:51:36Z

1 revision: Release 98

Pa.dinh: /* Status Code */

2014-09-10T08:33:20Z

Status Code

Mike.robski: 1 revision: Release 90

2014-01-31T18:01:57Z

1 revision: Release 90

Petre.popescu: Created page with "= PUT /orders/''{orderId}''/attributes = Set the list of attributes for an order. TOC == Request == `PUT /orders/''{orderId}''/attributes` ==== Request Parame..."

2014-01-29T22:05:39Z

Created page with "= PUT /orders/''{orderId}''/attributes = Set the list of attributes for an order. __TOC__ == Request == <code>PUT /orders/''{orderId}''/attributes</code> ==== Request Parame..."

New page

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

== Request ==
<code>PUT /orders/''{orderId}''/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:
:: '''AffiliateId''' - identifies an affiliate.

; 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 order attributes were successfully set.

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

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

;502 Bad Gateway : A critical (unknown) error occurred.

=== Response Body ===
None.

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

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

@@ Line 56: / Line 56: @@
 | The request body format is invalid.
 |-
-| Code: unknown_metadata_type, Could not find MetaData Type {attribute_key} for franchise {franchise}.
+| Could not find MetaData Type {attribute_key} for franchise {franchise}.
 | The attribute name is not supported by the franchise, the attribute value is invalid (e.g: too long, contains invalid characters, etc).
 |-
 | 401 Unauthorized
 | align="center" | -
-| Set order metadata without authenticating.
+| No owner Id specified or the specified owner is not authorized to set order attributes.
 |-
 | 404 Not Found
@@ Line 75: / Line 79: @@
 === Set order attributes correctly ===
 '''Request'''
   <nowiki>
@@ Line 88: / Line 91: @@
 === Set order attributes with invalid key ===
 '''Request'''
   <nowiki>
@@ Line 104: / Line 106: @@
    "computeFault": {
      "guid": "5b01960d-4110-43f0-b58f-d3178db61c6d",
-     "message": "<class 'order_builder.bl.validation.ValidationError.ValidationError'>: Code: unknown_metadata_type,
+     "message": "Could not find MetaData Type nonexistent_key for franchise hostway_us_main",
 Could not find MetaData Type nonexistent_key for franchise hostway_us_main",
      "code": 400, "details": ""
+   }
@@ Line 111: / Line 112: @@
 === Set order attributes with malformed body ===
 '''Request'''
   <nowiki>
@@ Line 137: / Line 137: @@
 === Set order attributes without authenticating ===
 '''Request'''
   <nowiki>
@@ Line 156: / Line 155: @@
 does not understand how to supply the credentials required.</nowiki>
-=== Set order attributes of unexisting order ===
+=== Unassociated user without cookie===
 '''Request'''
   <nowiki>

@@ Line 43: / Line 43: @@
 === Status Code ===
-;204 No Content : The order attributes were successfully set.
+{| class="wikitable"
-;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).
+== Example ==
-;404 Not Found : The specified order does not exist.
+=== Set order attributes correctly ===
-;502 Bad Gateway : A critical (unknown) error occurred.
+'''Request'''
-=== Response Body ===
+[ {"name":"_utma", "value":"utma_val"}, {"name":"_utmb", "value":"utmb_val"} ]</nowiki>
-None.
 == See also ==