H-Sphere Developer Guide

H-Sphere XML API: User Services

 

Related Docs:  

H-Sphere XML API Reference

Actions:

 

Action: getDomains

Description: gets array of domains

Parameters:

AuthToken:at - authentication information

Response: String [] - array of domains

Example:

<soapenv:Body>
  <ns1:getDomains soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
  </ns1:getDomains>
  <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:UserService">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">gregin</login>
   <password xsi:type="xsd:string">qqqqq</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
<soapenv:Body>
  <ns1:getDomainsResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <getDomainsReturn xsi:type="soapenc:Array" soapenc:arrayType="xsd:string[12]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
    <item>subdomain.flora.zzzz.com</item>
    <item>tampa.zzzz.com</item>
    <item>korona.mmm.com</item>
    <item>flora.zzzz.com</item>
   </getDomainsReturn>
  </ns1:getDomainsResponse>
 </soapenv:Body>

 

Action: changePassword

Description: changes user password

Parameters:

AuthToken:at - authentication information
String:newPassword - new user password

Response: empty

Example:

 <soapenv:Body>
  <ns1:changePassword soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
   <newPassword xsi:type="xsd:string">wwwww</newPassword>
  </ns1:changePassword>
  <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:UserService">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">gregin</login>
   <password xsi:type="xsd:string">qqqqq</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:changePasswordResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices"/>
 </soapenv:Body>

 

Action: changeTotalTrafficQuota

Description: changes total traffic quota (in GB)

Parameters:

AuthToken:at - authentication information
double:size -new size of total traffic limit (in GB)

Response: empty

Example:

<soapenv:Body>
  <ns1:changeTotalTrafficQuota soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
   <size xsi:type="xsd:double">2.0</size>
  </ns1:changeTotalTrafficQuota>
  <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:UserService">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">gregin</login>
   <password xsi:type="xsd:string">qqqqq</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
<soapenv:Body>
  <ns1:changeTotalTrafficQuotaResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices"/>
 </soapenv:Body>

 

Action: getTotalTrafficQuota

Description: gets total traffic quota (in GB)

Parameters:

AuthToken:at - authentication information

Response: double:size - total traffic quota (in GB)

Example:

<soapenv:Body>
  <ns1:getTotalTrafficQuota soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
  </ns1:getTotalTrafficQuota>
  <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:UserService">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">gregin</login>
   <password xsi:type="xsd:string">qqqqq</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
<soapenv:Body>
  <ns1:getTotalTrafficQuotaResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <getTotalTrafficQuotaReturn xsi:type="xsd:double">2.0</getTotalTrafficQuotaReturn>
  </ns1:getTotalTrafficQuotaResponse>
 </soapenv:Body>

 

Action: getTotalTrafficUsage

Description: gets total traffic usage (in GB)

Parameters:

AuthToken:at - authentication information

Response: double:size - total traffic usage (in GB)

Example:

<soapenv:Body>
  <ns1:getTotalTrafficUsage soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
  </ns1:getTotalTrafficUsage>
  <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:UserService">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">gregin</login>
   <password xsi:type="xsd:string">qqqqq</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
<soapenv:Body>
  <ns1:getTotalTrafficUsageResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <getTotalTrafficUsageReturn xsi:type="xsd:double">10.248046875</getTotalTrafficUsageReturn>
  </ns1:getTotalTrafficUsageResponse>
 </soapenv:Body>

 

Action: getTotalTrafficUsageFrom

Description: gets start date of total traffic usage

Parameters:

AuthToken:at - authentication information

Response: Date: getTotalTrafficUsageFromReturn-start date of total traffic usage

Example:

<soapenv:Body>
  <ns1:getTotalTrafficUsageFrom soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
  </ns1:getTotalTrafficUsageFrom>
  <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:UserService">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">gregin</login>
   <password xsi:type="xsd:string">qqqqq</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
<soapenv:Body>
  <ns1:getTotalTrafficUsageFromResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <getTotalTrafficUsageFromReturn xsi:type="xsd:dateTime">2003-05-25T21:00:00.000Z</getTotalTrafficUsageFromReturn>
  </ns1:getTotalTrafficUsageFromResponse>
 </soapenv:Body>

 

Action: getTotalDiskQuota

Description: gets summary disk usage quota (in MB)

Parameters:

AuthToken:at - authentication information

Response: double:getTotalDiskQuotaReturn - summary disk usage quota (in MB)

Example:

<soapenv:Body>
  <ns1:getTotalDiskQuota soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
  </ns1:getTotalDiskQuota>
  <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:UserService">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">gregin</login>
   <password xsi:type="xsd:string">qqqqq</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
