API Doc
GET Community
-------------
Request:
GET community/{cid}
Parameters:
{cid}: community id
Authentication:
Http basic authentication. Required: valid user that is a member of the requested community
Response:
{
"id":numeric_id_of_community,
"name":"string_community_name",
"description":"string_community_description",
"defaultLat":double_default_latitude,
"defaultLon":double_default_longitude,
"issues":[
{"id":numeric_issue_id,
"topic":
{"id":numeric_topic_id,
"name":"string_topic_name",
"normalIconUrl":"string_absolute_icon_url",
"activeIconUrl":"string_absolute_active_icon_url",
"category":{
"id":numeric_category_id,
"name":"string_category_name"
}
},
"description":"string_issue_description",
"status":numeric_issue_status,
"location":"string_issue_location",
"score":numeric_issue_score,
"votes":numeric_issue_votes,
"stars":numeric_issue_stars,
"creationDate":numeric_creationdate_in_millis,
"modificationDate":numeric_modificationdate_in_millis,
"lat":numeric_issue_latitude,
"lon":numeric_issue_longitude,
"bearing":numeric_issue_bearing,
"hasComments":"boolean_true_if_issue_has_comments"
},
...
]
}
GET Topics By Community
------------------------
Request:
GET topic/list/{cid}
Parameters:
{cid}: community id
Authentication:
Http basic authentication. Required: valid user that is a member of the requested community
Response:
{"topics":
[{"id":numeric_id_of_topic,
"name":"string_name_of_topic",
"normalIconUrl":"string_absolute_url_to_normal_icon",
"activeIconUrl":"string_absolute_url_to_active_icon",
"category": {
"id":numeric_id_of_category,
"name":"string_name_of_category"
}
},
...
]
}
GET list of issues by community
-------------------------------
Request:
GET issue/list/{cid}
Parameters:
{cid}: community id
Authentication:
Http basic authentication. Required: valid user that is a member of the requested community
Reponse:
{"issues":[
{"id":numeric_issue_id,
"topic":
{"id":numeric_topic_id,
"name":"string_topic_name",
"normalIconUrl":"string_absolute_icon_url",
"activeIconUrl":"string_absolute_active_icon_url",
"category":{
"id":numeric_category_id,
"name":"string_category_name"
}
},
"description":"string_issue_description",
"status":numeric_issue_status,
"location":"string_issue_location",
"score":numeric_issue_score,
"votes":numeric_issue_votes,
"stars":numeric_issue_stars,
"creationDate":numeric_creationdate_in_millis,
"modificationDate":numeric_modificationdate_in_millis,
"lat":numeric_issue_latitude,
"lon":numeric_issue_longitude,
"bearing":numeric_issue_bearing,
"hasComments":"boolean_true_if_issue_has_comments"
},
...
]
}
GET comments by issue
---------------------
Request:
GET issue/comments/{iid}
Parameters:
{iid}: issue id
Authentication:
Http basic authentication. Required: valid user that is a member of the community of the requested issue
Response:
{"comments":[
{"id":numeric_id_of_comment,
"reporter":
{"id":numeric_id_of_user,
"userid":"string_userid",
"credit":numeric_credits_of_user,
"location":"string_location_of_user",
"pictureUrl":"string_absolute_url_of_user_picture"},
"description":"string_the_actual_comment",
"creationDate":"numeric_creationdate_of_comment_in_millis"},
...
]
}
GET list of community members
-----------------------------
Request:
user/list/{cid}
Paramers:
{cid}: community id
Authentication:
Http basic authentication. Required: valid user that is a member of the requested community
Response:
{"result":[
{"id":string_id_of_user,
"userid":"string_userid",
"credit":numeric_user_credits,
"location":"string_user_location",
"pictureUrl":"string_absolute_url_of_user_picture"
},
...
]
}
POST new vote for issue
-----------------------
Request:
POST issue/vote/{iid}
Authentication:
Http basic authentication. Required: valid user that is a member of the community of the requested issue.
Parameters:
{iid}: issue id
score: score. vote up = 1. vote down = 0
Response:
{"result":"string_number_of_stars (this vote included)"}
POST new issue
--------------
Request:
POST issue/report/{cid}/{tid}
Parameters:
{cid}: community id
{tid}: topic id
desc: description
uid: user id
lat: latitude
lon: longitude
Authentication:
Http basic authentication. Required: valid user that is a member of the requested community
Response:
{"result":"ok"}