Accounts-accountNumber-web-domainName-aliases:GET - Revision history

Mike.robski: 1 revision: Release 109

2015-07-24T18:16:38Z

1 revision: Release 109

Velimira.metodieva: /* Examples */

2015-04-06T14:25:35Z

Examples

Mike.robski: 1 revision: Release 105

2015-04-03T17:57:25Z

1 revision: Release 105

Viktor.penkov: /* Successful retrieving domain name alias */

2015-03-23T14:45:04Z

Successful retrieving domain name alias

New page

= GET /accounts/{accountNumber}/web/{domainName}/aliases =
Returns a list of the domain name aliases.

__TOC__

== Request ==
<code>GET /accounts/{accountNumber}/web/{domainName}/aliases</code>

=== URI Parameters ===
; accountNumber - ''string''
: The user account to which the domain name and the domain name alias belong

; domainName - ''string''
: The target domain name (domain name under which the site is actually hosted)

=== Request Headers ===
{{Authorization}}

== Response ==

=== Response Body ===
<nowiki>
{
"list": [{"domain": "test.com", "domainAlias": "alias1-test.com"},
{"domain": "test.com", "domainAlias": "alias2-test.com"},
"links": [{"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/aliases",
"rel": "self"}]
}
</nowiki>

==== Parameters ====
:; list - ''list''
:: A list, containing the domain and the corresponding alias values.

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

=== Status Code ===
; 200 OK
: Success

; 401 Unauthorized
: The supplied credentials are invalid or do not provide permissions for this operation

; 403 Forbidden
: The authenticated user is not allowed to access this resource

; 404 Not Found
: The domain name or the domain name alias do not exist for the account

== Examples ==

=== Successful retrieving domain name alias ===
'''Request'''
<nowiki>
GET /accounts/test-account/web/test.com/aliases
</nowiki>

'''Response'''
<nowiki>
{
"list":
[
{"domain": "test.com", "domainAlias": "alias1-test.com"},
{"domain": "test.com", "domainAlias": "alias2-test.com"}
],
"links":
[
{"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/aliases/",
"rel": "self"}
]
}
</nowiki>

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

@@ Line 23: / Line 23: @@
   <nowiki>
+{
-     "list": [{"domain": "test.com", "domainAlias": "alias1-test.com"},
+     "list": [{"status": "{status}", "domain": "{domain}", "alias": "{alais}"},
-              {"domain": "test.com", "domainAlias": "alias2-test.com"},
+              {"status": "{status}", "domain": "{domain}", "alias": "{alais}"},
      "links": [{"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/aliases",
                 "rel": "self"}]
@@ Line 32: / Line 32: @@
 ==== Parameters ====
 :; list - ''list''
-:: A list, containing the domain and the corresponding alias values.
+:: A list, containing the status, the domain and the corresponding alias values.
 :; links - ''list''
@@ Line 63: / Line 72: @@
      "list":
+     [
-              {"domain": "test.com", "domainAlias": "alias1-test.com"},
+              {"status": "open", "domain": "test.com", "alias": "alias1-test.com"},
-              {"domain": "test.com", "domainAlias": "alias2-test.com"}
+              {"status": "open", "domain": "test.com", "alias": "alias2-test.com"}
      ],
      "links":
+     [
-              {"href": "http://{server_name}/accounts/{accountNumber}/web/{domainName}/aliases/",
+             {"href": "</nowiki>{{APIBaseURL}}<nowiki>/accounts/{accountNumber}/web/{domainName}/aliases/", "rel": "self"}
-               "rel": "self"}
+     ]
+}