This is the primary API for the ideas system.
Each idea is accessed via /api/idea.
Complete details in IdeaProperties.
The unique id for this idea. It will never change.
idea.
A date when the idea was created.
A date when the idea was last updated.
A User id. The unique id of a User that this idea was submitted by.
The name of this idea.
255 character description of what the user would like to happen.
An integer containing the yes vote count.
An integer containing the count of times this idea was skipped rather than voted on.
An integer indicating the number of crafter points attached to this idea.
A boolean indicating whether or not this idea is locked (aka closed).
Must be one of Infeasible Completed Merged or Unlocked.
The User that this idea is owned by.
If this idea has been merged into another idea, this object will tell you what idea it was merged into.
The methods used to fetch and manipulate ideas.
POST /api/idea
Required. The unique session id provided by a Session method.
Required.
Required.
Required.
Returns:
{
"id" : "xxx",
"name" : "Pink Unicorns",
"description" : "Pink unicorn pawns would be ideal for any game.",
...
}
PUT /api/idea/xxx
See Create Idea for details.
DELETE /api/idea/xxx
Required. The unique session id provided by a Session method.
Returns:
{
"success" : 1
}
GET /api/idea/xxx
Optional. The unique session id provided by a Session method.
Optional. See "Relationships" in Intro and Idea Relationships above for details.
Returns:
{
"id" : "xxx",
"name" : "Pink Unicorns",
...
}
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",
...
},
...
]
}
POST /api/idea/xxx/opinions
Required. Must be one of yes or skip.
Optional. An integer representing the number of crafter points you'd like to add to an idea.
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.
POST /api/idea-merge
The id of the idea to become the master idea.
The id of the idea to merge into the master idea.
Returns:
{
"success" : 1,
}
GET /api/idea/get_low_vote
Returns the same as Fetch an Idea.
PUT /api/idea/xxx/lock
Returns:
{
"success" : 1,
}
PUT /api/idea/xxx/unlock
Returns:
{
"success" : 1,
}