API Guide v2.0

People Search

HTTP Method & URL
GET <base-url>?Type=PeopleSearch&Keyword=<searchstring>&Version=1&Page=<page#>
Parameters
Type <Required> Type of the request resource
Version <Required> API version#
Keyword <Required> Search String
Page <Optional> Page# (starts with 1) of the results. Defaults to 1st page.
Description
Returns the list of all people matching the given search string.
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <TimeStamp> 2008-03-25 05:29:30 GMT </TimeStamp>
  <APIVersion> 1.0 </APIVersion>
  <CurrentPage> 1 </CurrentPage>
  <TotalPages> 20 </TotalPages>
  <PageSize> 10 </PageSize>
  <Users>
    <User>
      <UserName> Joe Doe </UserName>
      <Id>4 </Id>
      <Email> jdoe@mycompany.com </Email>
    </User>
  </Users> 
</Response>

back to top

©2008 Connectbeam, Inc.