Idea

This is the primary API for the ideas system. Each idea is accessed via /api/idea.

Properties

Complete details in IdeaProperties.

id

The unique id for this idea. It will never change.

object_type

idea.

date_created

A date when the idea was created.

date_updated

A date when the idea was last updated.

user_id

A User id. The unique id of a User that this idea was submitted by.

name

The name of this idea.

description

255 character description of what the user would like to happen.

yes

An integer containing the yes vote count.

skip

An integer containing the count of times this idea was skipped rather than voted on.

currency

An integer indicating the number of crafter points attached to this idea.

locked

A boolean indicating whether or not this idea is locked (aka closed).

locked_status

Must be one of Infeasible Completed Merged or Unlocked.

Relationships

opinions

A list of Opinions users have given for this idea.

Related Objects

user

The User that this idea is owned by.

merged_into

If this idea has been merged into another idea, this object will tell you what idea it was merged into.

Idea Methods

The methods used to fetch and manipulate ideas.

Create Idea

 POST /api/idea
session_id

Required. The unique session id provided by a Session method.

user_id

Required.

name

Required.

description

Required.

Returns:

 {
   "id" : "xxx",
   "name" : "Pink Unicorns",
   "description" : "Pink unicorn pawns would be ideal for any game.",
   ...
 }

Update Idea

 PUT /api/idea/xxx

See Create Idea for details.

Delete Idea

 DELETE /api/idea/xxx
session_id

Required. The unique session id provided by a Session method.

Returns:

 {
   "success" : 1
 }

Fetch Idea

 GET /api/idea/xxx
session_id

Optional. The unique session id provided by a Session method.

_include_relationships

Optional. See "Relationships" in Intro and Idea Relationships above for details.

Returns:

 {
   "id" : "xxx",
   "name" : "Pink Unicorns",
   ...
 }

Fetch Ideas List

 GET /api/idea

 {
  "paging" : { ... },
  "items" : [
    {
            "object_type" : "idea",
            "date_updated" : "2012-07-13T02:59:03+00:00",
            "date_created" : "2012-07-13T02:59:03+00:00",
            "name" : "Pink Unicorns",
            ...
    },
    ...
  ]
 }

Create / Update an Opinion

 POST /api/idea/xxx/opinions
opinion

Required. Must be one of yes or skip.

currency

Optional. An integer representing the number of crafter points you'd like to add to an idea.

next

Optional. A boolean which, if 1, will make this method return the next unvoted idea rather than the current idea that you're voting on.

Logs an opinion and then returns the idea.

Merge Ideas

 POST /api/idea-merge
idea1_id

The id of the idea to become the master idea.

idea2_id

The id of the idea to merge into the master idea.

Returns:

 {
   "success" : 1,
 }

Fetch An Unvoted Idea

 GET /api/idea/get_low_vote

Returns the same as Fetch an Idea.

Lock an Idea

 PUT /api/idea/xxx/lock

Returns:

 {
   "success" : 1,
 }

Unock an Idea

 PUT /api/idea/xxx/unlock

Returns:

 {
   "success" : 1,
 }
^ Back to Top ^