Parallels H-Sphere Documentation Developer Guide Javadoc XML API

 

H-Sphere XML API: Admin Services

 
 

Related Docs:   H-Sphere XML API Reference Javadoc XML API

Last modified: 21 Aug 2006

 

WARNING: This documentation covers Parallels H-Sphere versions up to 3.1. For the latest up-to-date Parallels H-Sphere documentation, please proceed to the official Parallels site.

WARNING:
This documentation is outdated! Please refer to Javadoc XML API for up-to-date reference!

Actions:

 

Action: signupUser

Description: signs up new users.

There are two implementations of this method:

  • The first one creates a new user without a domain (mod="empty"). In this case "otherParams" section is still necessary in xml, yet the parameters must be as follows:
    <otherParams xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[7]" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
    <item xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[2]" xmlns:ns6="http://www.w3.org/2002/12/soap-encoding">
    <item xsi:type="xsd:string">type_domain </item >
    <item xsi:type="xsd:string">empty_domain</item>
    < /item >
    </otherParams>
    if these parameters are not set in xml, users won't be created correctly.

  • With the second mehtod you can create users with different modes (signup - with transfer domain, 3ldomain - to create a third level domain , service - to create a service domain, etc.).To use the second method, you need to add additional parameters, like domain name, etc., to the request.

To sign up accounts without billing, parameters must be set to null. In this case it's required to enter only contact info. Billing and payment info parameters must be set to null (starting from 2.5 RC3; in earlier versions payment type must be set to "None"). And the plan payment type must be set to "without billing". Besides, if there's a signup for plan without billing, there mustn't be opensrs domain registration.

If you don't use mod='opensrs' or if you use mod='opensrs' but you want ContactInfo and BilingInfo for Domain Registrar to be the same as the user's one, you can omit the srsci and srsbi parameters.

Parameters:

    AuthToken:at - authentication information
    Integer:planId - plan Id
    Integer:periodId - period Id from this plan
    String:login - user name
      * H-Sphere validation: more than 4 characters,(except for special symbols) and not longer than 20 characters.
    String:password - user password
      * H-Sphere validation: from 5 to 12 characters (any symbols)
    String:descr - description that will be added to account description
    ContactInfo:ci - user contact info
    ContactInfo:bi - user Billing info
    ContactInfo srsci - user contact info for Domain Registrar (for mod='opensrs')
    ContactInfo srsbi - user billing info for Domain Registrar (for mod='opensrs')
    PaymentInfo:pi - user payment info

Optional parameters:

    String:mod - domain type modifier. Can take one of the following values: "empty", "opensrs", "dtransfer", "nodomain", "3ldomain", "service" and "empty" (for registration without domain).
    Array:othereparams - array consisting of name-value pairs

Response: NamedParameter[]: [accountId] [signupId] [userId]

Non-standard types:

  • ContactInfo: contact information.
    Fields:
        String:first_name;
        String:last_name;
        String:org_name;
        String:address1;
        String:address2;
        String:address3;
        String:city;
        String:state;
        * 2 letters, if no state, then: NA
        String:country;
        * 2 letters
        String:postal_code;
        String:phone;
        String:fax;
        String:email;
  • PaymentInfo: Payment information like CreditCard Check,PayPal, etc.
    Fields:
        String type - Check, CC, PayPal, WorldPay, 2CheckOut, None;
        String number - Credit card;
        String name - Credit Card owner name;
        String cc_type CreditCard type is VISA, MC, etc.;
        String expYear - expiration year;
        String expMonth - expereation month;
        String expDay - expiration day;
        String issueNo - issue number;
        String startDay - start day;
        String startYear - start year;
        String startMonth - start month;
    * The 'type' parameter is always set. Other params are used only for the 'CC' type. 'startDay', 'startMonth', 'startYear' are used only for certain credit cards types.

Example:

<soapenv:Body>
<ns1:signupUser soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices">
<at href="#id0"/>
<planId xsi:type="xsd:int">7003</planId>
<periodId xsi:type="xsd:int">0</periodId>
<login xsi:type="xsd:string">testggg3</login>
<password xsi:type="xsd:string">testggg</password>
<descr xsi:type="xsd:string">test-service</descr>
<ci href="#id1"/>
<bi href="#id2"/>
<pi href="#id3"/>
<validateUser xsi:type="xsd:boolean">true</validateUser>
<mod xsi:type="xsd:string">signup</mod>
<otherParams xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[7]" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<item xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[2]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding">
<item xsi:type="xsd:string">domain_name</item>
<item xsi:type="xsd:string">tyfdwefgdytwed.weduhwe</item>
</item>

