H-Sphere Developer Guide

H-Sphere XML API: Domain Services

 

Related Docs:  

H-Sphere XML API Reference

Actions:

 

Action: deleteDomain

Description: deletes domain

Parameters:

    AuthToken:at - authentication information
    String:name - name of the domain to be deleted

Response: empty

Example:

<soapenv:Body>
<ns1:deleteDomain soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices">
<at href="#id0"/>
<name xsi:type="xsd:string">grinia.psoft</name>
</ns1:deleteDomain>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:DomainServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">wwwgrinia</login>
<password xsi:type="xsd:string">grinia</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:deleteDomainResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices"/>
</soapenv:Body>

 

Action: registerDomain

Description: registers domain using domain registrar (OpenSRS, Enom)

Parameters:

    AuthToken:at - authentication information
    String:name - domain to register
    Integer:period - registration period in years
    Integer:renew - period that the domain will be renewed for (in years)
    ContactInfo:ci - owner contact information
    ContactInfo:bi - billing contact information

Not standart type:

ContactInfo has the follwing fields:
    String:first_name;
    String:last_name;
    String:org_name;
    String:address1;
    String:address2;
    String:address3;
    String:city;
    String:state;
    String:country;
    String:postal_code;
    String:phone;
    String:fax;
    String:email;

Response: empty

Example:

<soapenv:Body>
<ns1:registerDomain soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices">
<at href="#id0"/>
<name xsi:type="xsd:string">tesregdomain.com</name>
<period xsi:type="xsd:int">1</period>
<renew xsi:type="xsd:int">2</renew>
<ci href="#id1"/>
<bi href="#id2"/>
</ns1:registerDomain>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:DomainServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">wwwgrinia</login>
<password xsi:type="xsd:string">grinia</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
<multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns3:ContactInfo" xmlns:ns3="urn:DomainServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<address1xsi:type="xsd:string">BAddress1</address1>
<address2 xsi:type="xsd:string">BAddress2</address2>
<address3 xsi:type="xsd:string">BAddress3</address3>
<city xsi:type="xsd:string">BCity</city>
<country xsi:type="xsd:string">UA</country>
<email xsi:type="xsd:string">BEmail</email>
<fax xsi:type="xsd:string">BFax</fax>
<first_name xsi:type="xsd:string">BName</first_name>
<last_name xsi:type="xsd:string">BLastname</last_name>
<org_name xsi:type="xsd:string">BOrgName</org_name>
<phone xsi:type="xsd:string">BPhone</phone>
<postal_code xsi:type="xsd:string">BPostalCode</postal_code>
<state xsi:type="xsd:string">BState</state>
</multiRef>
<multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:ContactInfo" xmlns:ns4="urn:DomainServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<address1 xsi:type="xsd:string">Address1</address1>
<address2 xsi:type="xsd:string">Address2</address2>
<address3 xsi:type="xsd:string">Address3</address3>
<city xsi:type="xsd:string">City</city>
<country xsi:type="xsd:string">UA</country>
<email xsi:type="xsd:string">Email</email>
<fax xsi:type="xsd:string">Fax</fax>
<first_name xsi:type="xsd:string">Name</first_name>
<last_name xsi:type="xsd:string">Lastname</last_name>
<org_name xsi:type="xsd:string">OrgName</org_name>
<phone xsi:type="xsd:string">Phone</phone>
<postal_code xsi:type="xsd:string">PostalCode</postal_code>
<state xsi:type="xsd:string">State</state>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:registerDomainResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices"/>
</soapenv:Body>

 

Action: addServiceDomain

Description: Adds a service domain

Parameters:

AuthToken:at - authentication information
String:name - name of the domain to be added

Response: empty

Example:

<soapenv:Body>
<ns1:addServiceDomain soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices">
<at href="#id0"/>
<name xsi:type="xsd:string">grinia.psoft</name>
</ns1:addServiceDomain>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:DomainServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">wwwgrinia</login>
<password xsi:type="xsd:string">grinia</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:addServiceDomainResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices"/>
</soapenv:Body>

 

Action: addDomain

Description: Adds a domain

Parameters:

AuthToken:at - authentication information

String:name - name of the domain to be added

Response: empty

Example:

<soapenv:Body>
<ns1:addDomain soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices">
<at href="#id0"/>
<name xsi:type="xsd:string">testdomain.test</name>
</ns1:addDomain>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:DomainServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">wwwgrinia</login>
<password xsi:type="xsd:string">grinia</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:addDomainResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices"/>
</soapenv:Body>

 

Action: addNoDomain

Description: Adds no domain alias (instant alias as a holder for the website without a domain)

Parameters:

AuthToken:at - authentication information

Response: empty

Example:

<soapenv:Body>
<ns1:addNoDomain soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices">
<at href="#id0"/>
</ns1:addNoDomain>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:DomainServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">wwwgrinia</login>
<password xsi:type="xsd:string">grinia</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:addNoDomainResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices"/>
</soapenv:Body>

 

Action: addSubDomain

Description: Adds a subdomain

Parameters:

AuthToken:at - authentication information

String:name - subdomain to be added

String:domain - name of the domain whose subdomain is to be added

Response: empty

Example:

<soapenv:Body>
<ns1:addSubDomain soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices">
<at href="#id0"/>
<name xsi:type="xsd:string">ftp</name>
<domain xsi:type="xsd:string">grinia.psoft</domain>
</ns1:addSubDomain>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:DomainServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">wwwgrinia</login>
<password xsi:type="xsd:string">grinia</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:addSubDomainResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices"/>
</soapenv:Body>

 

Action: add3rdLevelDomain

Description: Adds a 3rd level domain

Domain name should be based on a service zone that allows hosting, for example, test.service.zone

Parameters:

AuthToken:at - authentication information

String:name - domain to be added

Response: empty

Example:

<soapenv:Body>
<ns1:add3rdLevelDomain soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices">
<at href="#id0"/>
<name xsi:type="xsd:string">test2.grinia.psoft</name>
</ns1:add3rdLevelDomain>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:DomainServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">wwwgrinia</login>
<password xsi:type="xsd:string">grinia</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:add3rdLevelDomainResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices"/>
</soapenv:Body>

 

Action: addDomainAlias

Description: adds domain alias

Parameters:

AuthToken:at - authentication information
String: alias - alias name
String: domain - domain name
boolean: isDNS - create DNS zone (recommended) or not
boolean: isMailAlias - create mail domain alias or not

Response: empty

Example:

<soapenv:Body>
  <ns1:addDomainAlias soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices">
   <at href="#id0"/>
   <alias xsi:type="xsd:string">aliasname</alias>    <domain xsi:type="xsd:string">borisfen.dom</domain>    <isDNS xsi:type="xsd:boolean">true</isDNS>    <isMailAlias xsi:type="xsd:boolean">true</isMailAlias>   </ns1:addDomainAlias>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:DomainServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">myusername</login>
   <password xsi:type="xsd:string">mypassword</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>

 

Action: deleteDomainAlias

Description: deletes domain alias

Parameters:

AuthToken:at - authentication information
String: alias - alias name

Response: empty

Example:

<soapenv:Body>
  <ns1:deleteDomainAlias soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="DomainServices">
   <at href="#id0"/>
   <alias xsi:type="xsd:string">aliasname</alias>   </ns1:deleteDomainAlias>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:DomainServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">myusername</login>
   <password xsi:type="xsd:string">mypassword</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>

 


Related Docs:  

H-Sphere XML API Reference



© Copyright 1998-2006. Positive Software Corporation.
All rights reserved.