API Guide v2.0

Get User

HTTP Method & URL
GET <base-url>?Type=User&Version=1&UserId=<userid>&Photo=Y
Parameters
Type <required> Type of the request resource
Version <required> API version#
UserId <required> UserId
Photo <optional> Y|N — A value of 'Y' means "get the photo image". The ' N' is default. If there is no photo for the user, then the default image is returned in the resultant XML. The photo image will be base64 encoded string (byte array).
Description
Get user information.
Example Response (LOCAL Auth Mode) 
<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <TimeStamp> 2008-03-25 05:29:30 GMT </TimeStamp>
  <APIVersion> 1.0 </APIVersion>
  <User>
    <UserName> Joe Doe </UserName>
    <Id>4 </Id>
    <Email> jdoe@mycompany.com </Email>
    <Expertise>
      <Tag>
        <Keyword> Analytics </Keyword>
        <Id> 36 </Id>
        <Weight> 0 </Weight>
		<DateWeight> 0 </DateWeight>
		<TagCount> 0 </TagCount>
      </Tag>
    </Expertise>
	    <Interests>
      <Tag>
        <Keyword> Cross Country Skiing </Keyword>
        <Id> 46 </Id>
        <Weight> 0 </Weight>
		<DateWeight> 0 </DateWeight>
		<TagCount> 0 </TagCount>
      </Tag>
      <Tag>
        <Keyword>3D Visualization</Keyword>
        <Id> 47 </Id>
        <Weight> 0 </Weight>
		<DateWeight> 0 </DateWeight>
		<TagCount> 0 </TagCount>
      </Tag>
	    </Interests>
	    <Projects>
      <Tag>
        <Keyword> Cloud Computing </Keyword>
        <Id>106 </Id>
        <Weight> 0 </Weight>
		<DateWeight> 0 </DateWeight>
		<TagCount> 0 </TagCount>
      </Tag>
    </Projects>
	<AuthMode> LOCAL </AuthMode>
    <Profile>
    <Field_Label> Timezone </Field_Label>
    <Field_Value> (GMT:-8.0) America/Los_Angeles </Field_Value>
    <Field_Label> Title </Field_Label>
    <Field_Value> Sales Engineer </Field_Value>
    <Field_Label> Direct </Field_Label>
    <Field_Value> </Field_Value>
    <Field_Label> Direct </Field_Label>
    <Field_Value> </Field_Value>
    <Field_Label> Mobile </Field_Label>
    <Field_Value> 700-700-7000</Field_Value>
    <Field_Label> Fax </Field_Label>
    <Field_Value> 600-600-6000</Field_Value>
    <Field_Label> Department </Field_Label>
    <Field_Value> </Field_Value>
    <Field_Label> DepartmentURL</Field_Label>
    <Field_Value> </Field_Value>
    <Field_Label> Building </Field_Label>
    <Field_Value> </Field_Value>
    <Field_Label> Street </Field_Label>
    <Field_Value> </Field_Value>
    <Field_Label> City </Field_Label>
    <Field_Value> </Field_Value>
    <Field_Label> Zip </Field_Label>
    <Field_Value> </Field_Value>
    <Field_Label> State </Field_Label>
    <Field_Value> </Field_Value>
    <Field_Label> Country </Field_Label>
    <Field_Value> </Field_Value>
    </Profile>
    <Image>
    .....
    </Image>
  </User>
</Response>
Example Response (LDAP/AD Auth Mode) 
<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <TimeStamp> 2008-03-25 05:29:30 GMT </TimeStamp>
  <APIVersion> 1.0 </APIVersion>
  <User>
    <UserName> Joe Doe </UserName>
    <Id>4 </Id>
    <Email> jdoe@mycompany.com </Email>
    <Expertise>
      <Tag>
        <Keyword> Analytics </Keyword>
        <Id> 36 </Id>
        <Weight> 0 </Weight>
		<DateWeight> 0 </DateWeight>
		<TagCount> 0 </TagCount>
      </Tag>
    </Expertise>
	    <Interests>
      <Tag>
        <Keyword> Cross Country Skiing </Keyword>
        <Id> 46 </Id>
        <Weight> 0 </Weight>
		<DateWeight> 0 </DateWeight>
		<TagCount> 0 </TagCount>
      </Tag>
      <Tag>
        <Keyword>3D Visualization</Keyword>
        <Id> 47 </Id>
        <Weight> 0 </Weight>
		<DateWeight> 0 </DateWeight>
		<TagCount> 0 </TagCount>
      </Tag>
	    </Interests>
	    <Projects>
      <Tag>
        <Keyword> Cloud Computing </Keyword>
        <Id>106 </Id>
        <Weight> 0 </Weight>
		<DateWeight> 0 </DateWeight>
		<TagCount> 0 </TagCount>
      </Tag>
    </Projects>
	<AuthMode> LDAP </AuthMode>
    <Profile>
    <Field_Label> (label as assigned by the administrator) </Field_Label>
	<Field_Value> (corresponding value)  </Field_Value>
	<Field_Label> (label as assigned by the administrator) </Field_Label>
    <Field_Value> (corresponding value) </Field_Value>
	...
	...
	<Field_Label> (label as assigned by the administrator) </Field_Label>
    <Field_Value> (corresponding value) </Field_Value>
    </Profile>
    <Image>
    .....
    </Image>
  </User>
</Response>
Changes from v1.0
  • This API now supports LDAP/AD (Active Directory).
  • The response has been updated to reflect the additional LDAP/AD support
  • A parameter to retrieve the user image has been added.
  • UserTags has been renamed to Expertise
  • Tag fields for Interests and Projects have been added
  • The format of the <Profile> section is the same for LDAP, AD, or LOCAL authentication mode. If LOCAL, the values are retrieved from the internal Connectbeam database running on the appliance. For LDAP/AD, the field labels and corresponding values are returned in the same order that the Connectbeam administrator has specified in the profile mapping configuration of the appliance.
  • AuthMode field has been added with the possible value of LOCAL, LDAP, or Active Directory
Notes
  • All elements under profile (e.g., Department) are optional. If a particular value does not exist, then the value will be returned as empty.
    • For example: <Filed5_Value> </Field5_Value>
Returns
HTTP Status Code:  200 (success) or 400 (bad request)

back to top

©2008 Connectbeam, Inc.