User Manager - GetUserProfile

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

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

Input Parameters

• HostUserName

• HostPassword

• OwnerName - owner name of the user whose profile you want to retrieve

• UserName - user name whose profile you want to retrieve

• OptionalParam 

• GetBillingProfile True/False - True if you want to retrieve billing profile

• Language 
   

Output Parameters

GetUserProfile

• FirstName

• LastName

• EmailAddress

• CountryName

• StateName

• CityName

• StreetAddress

• StreetAddress2

• PostalCode

• PhoneNo

• FaxNo

• Company

• SocialSecurityNo
   

GetUserBillingProfile

• FirstName

• LastName

• BillingEmailAddress

• BillingCountryName

• BillingStateName

• BillingCityName

• BilllingAddress

• ZipCode

• BillingPhoneNo

• BillingFaxNo

• CreditCardType

• ExpiryMonth

• ExpiryYear

• CurrencyName

• CreditCardEnabled - True / False

• Discount

• CreditLimit

Sample Optional Parameters

<Parameters>

<Parameter Name = "GetBillingProfile">True</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/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 /HC7API/UserManager.asmx/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 C# Code

public UserManager.Response GetUserProfile(string strHostUserName, string strHostPassword, 
string strOwnerName, string strUserName)
{
         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 = "GetBillingProfile";
                    xParameter.Attributes.Append(xAttribute);
                    xParameter.InnerText = "True";
                    xOptionalParam.AppendChild(xParameter);
                    .......
                    .......
                    ....... 
                    oResponse = oUser.GetUserProfile(strHostUserName, strHostPassword, strOwnerName,
                    strUserName, OptionalParam);
                    
         } 
         catch
         {
         }
         return oResponse;
}

Sample Response

GetUserProfile
 <Response>           
 <Method>GetUserProfile</Method>
      <Status>true</Status>
      <ErrorCode>74900001</ErrorCode>
      <ErrorDescription>Operation completed successfully.</ErrorDescription>
      <Result>
         <User xmlns="">
            <RecordCount>1</RecordCount> 
               <RecordRow>
                  <FirstName>john</FirstName> 
                  <LastName>wills</LastName> 
                  <EmailAddress>johnwills@yahoo.com</EmailAddress> 
                  <CountryName>United States</CountryName> 
                  <StateName>Alabama</StateName> 
                  <CityName>MyCity</CityName> 
                  <StreetAddress>hno 87,street 2, headlines</StreetAddress> 
                  <StreetAddress2 /> 
                  <PostalCode>3564</PostalCode> 
                  <PhoneNo>2265126</PhoneNo> 
                  <FaxNo/>2265127
                  <Company>MyCompany</Company> 
                  <SocialSecurityNo /> 
               </RecordRow>
                     .......
                     .......
                     ....... 
            </User>
       </Result>
</Response>

GetUserBillingProfile
 <Response>
 <Method>GetUserProfile</Method>
    <Status>true</Status>
    <ErrorCode>74900001</ErrorCode>
    <ErrorDescription>Operation completed successfully.</ErrorDescription>
    <Result>
       <User xmlns="">
          <RecordCount>1</RecordCount>
             <RecordRow>
                <FirstName>john</FirstName> 
                <LastName>wills</LastName>
                <BillingEmailAddress>john@asd.com</BillingEmailAddress>
                <BillingCountryName>United States</BillingCountryName>
                <BillingStateName>Alabama</BillingStateName>
                <BillingCityName>MyCity</BillingCityName>
                <BilllingAddress>hno 87,street 2, headlines</BilllingAddress>
                <ZipCode>23423</ZipCode>
                <BillingPhoneNo>234234</BillingPhoneNo>
                <BillingFaxNo/>234233
                <CreditCardType>master</CreditCardType>
                <ExpiryMonth>5</ExpiryMonth>
                <ExpiryYear>2009</ExpiryYear>
                <CurrencyName>USD</CurrencyName> 
                <CreditCardEnabled>True</CreditCardEnabled>
                <Discount>1.00</Discount> 
                <CreditLimit>1.00</CreditLimit> 
             </RecordRow>
                   .......
                   .......
                   .......
          </User>
       </Result> 
</Response>