Orders-orderId-account:GET - Revision history

Mike.robski: 1 revision: Release 99

2014-10-14T15:06:55Z

1 revision: Release 99

Pa.dinh at 10:38, 29 September 2014

2014-09-29T10:38:42Z

Mike.robski: 1 revision: Release 98

2014-09-15T13:51:31Z

1 revision: Release 98

Pa.dinh at 12:50, 9 September 2014

2014-09-09T12:50:36Z

Mike.robski: 1 revision

2013-02-17T06:58:58Z

1 revision

Mike.robski at 23:01, 15 February 2013

2013-02-15T23:01:07Z

New page

= GET /orders/''{orderId}''/account =
Get details of an Account in a given Order. It must be [[Orders-orderId-account:PUT|added]] to an order before details can be retrieved.
__TOC__

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

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

=== URI Parameters ===
None.

=== Request Headers ===
{{Cookie-OwnerId}}

== 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 ===
<nowiki>
{
"currency": "{currency}",
"language": "{language}",
"status": "{status}",
"attributes": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/attributes/",
"contactInfo": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/contactInfo/",
"paymentInfo": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/paymentInfo/",
"user": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/user/",
"links": [
{"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/", "rel": "self"}
]
}
</nowiki>

==== Parameters ====
; currency - ''string''
: An ISO-4217[http://www.iso.org/iso/home/standards/currency_codes.htm] currency code assigned to the account.

; language - ''string''
: An IETF[http://www.w3.org/International/articles/language-tags/Overview.en.php] 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 [[Orders-orderId-account-attributes:GET|attributes]].

; contactInfo - ''string''
: A link to the account's [[Orders-orderId-account-contactInfo:GET|contact info]].

; paymentInfo - ''string''
: A link to the account's [[Orders-orderId-account-paymentInfo:GET|payment information]].

; user - ''string''
: A link to the account's [[Orders-orderId-account-user:GET|user]].

; links - ''list''
: [[Hypermedia]] for this resource.

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

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

@@ Line 32: / Line 32: @@
 | align="center" | -
 | No owner Id specified or the specified owner is not authorized to perform add account for this order.
 |-
 | rowspan="2" | 404 Not Found
@@ Line 107: / Line 111: @@
 Either you supplied the wrong credentials (e.g., bad password),
 or your browser does not understand how to supply the credentials required.</nowiki>
 === Account has not been set ===

@@ Line 18: / Line 18: @@
 === Status Code ===
-;404 Not Found
+{| class='wikitable'
-: An account has not been added to the given order or the order does not exist.
+|-
 === Response Body ===
   <nowiki>
+{
    "status": "{status}",
    "paymentInfo": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/paymentInfo/",
    "links": [
      {"href": "</nowiki>{{APIBaseURL}}<nowiki>/orders/{orderId}/account/", "rel": "self"}
+   ]
+}
   </nowiki>
@@ Line 46: / Line 64: @@
 ; language - ''string''
 : An IETF[http://www.w3.org/International/articles/language-tags/Overview.en.php] language tag (ex. en, en-CA, en-US, etc.) specifying account's language.
 ; status - ''string''
@@ Line 61: / Line 82: @@
 ; user - ''string''
 : A link to the account's [[Orders-orderId-account-user:GET|user]].
 ; links - ''list''
 : [[Hypermedia]] for this resource.
 == See also ==