H-Sphere Developer Guide

H-Sphere XML API: FTP Services

 

Related Docs:  

H-Sphere XML API Reference

Actions:

 

Action: ftpUnixVhostAdd

Description: adds a new virtual host

Parameters:

AuthToken:at - authentication information
String:domainName - domain name
String:serverName - server name
String:adminEmail - admin e-mail address

Response: empty

Example:

 <soapenv:Body>
  <ns1:ftpUnixVhostAdd soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovik111.psoft</domainName>
   <serverName xsi:type="xsd:string">VVVserver</serverName>
   <adminEmail xsi:type="xsd:string">test@11.vov</adminEmail>
  </ns1:ftpUnixVhostAdd>
 <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:FtpServices">
   <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:ftpUnixVhostAddResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: ftpWinVhostAdd

Description: adds a new anonymous virtual host for Windows plan

Parameters:

AuthToken:at - authentication information
String:domainName - domain name
int:status - running or stopped
int:upload - enable upload
String:ftpName - name of the server

Response: empty

Example:

 <soapenv:Body>
  <ns1:ftpWinVhostAdd soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">xxxxxx.xx</domainName>
   <status xsi:type="xsd:int">0</status>
   <upload xsi:type="xsd:int">0</upload>
   <ftpName xsi:type="xsd:string">myftp</ftpName>
  </ns1:ftpWinVhostAdd>
  <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:FtpServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">vovtest</login>
   <password xsi:type="xsd:string">vovtest</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:ftpWinVhostAddResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: addVdir

Description: adds a new virtual directory

Parameters:

AuthToken:at - authentication information
String:domainName - domain name
String:vdirName - virtual directory name
int:read - read permision
int:write - write permision
int:list - get list permision
int:forAll - grant permissions to all

Response: empty

Example:

 <soapenv:Body>
  <ns1:addVdir soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovik111.psoft</domainName>
   <vdirName xsi:type="xsd:string">vov111/</vdirName>
   <read xsi:type="xsd:int">1</read>
   <write xsi:type="xsd:int">1</write>
   <list xsi:type="xsd:int">1</list>
   <forAll xsi:type="xsd:int">0</forAll>
  </ns1:addVdir>
  <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:FtpServices">
   <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:addVdirResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: addVdirPerm

Description: adds virtual directory permissions

Parameters:

AuthToken:at - authentication information
String:domainName - domain name
String:vdirName - virtual directory name
String:userName - user name

Response: empty

Example:

 <soapenv:Body>
  <ns1:addVdirPerm soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovik111.psoft</domainName>
   <vdirName xsi:type="xsd:string">vov111/</vdirName>
   <userName xsi:type="xsd:string">admin</userName>
  </ns1:addVdirPerm>
  <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:FtpServices">
   <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:addVdirPermResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: addVuser

Description: adds a virtual user

Parameters:

AuthToken:at - authentication information
String:domainName - domain name
String:userName - user name
String:userPassword - user password

Response: empty

Example:

 <soapenv:Body>
  <ns1:addVuser soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovik111.psoft</domainName>
   <userName xsi:type="xsd:string">newuser</userName>
   <userPassword xsi:type="xsd:string">newuser</userPassword>
  </ns1:addVuser>
  <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:FtpServices">
   <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:addVuserResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: updateVdir

Description: changes virtual directory permissions

Parameters:

AuthToken:at - authentication information
String:domainName - domain name
String:vdirName - virtual directory name
int:read - read permision
int:write - write permision
int:list - get list permision
int:forAll - grant permissions to all

Response: empty

Example:

 <soapenv:Body>
  <ns1:updateVdir soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovik111.psoft</domainName>
   <vdirName xsi:type="xsd:string">vov111/</vdirName>
   <read xsi:type="xsd:int">1</read>
   <write xsi:type="xsd:int">1</write>
   <list xsi:type="xsd:int">1</list>
   <forAll xsi:type="xsd:int">1</forAll>
  </ns1:updateVdir>
  <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:FtpServices">
   <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:updateVdirResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: delVdir

Description: deletes virtual directory. Will be available in H-Sphere 2.5.

Parameters:

AuthToken:at - authentication information
String:domainName - domain name
String:vdirName - virtual directory name

Response: empty

Example:

 <soapenv:Body>
  <ns1:delVdir soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovik111.psoft</domainName>
   <vdirName xsi:type="xsd:string">vov111/</vdirName>
  </ns1:delVdir>
  <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:FtpServices">
   <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:delVdirResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: ftpWinVhostUpdate

Description: updates an anonymous virtual host

Parameters:

AuthToken:at - authentication information
String:domainName - domain name
int:status - running or stopped
int:upload - enable upload
String:ftpName - name of the server

Response: empty

Example:

 <soapenv:Body>
  <ns1:ftpWinVhostUpdate soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">xxxxxx.xx</domainName>
   <status xsi:type="xsd:int">1</status>
   <upload xsi:type="xsd:int">1</upload>
   <ftpName xsi:type="xsd:string">mynewftp</ftpName>
  </ns1:ftpWinVhostUpdate>
  <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:FtpServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">vovtest</login>
   <password xsi:type="xsd:string">vovtest</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:ftpWinVhostUpdateResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: updateVuser

