Difference between revisions of "Get Domain Info"

From Boxis.net API Docs
Jump to: navigation, search
(Success)
Line 13: Line 13:
 
==== example in XML ====
 
==== example in XML ====
  
===== Success =====
+
===== success =====
  
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
Line 54: Line 54:
 
</return>
 
</return>
  
===== Error =====
+
===== error =====
  
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
Line 66: Line 66:
 
==== Example in Json  ====
 
==== Example in Json  ====
  
===== Success =====
+
===== success =====
  
 
{"result":"1",
 
{"result":"1",
Line 101: Line 101:
 
}
 
}
  
===== Error =====
+
===== error =====
  
{"result":"0","resulttxt":"Error: {error description}","params":[],"timestamp":1335777400}
+
{"result":"0",
 +
"resulttxt":"Error: {error description}",
 +
"params":[],"timestamp":1335777400}
  
 
==== Errors Descriptions ====
 
==== Errors Descriptions ====

Revision as of 14:55, 2 May 2012

Domain Function: getDomain

With this command, you are able to viewing the domain details.

Input params

- domain::String::Domain name that you need to Transfer

Output params

example in XML

success

<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?> <return>

 <result>1</result>
 <resulttxt></resulttxt>
 <params>
   <details>
     <domain>test1.com</domain>
     <order_id>654</order_id>
     <payment_module>130</payment_module>
     <date_created>1970-01-01</date_created>
     <firstpayment>17.68</firstpayment>
     <recurring_amount>17.68</recurring_amount>
     <years>2</years>
     <expires>1970-01-01</expires>
     <type>Register</type>
     <status>Pending</status>
     <next_due>1970-01-01</next_due>
     <next_invoice>1969-12-25</next_invoice>
     <protect-privacy>1</protect-privacy>
     <nameservers>
       <ns1>ns1.boxis.ch</ns1>
       <ns2>ns1.boxis.ch</ns2>
       <ns3>ns3.boxis.ch</ns3>
       <ns4>ns4.boxis.ch</ns4>
       <ns5>ns5.boxis.ch</ns5>
     </nameservers>
     <autorenew>1</autorenew>
     <protection-lock>0</protection-lock>
     <auth-code></auth-code>
     <notes></notes>
     <extended></extended>
     <lastname>Keck</lastname>
     <firsname>Konrad</firsname>
   </details>
 </params>
 <timestamp>1335781349</timestamp>

</return>

error

<?xml version="1.0" encoding="UTF-8"?> <return>

 <result>0</result>
 <resulttxt>Error: {error description}</resulttxt>
 <params/>
 <timestamp>1335767184</timestamp>

</return>

Example in Json

success

{"result":"1",

"resulttxt":null,
"params":{
   "details":{
      "domain":"test1.com",
      "order_id":"654",
      "payment_module":"130",
      "date_created":"1970-01-01",
      "firstpayment":"17.68",
      "recurring_amount":"17.68",
      "years":"2","expires":"1970-01-01",
      "type":"Register",
      "status":"Pending",
      "next_due":"1970-01-01",
      "next_invoice":"1969-12-25",
      "protect-privacy":"1",
      "nameservers{
         "ns1":"ns1.boxis.ch",
         "ns2":"ns1.boxis.ch",
         "ns3":"ns3.boxis.ch",
         "ns4":"ns4.boxis.ch",
         "ns5":"ns5.boxis.ch"},
      "autorenew":"1",
      "protection-lock":"0",
      "auth-code":"",
      "notes":"",
      "extended":"",
      "lastname":"Keck",
      "firsname":"Konrad"}
 },
 "timestamp":1335781465

}

error

{"result":"0",

"resulttxt":"Error: {error description}",
"params":[],"timestamp":1335777400}

Errors Descriptions

- 'domain' is not valid
- this domain belongs to another user
- domain does not exists
- internal error