User Manager - GetUsers

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

User Manager - GetUsers retrieves all users under a specified owner. This web service call can be made as http://your-domain.com/HC7API/UserManager.asmx?op=GetUsers.

Input Parameters

• HostUserName

• HostPassword

• OwnerName - user name for which you want to retrieve sub-users

• OptionalParam

• Platform

• UserLevel

• ServerName - server name if you want to retrieve users created on a specified server

• Language
   

Output Parameters

• UserName - login name of the user

• UserLevel

• ServerName - name of the server where this user is actually created
   

Sample Optional Parameters

<Parameters>

<Parameter Name = "Platform">Windows</Parameter>

<Parameter Name = "UserLevel">Reseller</Parameter>

<Parameter Name = "ServerName">abc</Parameter>

<Parameter Name = "Language">French</Parameter>

</Parameters>

Sample SOAP Request

POST /HC7API/UserManager.asmx 
HTTP/1.1 Host: your-domain.com 
Content-Type: text/xml;
charset=utf-8 Content-Length: length
SOAPAction: "http://tempuri.org/GetUsers" 
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
  <soap:Body>
    <GetUsers xmlns="http://tempuri.org/"> 
      <HostUserName>host</HostUserName> 
      <HostPassword>host123</HostPassword>
      <OwnerName>david</OwnerName> 
      <OptionalParam>xml</OptionalParam>
    </GetUsers> 
  </soap:Body> 
</soap:Envelope> 

Sample HTTP Request

POST /HC7API/UserManager.asmx/GetUsers HTTP/1.1
Host: your-domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
HostUserName=host&HostPassword=host123&OwnerName=david&OptionalParam=xml

Sample C# Code

public UserManager.Response GetUsers(string strHostUserName, string strHostPassword, string strOwnerName)
{
         try
         {
                    UserManager.UserManager oUser = new UserManager.UserManager();
                    UserManager.Response oResponse = new UserManager.Response();
                    
                     XmlDocument oDoc = new XmlDocument();
                     //Adding root node
                     XmlNode xOptionalParam = oDoc.CreateNode(XmlNodeType.Element,"Parameters","");
                     //Adding sub nodes
                     XmlNode xParameter = oDoc.CreateNode(XmlNodeType.Element,"Parameter","");
                     XmlAttribute xAttribute = oDoc.CreateAttribute("Name");
                     xAttribute.Value = "Platform";
                     xParameter.Attributes.Append(xAttribute);
                     xParameter.InnerText = "Windows";
                     xOptionalParam.AppendChild(xParameter);
                     .......
                     .......
                     .......
                     oResponse = oUser.GetUsers(strHostUserName, strHostPassword, strOwnerName, OptionalParam);
                    
         } 
         catch
         {
         }
         return oResponse ;
}

Sample Response

<Response> 
    <Method>GetUsers</Method>
    <Status>true</Status>
    <ErrorCode>74900001</ErrorCode>
    <ErrorDescription>Operation completed successfully.</ErrorDescription>
    <Result>
         <Users xmlns="">
           <RecordCount>10</RecordCount>
              <RecordRow>
                 <UserName>johnsmith</UserName>
                 <UserLevel>Reseller</UserLevel>
                 <ServerName>abc</ServerName>
              </RecordRow>
                   .......
                   .......
                   .......
            </Users>
       </Result>
</Response>