<item xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[2]" xmlns:ns3="http://www.w3.org/2002/12/soap-encoding">
<item xsi:type="xsd:string">seller_id</item>
<item xsi:type="xsd:string">1</item>
</item>
<item xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[2]" xmlns:ns4="http://www.w3.org/2002/12/soap-encoding">
<item xsi:type="xsd:string">admin_signup</item>
<item xsi:type="xsd:string">yes</item>
</item>
<item xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[2]" xmlns:ns5="http://www.w3.org/2002/12/soap-encoding">
<item xsi:type="xsd:string">signup</item>
<item xsi:type="xsd:string">yes</item>
</item>
<item xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[2]" xmlns:ns6="http://www.w3.org/2002/12/soap-encoding">
<item xsi:type="xsd:string">type_domain</item>
<item xsi:type="xsd:string">transfer_new_misc_domain</item>
</item>
<item xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[2]" xmlns:ns6="http://www.w3.org/2002/12/soap-encoding">
<item xsi:type="xsd:string">_ci_promo_code</item>
<item xsi:type="xsd:string">A1112233</item>
</item>
<item xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[2]" xmlns:ns6="http://www.w3.org/2002/12/soap-encoding">
<item xsi:type="xsd:string">REMOTE_ADDR</item>
<item xsi:type="xsd:string">213.130.17.170</item>
</item>
</otherParams>
</ns1:signupUser>
<multiRef id="id3" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns3:PaymentInfo" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns3="urn:AdminServices">
<cc_type xsi:type="xsd:string">VISA</cc_type>
<expDay xsi:type="xsd:string">02</expDay>
<expMonth xsi:type="xsd:string">12</expMonth>
<expYear xsi:type="xsd:string">2004</expYear>
<issueNo xsi:type="xsd:string">54</issueNo>
<name xsi:type="xsd:string">name vasia</name>
<number xsi:type="xsd:string">41111111111</number>
<startDay xsi:type="xsd:string">03</startDay>
<startMonth xsi:type="xsd:string">01</startMonth>
<startYear xsi:type="xsd:string">2004</startYear>
<type xsi:type="xsd:string">CC</type>
</multiRef>
<multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:ContactInfo" xmlns:ns4="urn:AdminServices" 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">Postal</postal_code>
<state xsi:type="xsd:string">NA</state>
<state2 xsi:type="xsd:string">BState2</state2>
</multiRef>
<multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns5:ContactInfo" xmlns:ns5="urn:AdminServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<address1 xsi: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">BPostalo</postal_code>
<state xsi:type="xsd:string">BState</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="ns6:AuthToken" xmlns:ns6="urn:AdminServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">admin</login>
<password xsi:type="xsd:string">admin</password>
<role xsi:type="ns6:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:signupUserResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices">
<signupUserReturn xsi:type="soapenc:Array" soapenc:arrayType="ns3:NamedParameter[1]" 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"/>
</signupUserReturn>
</ns1:signupUserResponse>
<multiRef id="id0" 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">signupId</name>
<value xsi:type="xsd:string">10</value>
</multiRef>
</soapenv:Body>

 

Action: suspendAccount

Description: suspends an H-Sphere account.

Parameters:

    AuthToken:at - authentication information
    long:accountId - account identifier
    string:reason - reason for suspension

Response: empty

Example:

 <soapenv:Body>
  <ns1:suspendAccount soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices">
   <at href="#id0"/>
   <accountId xsi:type="xsd:long">1950</accountId>
   <reason xsi:type="xsd:string">TESTPURPOSES</reason>
  </ns1:suspendAccount>
  <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:AdminServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:suspendAccountResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices"/>
 </soapenv:Body>

 

Action: resumeAccount

Description: resumes an H-Sphere account.

Parameters:

    AuthToken:at - authentication information
    long:accountId - account identifier

Response: empty

Example:

 <soapenv:Body>
  <ns1:resumeAccount soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices">
   <at href="#id0"/>
   <accountId xsi:type="xsd:long">1950</accountId>
  </ns1:resumeAccount>
  <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:AdminServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:resumeAccountResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices"/>
 </soapenv:Body>

 

Action: deleteAccount

Description: deletes an H-Sphere account.

Parameters:

    AuthToken:at - authentication information
    long:accountId - account identifier

Response: empty

Example:

 <soapenv:Body>
  <ns1:deleteAccount soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices">
   <at href="#id0"/>
   <accountId xsi:type="xsd:long">1950</accountId>
  </ns1:deleteAccount>
  <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:AdminServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:deleteAccountResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices"/>
 </soapenv:Body>

 