<soapenv:Body>
  <ns1:getTotalDiskQuotaResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <getTotalDiskQuotaReturn xsi:type="xsd:double">4.0</getTotalDiskQuotaReturn>
  </ns1:getTotalDiskQuotaResponse>
 </soapenv:Body>

 

Action: getTotalDiskUsage

Description: gets total disk usage (in MB)

Parameters:

AuthToken:at - authentication information

Response: double:getTotalDiskUsageReturn -total disk usage (in MB)

Example:

<soapenv:Body>
  <ns1:getTotalDiskUsage soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
  </ns1:getTotalDiskUsage>
  <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:UserService">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">gregin</login>
   <password xsi:type="xsd:string">qqqqq</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
<soapenv:Body>
  <ns1:getTotalDiskUsageResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <getTotalDiskUsageReturn xsi:type="xsd:double">0.0</getTotalDiskUsageReturn>
  </ns1:getTotalDiskUsageResponse>
 </soapenv:Body>

 

Action: changeTotalDiskQuota

Description: changes total disk quota (in MB)

Parameters:

AuthToken:at - authentication information
double:size - new total disk quota (in MB)

Response: empty

Example:

<soapenv:Body>
  <ns1:changeTotalDiskQuota soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
   <size xsi:type="xsd:double">3.0</size>
  </ns1:changeTotalDiskQuota>
  <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:UserService">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">gregin</login>
   <password xsi:type="xsd:string">qqqqq</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
<soapenv:Body>
  <ns1:changeTotalDiskQuotaResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices"/>
 </soapenv:Body>

 

Action: getPlan

Description: gets current plan type

Parameters:

AuthToken:at - authentication information

Response: Object[]:type - current plan id and name

Example:

<soapenv:Body>
  <ns1:getPlan soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
  </ns1:getPlan>
  <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:UserService">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">gregin</login>
   <password xsi:type="xsd:string">qqqqq</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
<soapenv:Body>
  <ns1:getPlanResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <getPlanReturn xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[2]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
    <item xsi:type="xsd:int">1000</item>
    <item xsi:type="xsd:string">Unix</item>
   </getPlanReturn>
  </ns1:getPlanResponse>
 </soapenv:Body>

 

Action: changePlan

Description: changes current plan type and billing period type

Parameters:

AuthToken:at - authentication information
int planId : new plan id
int periodId : new billing type id

Response: empty

Example:

<soapenv:Body>
  <ns1:changePlan soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
   <plan_id xsi:type="xsd:int">7057</plan_id>
   <periodId xsi:type="xsd:int">1</periodId>
  </ns1:changePlan>
  <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:UserService">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">gregin</login>
   <password xsi:type="xsd:string">qqqqq</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
<soapenv:Body>
  <ns1:changePlanResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices"/>
 </soapenv:Body>

 

Action: changeContactInfo

Description: changes user contact info

Parameters:

AuthToken:at - authentication information
ContactInfo:ci - contact info

Response: empty

Example:

<soapenv:Body>
  <ns1:changeContactInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
   <ci href="#id1"/>
  </ns1:changeContactInfo>
  <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:ContactInfo" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:UserServices">
   <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">Postal</postal_code>
   <state xsi:type="xsd:string">State</state>
   <state2 xsi:type="xsd:string">State2</state2>
  </multiRef>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns3:AuthToken" xmlns:ns3="urn:UserService" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">gregin</login>
   <password xsi:type="xsd:string">qqqqq</password>
   <role xsi:type="ns3:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
<soapenv:Body>
  <ns1:changeContactInfoResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices"/>
 </soapenv:Body>

 

Action: changeBillingInfo

Description: changes user billing info

Parameters:

AuthToken:at - authentication information
String:first_name - first name
String:last_name - last name
String:company - company name
String:address1 - first address
String:address2 - second address
String:city - city
String:state - first state
String:state2 - second state
String:postal_code - postal code
String:country - country(US or other)
String:phone - phone number
String:email - user email

Response: empty

Example:

 <soapenv:Body>
  <ns1:changeBillingInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
   <first_name xsi:type="xsd:string">first_name</first_name>
   <last_name xsi:type="xsd:string">last_name</last_name>
   <company xsi:type="xsd:string">company</company>
   <address1 xsi:type="xsd:string">address1</address1>
   <address2 xsi:type="xsd:string">address2</address2>
   <city xsi:type="xsd:string">city</city>
   <state xsi:type="xsd:string">state</state>
   <state2 xsi:type="xsd:string">state2</state2>
   <postal_code xsi:type="xsd:string">112313</postal_code>
   <country xsi:type="xsd:string">UA</country>
   <phone xsi:type="xsd:string">phone</phone>
   <email xsi:type="xsd:string">email</email>
  </ns1:changeBillingInfo>
  <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:UserServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">vovan2</login>
   <password xsi:type="xsd:string">vovan</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:changeBillingInfoResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices"/>
 </soapenv:Body>

 

