Mike.robski: 1 revision: Release 100

2014-11-19T05:09:35Z

1 revision: Release 100

Venzi.iliev: /* Request Parameters */

2014-10-20T16:25:21Z

Request Parameters

Mike.robski: 1 revision: Release 87

2013-11-15T21:22:13Z

1 revision: Release 87

Doron.sireni: /* Example of ordering .com domain. */

2013-09-20T21:27:55Z

Example of ordering .com domain.

New page

= PUT /accounts/''{accountId}''/domains/''{domainName}'' =
Place a domain registration order for an existing account.
__TOC__

== Request ==
<code>PUT /accounts/''{accountId}''/domains/''{domainName}''</code>

=== URI Parameters ===
; accountId - string
: The account number
{{DomainName}}

=== Request Headers ===
; Content-Type
: Required. Set this header to <code>application/json; charset=UTF-8</code>
; Authorization
: Required.

=== Request Body ===
'''Request Body for registering a domain'''
<nowiki>
{
"domainName": "{domainName}",
"operation": "register",
"term": {term},
"authInfo" : "{authInfo}",
"nameservers" : [ "{nameserver}", "{nameserver}" ],
"additionalParams" : {
"usNexusCode": "{usNexusCode}",
"usNexusCategory": "{usNexusCategory}"
},
"contactInfo" : {
"registrant": {
"type": "registrant",
"firstName": "{firstName}",
"lastName": "{lastName}",
"company": "{company}",
"street1": "{street1}",
"city": "{city}",
"zipOrPostal": "{zipOrPostal}",
"stateOrProvince": "{stateOrProvince}",
"countryCode": "{countryCode}",
"email1": "{email1}",
"phone1": "{phone1}" },
"administrative": {
"type": "administrative",
...
},
"billing": {
"type": "billing",
...
},
"technical": {
"type": "technical",
...
}
}
}
</nowiki>

