People Lists

People lists are represented as an XHTML unordered list of hCards.

Available people list resources

/people
All of the people in get satisfaction
/companies/XXXXX/people
All of the people who have participated in a given company
Example call that represents all of the people that have been to apple's get satisfaction site: http://api.getsatisfaction.com/companies/apple/people
/companies/XXXXX/employees
All of the people who are employees of a given company
Example call that represents all of the employess of Get Satisfaction: http://api.getsatisfaction.com/companies/satisfaction/employees
/topics/XXXXX/people
All of the people participating in a topic
Example call that shows who has posted in Topic 256: http://api.getsatisfaction.com/topics/256/people

Available query parameters for product lists

limit
used to specify the number of items that will appear within a single page of results for the feed. 30 is the max
page
Scroll the page X of the people list. Pair it with limit.
Example call to show items 15-30 of the people list: http://api.getsatisfaction.com/people?limit=15&page=2
query
q
full text search for people using query. please note that this disables the sort parameter
Example call searching for "scott": http://api.getsatisfaction.com/people?q=scott

Sample xhtml response for a people list


view plaincopy to clipboardprint?
  1. <title>People in Satisfaction</title>  
  2.   
  3. <h1>People</h1>  
  4. <ul>  
  5.   <li>  
  6.     <div class="vcard person">  
  7.       <a href="http://localhost:3000/people/167761" class="fn nickname url">Mr.B</a>    
  8.       <span class="note">the more you learn the less you know</span>  
  9.       <span class="canonical_name">mrb</span>  
  10.     </div>  
  11.   </li>  
  12.   
  13.   <li><div class="vcard person">...</div></li>  
  14.   <li><div class="vcard person">...</div></li>  
  15.   <li><div class="vcard person">...</div></li>  
  16. </ul>  
  17. <a href="http://localhost:3000/people?page=1" rel="self">self</a>  
  18. <a href="http://localhost:3000/people?page=1" rel="first">first</a>  
  19. <a href="http://localhost:3000/people?page=2" rel="next">next</a>  
  20. <a href="http://localhost:3000/people?page=568" rel="last">last</a>  

version 5 as of 2 years ago by Scott Fleckenstein

Comments

Please sign in to post a comment.