Action: getBillingInfo

Description: returns user billing info

Parameters:

AuthToken:at - authentication information

Response: billing info

Example:

 <soapenv:Body>
  <ns1:getBillingInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
  </ns1:getBillingInfo>
  <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:UserServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">vovan2</login>
   <password xsi:type="xsd:string">vovan</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:getBillingInfoResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <getBillingInfoReturn xsi:type="soapenc:Array" soapenc:arrayType="ns3:NamedParameter[14]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:ns3="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
    <item href="#id0"/>
    <item href="#id1"/>
    <item href="#id2"/>
    <item href="#id3"/>
    <item href="#id4"/>
    <item href="#id5"/>
    <item href="#id6"/>
    <item href="#id7"/>
    <item href="#id8"/>
    <item href="#id9"/>
    <item href="#id10"/>
    <item href="#id11"/>
    <item href="#id12"/>
    <item href="#id13"/>
   </getBillingInfoReturn>
  </ns1:getBillingInfoResponse>
  <multiRef id="id8" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:NamedParameter" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns4="urn:UserServices">
   <name xsi:type="xsd:string">state</name>
   <value xsi:type="xsd:string">state</value>
  </multiRef>
  <multiRef id="id6" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns5:NamedParameter" xmlns:ns5="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">address2</name>
   <value xsi:type="xsd:string">address2</value>
  </multiRef>
  <multiRef id="id9" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns6:NamedParameter" xmlns:ns6="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">state2</name>
   <value xsi:type="xsd:string">state2</value>
  </multiRef>
  <multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns7:NamedParameter" xmlns:ns7="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">last_name</name>
   <value xsi:type="xsd:string">last_name</value>
  </multiRef>
  <multiRef id="id13" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns8:NamedParameter" xmlns:ns8="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">email</name>
   <value xsi:type="xsd:string">email</value>
  </multiRef>
  <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns9:NamedParameter" xmlns:ns9="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">first_name</name>
   <value xsi:type="xsd:string">first_name</value>
  </multiRef>
  <multiRef id="id3" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns10:NamedParameter" xmlns:ns10="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">org_name</name>
   <value xsi:type="xsd:string">company</value>
  </multiRef>
  <multiRef id="id12" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns11:NamedParameter" xmlns:ns11="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">phone</name>
   <value xsi:type="xsd:string">phone</value>
  </multiRef>
  <multiRef id="id11" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns12:NamedParameter" xmlns:ns12="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">country</name>
   <value xsi:type="xsd:string">UA</value>
  </multiRef>
  <multiRef id="id10" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns13:NamedParameter" xmlns:ns13="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">postal_code</name>
   <value xsi:type="xsd:string">112313</value>
  </multiRef>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns14:NamedParameter" xmlns:ns14="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">name</name>
   <value xsi:type="xsd:string">first_name</value>
  </multiRef>
  <multiRef id="id7" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns15:NamedParameter" xmlns:ns15="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">city</name>
   <value xsi:type="xsd:string">city</value>
  </multiRef>
  <multiRef id="id4" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns16:NamedParameter" xmlns:ns16="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">company</name>
   <value xsi:type="xsd:string">company</value>
  </multiRef>
  <multiRef id="id5" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns17:NamedParameter" xmlns:ns17="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">address1</name>
   <value xsi:type="xsd:string">address1</value>
  </multiRef>
 </soapenv:Body>

 

Action: getContactInfo

Description: returns user contact info

Parameters:

AuthToken:at - authentication information

Response: contact info