==== Request Parameters ====
; domainName - ''string''
: The domain name
; operation - ''string''
: "register" to register a domain
; term - ''integer''
: the registration term (period) in years
; authInfo - ''string''
: authentication info, currently not supported
; nameservers - ''list of strings''
: domain name servers (DNS) for the domain
; usNexusCode - ''string'' (optional) (required for .us)
: one of the following [P1, P2, P3, P4, P5]
; usNexusCategory - ''string'' (optional) (required for .us)
: one of the following [C11, C12, C21, C31, C32]
; company - ''string'' (optional)
: The company or organization name
; firstName - ''string''
: The first name of the contact person
; lastName - ''string''
: The last name of the contact person
; street1 - ''string''
: The street address
; street2 - ''string'' (optional)
: The second line of the street address (if any)
; city - ''string''
: The city
; countryCode - ''string''
: The international 2-letter country code
; stateOrProvince - ''string''
: The state or province. For US states use the 2-letter state code
; zipOrPostal - ''string''
: The postal code
; email1 - ''string''
: The e-mail address of the contact person
; phone1 - ''string''
: The phone number of the contact person in valid [http://en.wikipedia.org/wiki/E.164 E.164] format, e.g. +1.3209270625

== Response ==

=== Status Code ===
;202 Accepted
: The domain registration order has been submitted.

;400 Bad Request
: The domain information is invalid.

=== Response Body ===
'''Response Body for registering domain'''

The response contains the order id and the link for the domain registration order.

<nowiki>
{
"orderId": "0000013dfeb0db5aa6c51427000ac81d1e6e110e",
"links":
[{"href": "http://coreapi01.ote.chicago.hostway:8100/orders/0000013dfeb0db5aa6c51427000ac81d1e6e110e",
"rel": "self"}]
}
</nowiki>

== Example of ordering .com domain. ==
<nowiki>
PUT /accounts/acct839326/domains/ng-test-fitnesse-shortcut-20130412-0940.com
Content-Type: application/json; charset=UTF-8
Authorization: Basic ...

{
"domainName": "ng-test-fitnesse-shortcut-20130412-0940.com",
"operation": "register",
"term": 1,
"authInfo" : "mysecret",
"nameservers" : [ "ns1.test.com", "ns2.test.com" ],
"contactInfo" : {
"registrant": {
"type": "registrant",
"firstName": "John",
"lastName": "Doe",
"company": "ACME Inc.",
"street1": "123 First Str.",
"city": "Chicago",
"zipOrPostal": "34567",
"stateOrProvince": "IL",
"countryCode": "US",
"email1": "john.doe@test.com",
"phone1": "+1.312.456789098"
},
"administrative": {
"type": "administrative",
...
},
"billing": {
"type": "billing",
...
},
"technical": {
"type": "technical",
...
}
}
}
</nowiki>

'''Response'''
<nowiki>
202 Accepted

{
"orderId": "0000013dfeb0db5aa6c51427000ac81d1e6e110e",
"links":
[{"href": "http://coreapi01.ote.chicago.hostway:8100/orders/0000013dfeb0db5aa6c51427000ac81d1e6e110e",
"rel": "self"}]
}
</nowiki>

== Example of ordering .us domain. ==
<nowiki>
PUT /accounts/acct839326/domains/ng-test-Fitnesse-shortcut-20130919-0134.us
Content-Type: application/json; charset=UTF-8
Authorization: Basic ...

{
"domainName": "ng-test-Fitnesse-shortcut-20130919-0134.us",
"operation": "register",
"term": 1,
"authInfo" : "mysecret",
"nameservers" : [ "ns1.test.com", "ns2.test.com" ],
"additionalParams" : {
"usNexusCode": "P1",
"usNexusCategory": "C11"
}
"contactInfo" : {
"registrant": {
"type": "registrant",
"firstName": "John",
"lastName": "Doe",
"company": "ACME Inc.",
"street1": "123 First Str.",
"city": "Chicago",
"zipOrPostal": "34567",
"stateOrProvince": "IL",
"countryCode": "US",
"email1": "john.doe@test.com",
"phone1": "+1.312.456789098"
},
"administrative": {
"type": "administrative",
...
},
"billing": {
"type": "billing",
...
},
"technical": {
"type": "technical",
...
}
}
}
</nowiki>

'''Response'''
<nowiki>
202 Accepted
{
"orderId": "00000141381446d465883bc9007f000000010001",
"links":
[{"href": "http://coreapi01.ote.chicago.hostway:8182/orders/00000141381446d465883bc9007f000000010001",
"rel": "self"}]}
}
</nowiki>

== See also ==
* [[Domain Name Registration|Domain Name Registration API]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

@@ Line 26: / Line 26: @@
     "authInfo" : "{authInfo}",
     "nameservers" : [ "{nameserver}", "{nameserver}" ],
-    "additionalParams" : {
+    "extraParams": [{"name": "...", "value": "..."}, ...],
-      "usNexusCode": "{usNexusCode}",
-      "usNexusCategory": "{usNexusCategory}"
-   },
     "contactInfo" : {
        "registrant": {
@@ Line 70: / Line 67: @@
 ; nameservers - ''list of strings''
 : domain name servers (DNS) for the domain
-; usNexusCode - ''string'' (optional) (required for .us)
+{{ExtraParam}}
-: one of the following [P1, P2, P3, P4, P5]
-; usNexusCategory - ''string'' (optional) (required for .us)
-: one of the following [C11, C12, C21, C31, C32]
 ; company - ''string'' (optional)
 : The company or organization name
@@ Line 186: / Line 180: @@
     "authInfo" : "mysecret",
     "nameservers" : [ "ns1.test.com", "ns2.test.com" ],
-    "additionalParams" : {
+    "extraParams": [{"name": "us_nexus", "value": "C11"}, {"name": "us_purpose", "value": "P1"}],
-      "usNexusCode": "P1",
-      "usNexusCategory": "C11"
-−
     "contactInfo" : {
        "registrant": {
@@ Line 223: / Line 214: @@
   <nowiki>
 Accepted
+{
     "orderId": "00000141381446d465883bc9007f000000010001",

Accounts-accountId-domains-domainName:PUT - Revision history

Mike.robski: 1 revision: Release 100

Venzi.iliev: /* Request Parameters */

Mike.robski: 1 revision: Release 87

Doron.sireni: /* Example of ordering .com domain. */