H-Sphere Developer Guide

H-Sphere XML API: MSSQL Services
 

Related Docs:  

• H-Sphere XML API Reference

Actions:

 

Action : addLogin

Description: adds login.

Parameters:

    AuthToken:at - authentication information
    String:loginName - login name
    String:password -login password

Response:empty

Example:

<soapenv:Body>
<ns1:addLogin soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<at href="#id0"/>
<loginname xsi:type="xsd:string">1111login</loginname>
<password xsi:type="xsd:string">1111loginpasw</password>
</ns1:addLogin>
<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:MSSQLServices">
<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:addLoginResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices"/>
</soapenv:Body>

 

Action : addDB

Description: adds database.

Parameters:

    AuthToken:at - authentication information
    String:name -database name
    String:description - database description
    String:owner - database owner
    int:quota - database quota

Response: empty

Example:

<soapenv:Body>
<ns1:addDB soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<at href="#id0"/>
<name xsi:type="xsd:string">1111db</name>
<description xsi:type="xsd:string">my description</description>
<owner xsi:type="xsd:string">1111login</owner>
<quota xsi:type="xsd:int">78</quota>
</ns1:addDB>
<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:MSSQLServices">
<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:addDBResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices"/>
</soapenv:Body>

 

Action: addUser

Description: adds user.

Parameters:

    AuthToken:at - authentication information
    String:databaseName - database name
    String:userLogin - database login
    String:userName - user name

Response: empty

Example:

<soapenv:Body>
<ns1:addUser soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<at href="#id0"/>
<databaseName xsi:type="xsd:string">1111db</databaseName>
<userLogin xsi:type="xsd:string">vovan2</userLogin>
<userName xsi:type="xsd:string">4444usr</userName>
</ns1:addUser>
<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:MSSQLServices">
<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:addUserResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices"/>
</soapenv:Body>

 

Action: changePassword

Description: changes login password.

Parameters:

    AuthToken:at - authentication information
    String:loginName - login name
    String:newPassword - new login password

Response: empty

Example:

<soapenv:Body>
<ns1:changePassword soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<at href="#id0"/>
<name xsi:type="xsd:string">1111login</name>
<newPassword xsi:type="xsd:string">1111login</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:MSSQLServices">
<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:changePasswordResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices"/>
</soapenv:Body>

 

Action: changeQouta

Description : changes database quota

Parameters:

    AuthToken:at - authentication information
    String:name - database name
    double:quota - new quota

Response: empty

Example:

<soapenv:Body>
<ns1:changeQuota soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<at href="#id0"/>
<name xsi:type="xsd:string">1111db</name>
<quota xsi:type="xsd:double">166.0</quota>
</ns1:changeQuota>
<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:MSSQLServices">
<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:changeQuotaResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices"/>
</soapenv:Body>

 

Action: deleteUser

Description: deletes database user.

Parameters:

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

Response: empty

Example:

<soapenv:Body>
<ns1:deleteUser soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<at href="#id0"/>
<userName xsi:type="xsd:string">4444usr</userName>
</ns1:deleteUser>
<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:MSSQLServices">
<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:deleteUserResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices"/>
</soapenv:Body>

 

Action : deleteDB

Description: deletes database.

Parameters:

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

Response: empty

Example:

<soapenv:Body>
<ns1:deleteDB soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<at href="#id0"/>
<name xsi:type="xsd:string">1111db</name>
</ns1:deleteDB>
<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:MSSQLServices">
<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:deleteDBResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices"/>
</soapenv:Body>

 

Action: deleteLogin

Description: deletes login.

Parameters:

    AuthToken:at - authentication information
    String:loginName - login name

Response: empty

Example:

<soapenv:Body>
<ns1:deleteLogin soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<at href="#id0"/>
<loginName xsi:type="xsd:string">1111login</loginName>
</ns1:deleteLogin>
<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:MSSQLServices">
<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:deleteLoginResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices"/>
</soapenv:Body>

 

Action: getLogins

Description: gets all MSSQL logins.

Parameters:

    AuthToken:at - authentication information
String:loginName - login name

Response: Object[ ] - array of MSSQL logins

Example:

<soapenv:Body>
<ns1:getLogins soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<at href="#id0"/>
</ns1:getLogins>
<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:MSSQLServices">
<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:getLoginsResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<getLoginsReturn xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[1]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<item xsi:type="xsd:string">vovan2</item>
</getLoginsReturn>
</ns1:getLoginsResponse>
</soapenv:Body>

 

Action: getDatabases

Description: gets all MSSQL databases.

Parameters:

    AuthToken:at - authentication information

Response: Object[ ] - array of databases

Example:

<soapenv:Body>
<ns1:getDatabases soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<at href="#id0"/>
</ns1:getDatabases>
<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:MSSQLServices">
<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:getDatabasesResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<getDatabasesReturn xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[1]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<item xsi:type="xsd:string">1111db-vovan2</item>
</getDatabasesReturn>
</ns1:getDatabasesResponse>
</soapenv:Body>

 

Action : getUsers

Description: gets all MSSQL users.

Parameters :

    AuthToken:at - authentication information

Response:Object[ ] - array of MSSQL users

Example:

<soapenv:Body>
<ns1:getUsers soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<at href="#id0"/>
</ns1:getUsers>
<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:MSSQLServices">
<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:getUsersResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<getUsersReturn xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[1]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<item xsi:type="xsd:string">4444usr-vovan2</item>
</getUsersReturn>
</ns1:getUsersResponse>
</soapenv:Body>

 

Action : getQuota

Description: gets quota in MB

Parameters:

    AuthToken:at - authentication information
    String:dbName - database name

Response: String : - quota in MB

Example:

<soapenv:Body>
<ns1:getQuota soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<at href="#id0"/>
<dbName xsi:type="xsd:string">1111db-vovan2</dbName>
</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:MSSQLServices">
<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:getQuotaResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MSSQLServices">
<getQuotaReturn xsi:type="xsd:string">100 Mb</getQuotaReturn>
</ns1:getQuotaResponse>
</soapenv:Body>

 

Related Docs:  

• H-Sphere XML API Reference



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