Product Lists

Product lists are represented as an unordered list of hProduct items. Please note that hProduct is just a proposal, and while we try to leverage the features of hProduct.

Available product list resources

/products
All of the products in get satisfaction
/companies/XXXXX/products
All of the products related to a given company
Example call that represents all of the products that apple is related to: http://api.getsatisfaction.com/companies/apple/products
/people/XXXXX/products
All of the products created by a person
Example call that represents all of the products that I have created in Get Satisfaction: http://api.getsatisfaction.com/people/scott/products
/topics/XXXXX/products
All of the products associated with a product
/tags/XXXXX/products
All of the products tagged with a given tag
Example call that represents all gaming products: http://api.getsatisfaction.com/tags/gaming/products

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 company list. Pair it with limit.
Example call to show items 30-60 of the companies list: http://api.getsatisfaction.com/companies?limit=30&page=2
query
q
full text search for products using query. please note that this disables the sort parameter
Example call searching for "ipods": http://api.getsatisfaction.com/products?q=ipods
sort
Sorts the list of products returned. Available options include:
recently_created
Sorts by the products most recently created first
popular
most_popular
Sorts by the products linked to the most topics first.
least_popular
Sorts by the products linked to the least topics first.
alpha
Sorts alphabetically.

Sample xhtml response for a product list


view plaincopy to clipboardprint?
  1. <title>Products in Satisfaction</title>  
  2.   
  3. <h1>Products</h1>  
  4. <ul>  
  5.   <li>  
  6.     <div class="hproduct">  
  7.       <a href="http://localhost:3000/companies/1551" class="brand">VMware</a>  
  8.       <a href="http://localhost:3000/products/20461" class="name uri">Fusion</a>  
  9.   
  10.   
  11.     </div>  
  12.   </li>  
  13. </ul>  
  14. <a href="http://localhost:3000/products?page=1" rel="self">self</a>  
  15. <a href="http://localhost:3000/products?page=1" rel="first">first</a>  
  16. <a href="http://localhost:3000/products?page=2" rel="next">next</a>  
  17. <a href="http://localhost:3000/products?page=107" rel="last">last</a>  


version 5 as of 2 years ago by Scott Fleckenstein

Comments

Please sign in to post a comment.