Action: getQuota

Description: gets user quota.

Parameters:

    AuthToken:at - authentication information
    long:accountId - account identifier

Response:

    double:getQuotaReturn - returns quota in kilobytes

Example:

 <soapenv:Body>
  <ns1:getQuota soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices">
   <at href="#id0"/>
   <accountId xsi:type="xsd:long">1950</accountId>
  </ns1:getQuota>
  <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:AdminServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:getQuotaResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices">
   <getQuotaReturn xsi:type="xsd:double">100.0</getQuotaReturn>
  </ns1:getQuotaResponse>
 </soapenv:Body>

 

Action: oneTimeDebit

Description: debits account for extra services you provide.

Parameters:

    AuthToken:at - authentication information
    long:accountId - account identifier
    double:amount - amount that you debit the user
    String:description- information or remarks for the user that will help him distinguish this invoice from others.
    String:note - additional information or remarks displayed in the user's invoice in italics. </font>
    boolean:isInvoice - e-mail invoicing
    boolean:inclTaxes - include taxes

Response: empty

Example:

<soapenv:Body>
<ns1:oneTimeDebit soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices">
<at href="#id0"/>
<accountId xsi:type="xsd:long">1615</accountId>
<amount xsi:type="xsd:double">99.8</amount>
<description xsi:type="xsd:string">my description</description>
<note xsi:type="xsd:string">my note</note>
<isInvoice xsi:type="xsd:boolean">true</isInvoice>
<inclTaxes xsi:type="xsd:boolean">true</inclTaxes>
</ns1:oneTimeDebit>
<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:AdminServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">admin</login>
<password xsi:type="xsd:string">admin</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:oneTimeDebitResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices"/>
</soapenv:Body>

 

Action: monthlyBasedDebit

Description: debit account on a regular basis for extra services you provide. Determine the debit duration and frequency of charges. The length of the billing period is disregarded.

Parameters:

    AuthToken:at - authentication information
    long:accountId - accountId
    double:amount - amount that you debit the user
    int:duration - when the set period expires, debit charges are discontinued ( month(s))
    int:frequency - the debit cycle. E.g.: with 24 month duration and 3 month frequency the customer is charged every 3 months (8 times for the whole cycle)
    String:description - information or remarks for the user that will help him distinguish this invoice from others.
    String:note - additional information or remarks displayed in the user's invoice in italics
    String:adminNote - additional information or remarks on the debit you've set. This note is available only for admin.
    int startOn - define the time when the user is debited (it can have the following values -1,2,3 :

1 - The user is charged on the 1st day of each debit cycle, except for the first time. If you set this debit in the middle of the month - the charge is pro-rated. The first debit charge is prorated to the time left to the end of the debit cycle. E.g.: enabled - 20 April; frequency - 2 months; price - $6. On 20th of April the first debit charge will be applied. Account will be charged $4 ($3 for May + $1 for ten days of April). The next debit charge ($6) will be applied on 1 June.

2 - On The First Day Of The Month - The user is charged on the 1st day of each debit cycle. If the user signs up for the service in the middle of the month - the charge is not prorated. E.g.: enabled - 20 April; frequency - 2 months; price - $6. On 20 April the first debit charge will be applied. Account will be charged $6. Next $6 charge will occur on 1 June.

3 -Start Right Now - The user is charged on the day the debit was set each debit cycle. E.g.: enabled - 20 April; frequency - 2 months; price - $6. On 20 April the account will be debited $6. Next $6 charge will occur on 20 June, then on 20 August, and so on. )

    boolean:isInfinite - set infinite period expires
    boolean:isInvoice - e-mail invoicing

Response: empty

Example:

<soapenv:Body>
<ns1:monthlyBasedDebit soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices">
<at href="#id0"/>
<accountId xsi:type="xsd:long">1615</accountId>
<amount xsi:type="xsd:double">97.5</amount>
<duration xsi:type="xsd:int">4</duration>
<frequency xsi:type="xsd:int">9</frequency>
<description xsi:type="xsd:string">my description</description>
<note xsi:type="xsd:string">my note</note>
<adminNote xsi:type="xsd:string">admin note</adminNote>
<startOn xsi:type="xsd:int">1</startOn>
<isInfinite xsi:type="xsd:boolean">true</isInfinite>
<isInvoice xsi:type="xsd:boolean">true</isInvoice>
</ns1:monthlyBasedDebit>
<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:AdminServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">admin</login>
<password xsi:type="xsd:string">admin</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:monthlyBasedDebitResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices"/>
</soapenv:Body>

 

