Available company list resources
- /companies
- All of the companies in satisfaction
- /people/XXXXX/companies
- All of the companies created by a person
- Example call that represents all of the companies that I have created:
http://api.getsatisfaction.com/people/scott/companies
- /products/XXXXX/topics
- All of the companies associated with a product
- Example call that represents all of the companies are related to the iPod:
http://api.getsatisfaction.com/products/apple_ipod/companies
- /tags/XXXXX/companies
- All of the companies tagged with a given tag
- Example call that represents all internet companies:
http://api.getsatisfaction.com/tags/internet/companies
Available query parameters for company 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 topics using query. please note that this disable the sort parameter
- Example call searching for "AAA":
http://api.getsatisfaction.com/companies?q=AAA
- sort
- Sorts the list of companies returned. Available options include:
- recently_created
- Sorts by the companies most recently created first
- recently_active
- Sorts by the companies most recently posted to first.
- alpha
- Sorts alphabetically.
Sample xhtml response for a company list
- <title>Companies in Satisfaction</title>
-
- <h1>Companies in Satisfaction</h1>
- <ul>
- <li>
- <div id="hcard-audible" class="vcard company">
- <a href="http://localhost:3000/companies/17631" class="fn org url" rel="me">Audible.com</a>
- <span class="id">17631</span>
-
- <a href="/companies/17631/topics" rel="topics">Audible.com's topics</a>
- <a href="/companies/17631/people" rel="people">Audible.com's people</a>
- <a href="/companies/17631/products" rel="products">Audible.com's products</a>
- <a href="/companies/17631/tags" rel="tags">Audible.com's tags</a>
- <a href="http://localhost:3000/audible" class="url" rel="company_at_sfn">Audible.com on Get Satisfaction</a>
- </div>
- </li>
- <li>
- <div id="hcard-XXX" class="vcard company">...</div>
- </li>
- <li>
- <div id="hcard-XXX" class="vcard company">...</div>
- </li>
- <li>
- <div id="hcard-XXX" class="vcard company">...</div>
- </li>
- </ul>
-
- <a href="http://localhost:3000/companies?page=1" rel="self">self</a>
- <a href="http://localhost:3000/companies?page=1" rel="first">first</a>
- <a href="http://localhost:3000/companies?page=2" rel="next">next</a>
- <a href="http://localhost:3000/companies?page=756" rel="last">last</a>
Comments
Please sign in to post a comment.