Orders-orderId-account-products-productId-services-serviceId-attributes:PUT
From Hostway API Documentation
Revision as of 08:06, 15 August 2014 by Jerry.dimitrov (Talk)
PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes
Adds Attributes to the Service. Not all services support this call. Depending on the service, this call may return a response code of 405 (method not supported).
Contents |
Request
PUT /orders/{orderId}/account/products/{productId}/services/{serviceId}/attributes
Request Parameters
- orderId - string
- The unique order Id. The URI of the order is returned by the POST /orders call.
- productId - string
- UUID specifying the product
- serviceId - string
- UUID specifying the service
URI Parameters
None.
Request Headers
- Content-Type
- Required. Set this header to
application/json; charset=UTF-8
- Cookie
- A cookie named OwnerId to identify the client (for most browser clients, the browser will do this automatically, depending on the browser configuration). The value of the cookie would come from the response to the create order request in the Set-Cookie response header.
Request Body
A dictionary whose keys/values will depend on the service category of the service. See Service Attributes Structure.
{
"key_one": "Value One",
"key_two": "Value Two",
...
}
Validation Rules
- The service URL ( https://api.hostway.com/orders/{orderId}/account/products/{productId}/services/{serviceId} ) should point to a valid service already added to the product.
- The attribute key/value pair should be allowed for the service specification.
Response
Status Code
- 200 OK
- The attributes were successfully set.
- 400 Bad Request
- The request body contains invalid JSON or the values do not adhere to the restrictions set for them.
- 401 Unauthorized
- The OwnerId cookie was not specified or is incorrect.
- 403 Forbidden
- The client does not have permissions to add services.
- 404 Not Found
- An account has not been added to the given order or the order does not exist.
- 405 Method Not Allowed
- The service does not support attributes.
- 409 Conflict
- A conflict has occurred preventing attributes creation to particular service. There are different conflict situations for different products/services
- Domain-dependent services
- One of the domains to be ordered is already owned by another account or is blacklisted.
- Email domain alias service
- A domain alias would produce impossible to delivery loops namely:
- - There is an email forwarder from the target domain name to a mailbox of the domain alias with the same username, OR
- - There is an email forwarder from the domain alias to a mailbox of the target domain name with the same username
Response Body
None.
See also