Description: changes user password

Parameters:

AuthToken:at - authentication information
String:domainName - domain name
String:userName - user name
String:newPassword - new password

Response: empty

Example:

 <soapenv:Body>
  <ns1:updateVuser soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovik111.psoft</domainName>
   <userName xsi:type="xsd:string">admin</userName>
   <newPassword xsi:type="xsd:string">newpassword</newPassword>
  </ns1:updateVuser>
  <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:FtpServices">
   <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:updateVuserResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: delVdirPerm

Description: deletes virtual directory permissions for a user

Parameters:

AuthToken:at - authentication information
String:domainName - domain name
String:vdirName - virtual directory name
String:userName - user name

Response: empty

Example:

 <soapenv:Body>
  <ns1:delVdirPerm soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovik111.psoft</domainName>
   <vdirName xsi:type="xsd:string">vov111/</vdirName>
   <userName xsi:type="xsd:string">admin</userName>
  </ns1:delVdirPerm>
  <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:FtpServices">
   <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:delVdirPermResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: enableAnonymous

Description: enables anonymous FTP

Parameters:

AuthToken:at - authentication information
String:domainName - domain name

Response: empty

Example:

 <soapenv:Body>
  <ns1:enableAnonymous soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovik111.psoft</domainName>
  </ns1:enableAnonymous>
  <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:FtpServices">
   <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:enableAnonymousResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: disableAnonymous

Description: disables anonymous FTP

Parameters:

AuthToken:at - authentication information
String:domainName - domain name

Response: empty

Example:

 <soapenv:Body>
  <ns1:disableAnonymous soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovik111.psoft</domainName>
  </ns1:disableAnonymous>
  <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:FtpServices">
   <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:disableAnonymousResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: enableIncoming

Description: enables anonymous FTP Upload Facilities

Parameters:

AuthToken:at - authentication information
String:domainName - domain name

Response: empty

Example:

 <soapenv:Body>
  <ns1:enableIncoming soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovik111.psoft</domainName>
  </ns1:enableIncoming>
  <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:FtpServices">
   <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:enableIncomingResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: disableIncoming

Description: disables anonymous FTP Upload Facilities

Parameters:

AuthToken:at - authentication information
String:domainName - domain name

Response: empty

Example:

 <soapenv:Body>
  <ns1:disableIncoming soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovik111.psoft</domainName>
  </ns1:disableIncoming>
  <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:FtpServices">
   <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:disableIncomingResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices"/>
 </soapenv:Body>

 

Action: getLogin

Description: gets ftp login

Parameters:

AuthToken:at - authentication information

Response: String:login - FTP login

Example:

 <soapenv:Body>
  <ns1:getLogin soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
  </ns1:getLogin>
  <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:FtpServices">
   <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:getLoginResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <getLoginReturn xsi:type="xsd:string">vovan2</getLoginReturn>
  </ns1:getLoginResponse>
 </soapenv:Body>

 

Action: getVhostDirectories

Description: gets all directories of a virtual host

Parameters:

AuthToken:at - authentication information
String:domainName - domain name

Response: Object[ ] - array of directories names

Example:

 <soapenv:Body>
  <ns1:getVhostDirectories soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovikiris.psoft</domainName>
  </ns1:getVhostDirectories>
  <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:FtpServices">
   <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:getVhostDirectoriesResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <getVhostDirectoriesReturn 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">v111/</item>
   </getVhostDirectoriesReturn>
  </ns1:getVhostDirectoriesResponse>
 </soapenv:Body>

 

Action: getVhostUsers

Description: gets all users of a virtual host

Parameters:

AuthToken:at - authentication information
String:domainName - domain name

Response: Object[ ] - array of users

Example:

 <soapenv:Body>
  <ns1:getVhostUsers soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovikiris.psoft</domainName>
  </ns1:getVhostUsers>
  <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:FtpServices">
   <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:getVhostUsersResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <getVhostUsersReturn 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:string">newuser</item>
    <item xsi:type="xsd:string">newuser2</item>
   </getVhostUsersReturn>
  </ns1:getVhostUsersResponse>
 </soapenv:Body>

 

Action: isEnableAnonymous

Description: checks if anonymous FTP is enabled

Parameters:

AuthToken:at - authentication information
String:domainName - domain name

Response: boolean: true - anonymous FTP is enabled, false - anonymous FTP is disabled

Example:

 <soapenv:Body>
  <ns1:isEnableAnonymous soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <at href="#id0"/>
   <domainName xsi:type="xsd:string">vovikiris.psoft</domainName>
  </ns1:isEnableAnonymous>
  <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:FtpServices">
   <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:isEnableAnonymousResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="FtpServices">
   <isEnableAnonymousReturn xsi:type="xsd:boolean">true</isEnableAnonymousReturn>
  </ns1:isEnableAnonymousResponse>
 </soapenv:Body>

 


Related Docs:  

H-Sphere XML API Reference



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