Browse Source

updated group url

master
Julio Biason 11 years ago
parent
commit
08488da09c
  1. 38
      apiary.apib

38
apiary.apib

@ -106,12 +106,12 @@ Places to have lunch.
## Places [/places/] ## Places [/places/]
Retrieve the list of all places the user has access. This is directly tied Retrieve the list of all places the user has access. This is directly tied
to the Gropu management and will return all the places the user have access to the Group management and will return all the places the user have access
in their groups. in their groups.
### Retrieval [GET] ### Retrieval [GET]
Return the list of all places in the system. Return the list of all places in the system that the user have access.
+ Resquest (application/json) + Resquest (application/json)
@ -214,7 +214,7 @@ Groups are used to combine a group of users and their favorite places. A locatio
will be considered "selected" when all users in that group have voted (or will be considered "selected" when all users in that group have voted (or
abstain in voting). abstain in voting).
## Groups [/groups/] ## Groups [/groups/{token}/]
Group management. Only users with verified accounts can create new groups. Once Group management. Only users with verified accounts can create new groups. Once
a group is created, the user becomes the "maintainer" of the group and only this a group is created, the user becomes the "maintainer" of the group and only this
@ -225,10 +225,6 @@ group.
Return groups in the system. Only groups in which the user belongs will be returned. Return groups in the system. Only groups in which the user belongs will be returned.
+ Request (application/json)
{ "token": "userToken" }
+ Response 200 (application/json) + Response 200 (application/json)
{ "status": "OK", "groups": [{"id": 1, "name": "Group 1"}, { "status": "OK", "groups": [{"id": 1, "name": "Group 1"},
@ -258,7 +254,7 @@ The user will become the maintainer of the group once it is created.
{ "status": "ERROR", "error": "Account not verified" } { "status": "ERROR", "error": "Account not verified" }
## Group management [/group/{groupId}/] ## Group management [/group/{token}/{groupId}/]
Only the maintainer of the group can change the information for the group. As usual, Only the maintainer of the group can change the information for the group. As usual,
only the required fields are necessary. Passing "maintainer" will change the only the required fields are necessary. Passing "maintainer" will change the
@ -271,7 +267,7 @@ maintenance ownership to another user, immediatelly.
+ Request (application/json) + Request (application/json)
{ "token": "userToken", "name": "Group name", "maintainer": "username" } { "name": "Group name", "maintainer": "username" }
+ Response 200 (application/json) + Response 200 (application/json)
@ -293,11 +289,11 @@ maintenance ownership to another user, immediatelly.
{ "status": "ERROR", "error": "New maintaner does not exist" } { "status": "ERROR", "error": "New maintaner does not exist" }
### Adding members [PUT] ### Remove group [DELETE]
+ Request (application/json) + Request (application/json)
{ "token": "userToken", "usernames": ["username"] } { "token": "userToken" }
+ Response 200 (application/json) + Response 200 (application/json)
@ -315,11 +311,13 @@ maintenance ownership to another user, immediatelly.
{ "status": "ERROR", "error": "Group not found" } { "status": "ERROR", "error": "Group not found" }
### Remove group [DELETE] ## Adding other users to the group [/group/{token}/{groupId}/users/]
### Adding members [PUT]
+ Request (application/json) + Request (application/json)
{ "token": "userToken" } { "usernames": ["username"] }
+ Response 200 (application/json) + Response 200 (application/json)
@ -337,7 +335,8 @@ maintenance ownership to another user, immediatelly.
{ "status": "ERROR", "error": "Group not found" } { "status": "ERROR", "error": "Group not found" }
## Users in the group [/group/{groupId}/users/{username}/]
## Users in the group [/group/{token}/{groupId}/users/{username}/]
Manage users in the group. The user (token owner) must be the maintainer of the Manage users in the group. The user (token owner) must be the maintainer of the
group. group.
@ -348,10 +347,6 @@ group.
### Remove user [DELETE] ### Remove user [DELETE]
+ Request (application/json)
{ "token": "userToken" }
+ Response 200 (application/json) + Response 200 (application/json)
{ "status": "OK" } { "status": "OK" }
@ -373,20 +368,17 @@ group.
{ "status": "ERROR", "error": "User is not a member of this group" } { "status": "ERROR", "error": "User is not a member of this group" }
## Places in the group [/group/{groupId}/places/] ## Places in the group [/group/{token}/{groupId}/places/]
The places the group has already selected as their prefered/nearby places The places the group has already selected as their prefered/nearby places
for lunching. for lunching.
+ Parameters + Parameters
+ groupId ... The group ID. + groupId ... The group ID.
+ token ... The user token.
### Retrieve the places for the group [GET] ### Retrieve the places for the group [GET]
+ Request (application/json)
{ "token": "userToken" }
+ Response 200 (application/json) + Response 200 (application/json)
{ "status": "OK", "places": [ {"id": 1, "name": "Place 1", { "status": "OK", "places": [ {"id": 1, "name": "Place 1",

Loading…
Cancel
Save