API - GithubPlanningPoker/Webservice GitHub Wiki
http://ghpp.mikaelec.com/api/help
NB! The current API can be seen here:Values enclosed in [...] refers to variable data.
####VoteValues: 0, half, 1, 2, 3, 5, 8, 13, 20, 40, 100, inf, ?, break
####Create game
Request: /game/
Request Methods:
- POST:
{ "name": "[username]" }
Response: { "success": true, "gameid": "[hash-string]", "userid": "[hash-string]" }
Error: { "success": false, "message": "[error-message]"}
####Get game
Request: /game/[gameid]/
- GET
Response (vote incomplete):
{ "success": true, "title": "[title]", "description": "[description]", "complete": false, "votes": [
{ "name": "[user-name1]", "voted": true },
{ "name": "[user-name2]", "voted": false },
...]}
Response (vote complete):
{ "success": true, "title": "[title]", "description": "[description]", "complete": true, "votes": [
{ "name": "[user-name1]", "vote": "[vote1]" },
{ "name": "[user-name2]", "vote": "[vote2]" },
...]}
Error: { "success": false, "message": "[error-message]"}
####Join game
Request: /game/[gameid]/user/
Request Methods:
- POST:
{ "name": "[username]" }
Response: { "success": true, "userid": "[hash-string]" }
Error: { "success": false, "message": "[error-message]"}
####Kick user
Request: /game/[gameid]/user/[username]/
- DELETE:
{"userid": "[hash-string]"}
Response: { "success": true}
Error: { "success": false, "message": "[error-message]"}
####Description
Request: /game/[gameid]/description/
Request Methods:
- PUT
{ "title": "[title]", "description": "[description]", "userid": "[hash-string]" }
{ "description": "[description]", "userid": "[hash-string]" }
{ "title": "[title]","userid": "[hash-string]" }
Response: { "success": true}
Error: { "success": false, "message": "[error-message]"}
- GET
Response: { "success": true, "title": "[title]", "description": "[description]" }
Error: { "success": false, "message": "[error-message]"}
- DELETE
Response: { "success": true }
Error: { "success": false, "message": "[error-message]"}
####Current votes
Request: /game/[gameid]/vote/
Request Methods:
- GET
- DELETE
{ "userid": "[hash-string]" }
Response (vote incomplete):
{ "success": true, "complete": false, "votes": [
{ "name": "[user-name1]", "voted": true },
{ "name": "[user-name2]", "voted": false },
...]}
Response (vote complete):
{ "success": true, "complete": true, "votes": [
{ "name": "[user-name1]", "vote": "[vote1]" },
{ "name": "[user-name2]", "vote": "[vote2]" },
...]}
Error: { "success": false, "message": "[error-message]"}
####Vote
Request: /game/[gameid]/vote/[userid]/
Request Methods:
- POST:
{ "vote": "[vote]" }
Response: { "success": true }
Error: { "success": false, "message": "[error-message]"}