Orders-orderId-account:GET
From Hostway API Documentation
Revision as of 00:58, 17 February 2013 by Mike.robski (Talk | contribs)
GET /orders/{orderId}/account
Get details of an Account in a given Order. It must be added to an order before details can be retrieved.
Contents |
Request
GET /orders/{orderId}/account
Request Parameters
- orderId - string
- The unique order Id. The URI of the order is returned by the POST /orders call.
URI Parameters
None.
Request Headers
- 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.
Response
Status Code
- 200 OK
- The operation was successfully completed.
- 404 Not Found
- An account has not been added to the given order or the order does not exist.
Response Body
{
"currency": "{currency}",
"language": "{language}",
"status": "{status}",
"attributes": "https://api.hostway.com/orders/{orderId}/account/attributes/",
"contactInfo": "https://api.hostway.com/orders/{orderId}/account/contactInfo/",
"paymentInfo": "https://api.hostway.com/orders/{orderId}/account/paymentInfo/",
"user": "https://api.hostway.com/orders/{orderId}/account/user/",
"links": [
{"href": "https://api.hostway.com/orders/{orderId}/account/", "rel": "self"}
]
}
Parameters
- currency - string
- An ISO-4217[1] currency code assigned to the account.
- language - string
- An IETF[2] language tag (ex. en, en-CA, en-US, etc.) specifying account's language.
- status - string
- The account's current status. Accounts that have not been provisioned will have a status of "new".
- attributes - string
- A link to the account's attributes.
- contactInfo - string
- A link to the account's contact info.
- paymentInfo - string
- A link to the account's payment information.
- user - string
- A link to the account's user.
- links - list
- Hypermedia for this resource.
See also
