User Manager - GetUserProfile

Version: 1

HCnix Build: 3.00 and later

API Build: 1.00 and later

 

User Manager - GetUserProfile  retrieves profile of a specified user. This web service call can be used as http://your-domain.com/HCnixAPI/UserManager.php?op=GetUserProfile.

 

Input Parameters

 

Output Parameters

 

GetUserProfile

 

Sample Optional Parameters

 

<Parameters>

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

</Parameters>

 

Sample SOAP Request

 

 

POST /HCnixAPI/UserManager.php HTTP/1.1

Host: your-domain.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://tempuri.org/GetUserProfile"

<?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>

    <GetUserProfile xmlns="http://tempuri.org/">

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <UserName>john</UserName>

      <OptionalParam>xml</OptionalParam>

    </GetUserProfile>

  </soap:Body>

 </soap:Envelope>

 

 

Sample HTTP Request

 

 

POST /HCnixAPI/UserManager.php/GetUserProfile HTTP/1.1

Host: your-domain.com

Content-Type: application/x-www-form-urlencoded

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&UserName=john&OptionalParam=xml

 

 

Sample PHP Code

 

 

function GetUserProfile($strHostUserName, $strHostPassword, $strOwnerName, $strUserName, $OptionalParam)

{

      $response="";

      $soapPacket = "<?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>

                 <GetUserProfile xmlns=\"http://tempuri.org/\">

                  <HostUserName>$strHostUserName</HostUserName>

                  <HostPassword>$strHostPassword</HostPassword>

        <OwnerName>$strOwnerName</OwnerName>

        <UserName>$strUserName</UserName>

                  <OptionalParam>$OptionalParam</OptionalParam>

                 </GetUserProfile>

           </soap:Body>

        </soap:Envelope>";

        // where $domain_name is where HCnix APIs are installed

        $fp = fsockopen($domain_name, 80, $errNo, $errString, 90);

        if($fp)  

        {

              // where $name is the Virtual Directory name for HCnix APIs              

              $header = "POST /$name/UserManager.php HTTP/1.1\r\n";

              $header .= "HOST: $domain_name\n";

              $header .= "Content-Type: text/xml;charset=\"utf-8\"\r\n";

              $header .= "Content-Length: ".strlen($soapPacket)."\r\n\r\n";

              fwrite($fp, $header.$soapPacket);

        

              while (true)

              {  

                  $buffer = fread($fp, 1000);

                  if( $buffer != "" )

                      $response .= $buffer;  

                  if(strstr($response, '</SOAP-ENV:Envelope>') || $buffer == "" )  

                      break;

                  $buffer = "";  

              }

            fclose($fp);

            $result = explode("<?xml",$response);

            return "<?xml".$result[1];

        }

}

 

 

Sample Response

 

 

GetUserProfile

 <Response>

     <Method>GetUserProfile</Method>

     <Status>true</Status>

     <ErrorCode>74900001</ErrorCode>

     <ErrorDescription>Operation completed successfully.</ErrorDescription>

     <Result>

         <User xmlns="">

            <RecordRow>

                  <FirstName>john</FirstName>

                  <LastName>wills</LastName>

                  <EmailAddress>johnwills@yahoo.com</EmailAddress>

                  <Country>United States</Country>

                  <State>Alabama</State>

                  <City>MyCity</City>

                  <StreetAddress>hno 87,street 2, headlines</StreetAddress>

                  <StreetAddress2 />

                  <PostalCode>3564</PostalCode>

                  <PhoneNo>2265126</PhoneNo>

                  <FaxNo/>2265127

                  <Company>MyCompany</Company>

                  <NationalIdentificationNo />

            </RecordRow>

               .......

               .......

               .......

         </User>

     </Result>

 </Response>