CARVIEW |
Topic
- Previous: Reply
- Up: Get Satisfaction Documentation
- Next: Topic Lists
Topics have one of 4 styles: Question, Idea, Problem, and "Talk". They form the basis of all communication that takes place in Get Satisfaction. In the Get Satisfaction API, topics are represented as an Atom feed, with at least 1 entry. This first entry of a topic feed is the content for the topic itself. Every entry after the first is a reply to the original topic. For detailed information, please refer to the annotated sample feed below:
- <feed xmlns="https://www.w3.org/2005/Atom" xmlns:sfn="https://api.getsatisfaction.com/schema/0.1" xmlns:opensearch="https://a9.com/-/spec/opensearch/1.1/" xmlns:thr="https://purl.org/syndication/thread/1.0">
- <id>https://localhost:3000/topics/27521</id>
- <title>how can i delete my company or hide it from the public?</title>
- <updated>2008-02-12T20:25:40Z</updated>
- <published>2007-10-19T16:16:20Z</published>
- <!--
- Paging links:
- Use these links to page through the data set: self, first, last, next, prev
- next or prev will only appear if the page actually exists.
- -->
- <link rel="self" href="https://localhost:3000/topics/27521?page=1" type="application/atom+xml">
- <link rel="first" href="https://localhost:3000/topics/27521?page=1" type="application/atom+xml">
- <link rel="last" href="https://localhost:3000/topics/27521?page=1" type="application/atom+xml">
- <!--
- Navigation links:
- rel=company : The company in which this topic is posted
- rel=replies : The sub-feed that represents all replies to this topic. POST here to create replies
- -->
- <link rel="company" href="https://localhost:3000/companies/4" type="text/html">
- <link rel="replies" href="https://localhost:3000/topics/27521/replies" type="application/atom+xml">
- <!-- Satisfaction specific ID -->
- <sfn:id>27521</sfn:id>
- <entry>
- <id>https://localhost:3000/topics/27521</id>
- <link rel="topic" href="https://localhost:3000/topics/27521" type="application/atom+xml">
- <!-- topic_at_sfn is a link back into the main GetSatisfaction application. -->
- <link rel="topic_at_sfn" href="https://getsatisfaction.com/satisfaction/topics/how_can_i_delete_my_company_or_hide_it_from_the_public" type="text/html">
- <link rel="company" href="https://localhost:3000/companies/4" type="text/html">
- <link rel="replies" href="https://localhost:3000/topics/27521/replies" type="application/atom+xml">
- <sfn:id>27521</sfn:id>
- <title type="carview.php?tsp=html">how can i delete my company or hide it from the public?</title>
- <updated>2008-02-12T20:25:40Z</updated>
- <published>2007-10-19T16:16:20Z</published>
- <author>
- <name>hipperweb</name>
- <uri>https://localhost:3000/people/23891</uri>
- </author>
- <content type="carview.php?tsp=html">
- </content>
- <!-- Topic style: question, idea, problem, or talk -->
- <sfn:topic_style>question</sfn:topic_style>
- <!--
- Additional statistics
- flag_count: The number of Abuse/Spam flags that have been applied to this topic
- reply_count: The number of replies posted to this topic
- follower_count: The number of people actively following the topic
- -->
- <sfn:flag_count>0</sfn:flag_count>
- <sfn:reply_count>10</sfn:reply_count>
- <sfn:follower_count>9</sfn:follower_count>
- <!-- Tags applied to this topic -->
- <sfn:tags>remove company, privacy, public</sfn:tags>
- </entry>
- <!-- All of the following entry elements would be replies to this topic -->
- <entry>...</entry>
- <entry>...</entry>
- <entry>...</entry>
- <entry>...</entry>
- </feed>
Posting Topics
To create a topic on Get Satisfaction, you will post to https://api.getsatisfaction.com/topics with a series of required and optional parameters that will be form-encoded. You can look at https://api.getsatisfaction.com/topics/new to see a mock HTML form that describes the parameters that are available.
The required parameters include:
- topic[company_id]
- The Get Satisfaction specific record ID of the company that you are posting this topic to. The is the <span class="id" /> tag in a company hcard. Use either this option or topic[company_domain] to set the company, but not both.
- topic[company_domain]
- An alternative to using topic[company_id], company_domain allows you to specify the owning company of topic using its name. The companies domain is the first element of the URL path in the main Get Satisfaction API: For example, twitter's address on Get satisfaction is https://getsatisfaction.com/twitter, and its domain is 'twitter', whereas I want sandy's domain is 'iwantsandy'
- topic[style]
- Specifies the topic's style: either question, idea, problem, or answer.
- topic[subject]
- The single-sentence summary of a topic that shows up in topic listings.
- topic[additional_detail]
- A full description of the topic.
The optional parameters include:
- topic[keywords]
- A comma-separated list of tags that are to be associated with topic
- topic[products]
- A comma-separated list of product names that should be associated with this topic
- topic[emotitag][face]
- A value that describes the emoticon face to attach to this topic: one of happy, sad, indifferent, or silly.
- topic[emotitag][feeling]
- A word or two describing in more detail how you are feeling. Examples include anxious, thankful, or frustrated.
- topic[emotitag][intensity]
- A rating of 0-3 that describes the intensity of how you are feeling, 3 being the most intense, 0 being the baseline.
version 4 as of 9 months ago by Scott Fleckenstein
- Previous: Reply
- Up: Get Satisfaction Documentation
- Next: Topic Lists
Docs Navigation
© Copyright 2008 Get Satisfaction. All rights reserved.

Comments