Example:

 <soapenv:Body>
  <ns1:getContactInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
  </ns1:getContactInfo>
  <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:UserServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">vovan2</login>
   <password xsi:type="xsd:string">vovan</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:getContactInfoResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <getContactInfoReturn xsi:type="soapenc:Array" soapenc:arrayType="ns3:NamedParameter[14]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:ns3="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
    <item href="#id0"/>
    <item href="#id1"/>
    <item href="#id2"/>
    <item href="#id3"/>
    <item href="#id4"/>
    <item href="#id5"/>
    <item href="#id6"/>
    <item href="#id7"/>
    <item href="#id8"/>
    <item href="#id9"/>
    <item href="#id10"/>
    <item href="#id11"/>
    <item href="#id12"/>
    <item href="#id13"/>
   </getContactInfoReturn>
  </ns1:getContactInfoResponse>
  <multiRef id="id7" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:NamedParameter" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns4="urn:UserServices">
   <name xsi:type="xsd:string">city</name>
   <value xsi:type="xsd:string">1</value>
  </multiRef>
  <multiRef id="id8" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns5:NamedParameter" xmlns:ns5="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">state</name>
   <value xsi:type="xsd:string">NA</value>
  </multiRef>
  <multiRef id="id9" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns6:NamedParameter" xmlns:ns6="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">state2</name>
   <value xsi:type="xsd:string"></value>
  </multiRef>
  <multiRef id="id3" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns7:NamedParameter" xmlns:ns7="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">org_name</name>
   <value xsi:type="xsd:string">1</value>
  </multiRef>
  <multiRef id="id10" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns8:NamedParameter" xmlns:ns8="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">postal_code</name>
   <value xsi:type="xsd:string">1111</value>
  </multiRef>
  <multiRef id="id5" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns9:NamedParameter" xmlns:ns9="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">address1</name>
   <value xsi:type="xsd:string">1</value>
  </multiRef>
  <multiRef id="id11" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns10:NamedParameter" xmlns:ns10="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">country</name>
   <value xsi:type="xsd:string">US</value>
  </multiRef>
  <multiRef id="id6" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns11:NamedParameter" xmlns:ns11="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">address2</name>
   <value xsi:type="xsd:string"></value>
  </multiRef>
  <multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns12:NamedParameter" xmlns:ns12="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">last_name</name>
   <value xsi:type="xsd:string">1</value>
  </multiRef>
  <multiRef id="id12" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns13:NamedParameter" xmlns:ns13="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">phone</name>
   <value xsi:type="xsd:string">1</value>
  </multiRef>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns14:NamedParameter" xmlns:ns14="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">name</name>
   <value xsi:type="xsd:string">1</value>
  </multiRef>
  <multiRef id="id4" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns15:NamedParameter" xmlns:ns15="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">company</name>
   <value xsi:type="xsd:string">1</value>
  </multiRef>
  <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns16:NamedParameter" xmlns:ns16="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">first_name</name>
   <value xsi:type="xsd:string">1</value>
  </multiRef>
  <multiRef id="id13" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns17:NamedParameter" xmlns:ns17="urn:UserServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <name xsi:type="xsd:string">email</name>
   <value xsi:type="xsd:string">1@1.1</value>
  </multiRef>
 </soapenv:Body>

 

Action: getBalance

Description: returns account balance

Parameters:

AuthToken:at - authentication information

Response: account balance

Example:

<soapenv:Body>
  <ns1:getBalance soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
  </ns1:getBalance>
  <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:UserServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">unix1609</login>
   <password xsi:type="xsd:string">unixpass</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
<soapenv:Body>
  <ns1:getBalanceResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <getBalanceReturn xsi:type="xsd:string">195</getBalanceReturn>
  </ns1:getBalanceResponse>
</soapenv:Body>

 

Action: addAntiVirusResources

( in 2.4.3 RC 1)

Description: adds antiviruses for account

Parameters:

AuthToken:at - authentication information
String:range - "mailbox" (for all mailboxes) OR "all" (for all mailresources)

Response: empty

Example:

<soapenv:Body>
  <ns1:addAntiVirusResources soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
   <range xsi:type="xsd:string">all</range>
  </ns1:addAntiVirusResources>
  <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:UserService">
   <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: addAntiSpamResources

( in 2.4.3 RC 1)

Description: adds antispams for account

Parameters:

AuthToken:at - authentication information
String:range - "mailbox" (for all mailboxes) OR "all" (for all mailresources)

Response: empty

Example:

<soapenv:Body>
  <ns1:addAntiSpamResources soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
   <range xsi:type="xsd:string">all</range>
  </ns1:addAntiSpamResources>
  <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:UserService">
   <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: deleteAntiVirusResources

( in 2.4.3 RC 1)

Description: deletes all antiviruses for accounts

Parameters:

AuthToken:at - authentication information

Response: empty

Example:

<soapenv:Body>
  <ns1:deleteAntiVirusResources soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
  </ns1:deleteAntiVirusResources>
  <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:UserService">
   <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: deleteAntiSpamResources

( in 2.4.3 RC 1)

Description: deletes all antispams for accounts

Parameters:

AuthToken:at - authentication information

Response: empty

Example:

<soapenv:Body>
  <ns1:deleteAntiSpamResources soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="UserServices">
   <at href="#id0"/>
  </ns1:deleteAntiSpamResources>
  <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:UserService">
   <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.