Action: billingPeriodBasedDebit

Description: debit account on a regular basis at the beginning of each billing period for extra services you provide.

Parameters:

    AuthToken:at - authentication information
    long:accountId - accountId
    double:amount - amount that you debit the user
    String:description - information or remarks for the user that will help him distinguish this invoice from others.
    String:note - additional information or remarks displayed in the user's invoice in italics
    String:adminNote - additional information or remarks on the debit you've set. This note is available only for admin.

Response: empty

Example:

<soapenv:Body>
<ns1:billingPeriodBasedDebit soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices">
<at href="#id0"/>
<accountId xsi:type="xsd:long">1615</accountId>
<amount xsi:type="xsd:double">33.3</amount>
<description xsi:type="xsd:string">my description 3</description>
<note xsi:type="xsd:string">my note 3</note>
<adminNote xsi:type="xsd:string">admin note 3</adminNote>
</ns1:billingPeriodBasedDebit>
<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:AdminServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">admin</login>
<password xsi:type="xsd:string">admin</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
<soapenv:Body>
<ns1:billingPeriodBasedDebitResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices"/>
</soapenv:Body>

 

Action: addCredit

Description: credits account.

Parameters:

    AuthToken:at - authentication information
    long:accountId - accountId
    double:amount - amount that you credit the account
    String:description - information or remarks for the user that will help him distinguish this invoice from others.
    String:text - comment
    String:id - ID String

Response: empty

Example:

<soapenv:Body>
<ns1:addCredit
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:ns1="AdminServices">
<at href="#id0"/>
<accountId xsi:type="xsd:long">55566</accountId>
<amount xsi:type="xsd:double">100.0</amount>
<description xsi:type="xsd:string">CHECK</description>
<text xsi:type="xsd:string">test</text>
<id xsi:type="xsd:string">1</id>
</ns1:addCredit>
<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:AdminServices">
<accountId xsi:type="xsd:int">1</accountId>
<login xsi:type="xsd:string">admin</login>
<password xsi:type="xsd:string">admin</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
<soapenv:Body>
<ns1:addCreditResponse
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:ns1="AdminServices"/>
</soapenv:Body>

 

Action: getAccounts

Description: returns account Ids.

Parameters:

    AuthToken:at - authentication information

Response: long[]

Example:

<soapenv:Body>
<ns1:getAccounts soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices">
<at href="#id0"/>
</ns1:getAccounts>
<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:AdminServices">
<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:getAccountsResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="AdminServices">
<getAccountsReturn xsi:type="soapenc:Array" soapenc:arrayType="xsd:long[2]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<item>59383</item>
<item>55566</item>
</getAccountsReturn>
</ns1:getAccountsResponse>
</soapenv:Body>

 

Action: searchAccIdBySignupId (H-Sphere 2.5 and up)

Description: searches account Id by signup Id.

Parameters:

    AuthToken:at - authentication information
    long : signupId

Response: String

Example:

<soapenv:Body>
<ns1:searchAccIdBySignupId soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://axis.hsphere.psoft">
<signupId href="#id0"/>
</ns1:searchAccIdBySignupId>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:long"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">13</multiRef>
</soapenv:Body>
<soapenv:Body>
<ns1:searchAccIdBySignupIdResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://axis.hsphere.psoft">
<searchAccIdBySignupIdReturn xsi:type="soapenc:string"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">1396</searchAccIdBySignupIdReturn>
</ns1:searchAccIdBySignupIdResponse>
</soapenv:Body>

 

Action: searchUserIdBySignupId (H-Sphere 2.5 and up)

Description: searches user Id by signup Id.

Parameters:

    AuthToken:at - authentication information
    long : signupId

Response: String

Example:

<soapenv:Body>
<ns1:searchUserIdBySignupId soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://axis.hsphere.psoft">
<signupId href="#id0"/>
</ns1:searchUserIdBySignupId>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:long"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">13</multiRef>
</soapenv:Body>
<soapenv:Body>
<ns1:searchUserIdBySignupIdResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://axis.hsphere.psoft">
<searchUserIdBySignupIdReturn xsi:type="soapenc:string"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">19</searchUserIdBySignupIdReturn>
</ns1:searchUserIdBySignupIdResponse>
</soapenv:Body>

Related Docs:   H-Sphere XML API Reference Javadoc XML API



© Copyright 2017. Parallels Holdings. All rights reserved.