-
Auth
-
POST /token
Request Body
{ username: '', password: '' }
Response Body
{ token: '' }
-
-
User
-
GET /user
Response Body
[ { "id": 1, "fullname": "John", "username": "john", "createdAt": "2016-11-07T00:19:04.459Z", "updatedAt": "2016-11-07T00:19:04.459Z" } ]
-
GET /user/:_id
Parameters
_id | String | User's _id
Response Body
{ "id": 1, "fullname": "John", "username": "john", "createdAt": "2016-11-07T00:19:04.459Z", "updatedAt": "2016-11-07T00:19:04.459Z" }
-
POST /user
Request Body
{ "fullname": "John", "username": "john", "password": "#######", "role": "colaborator" }
Response Body
{ "fullname": "John", "username": "john", "role": "colaborator" }
-
PUT /user/:_id
Parameters
_id | String | Users's _id
Request Body
{ "fullname": "John", "username": "john", "password": "#######" }
Response Body
{ "fullname": "John", "username": "john" }
-
DELETE /user/:_id
Parameters
_id | String | User's _id
Response Body
{ "message": "Deleted successfully" }
-
DELETE /user
Response Body
{ "message": "Deleted successfully" }
-
-
Review
-
GET /review
Response Body
[ { "id": 53, "rating": 3, "hour": "16:35:28", "date": "2016-11-26T00:00:00.000Z", "createdAt": "2016-11-26T16:35:28.768Z", "updatedAt": "2016-11-26T16:35:28.768Z", "idLocal": 1123, "Tags": [ { "id": 1, "name": "Iluminado", "createdAt": "2016-11-08T14:56:40.207Z", "updatedAt": "2016-11-08T14:56:40.207Z", "Review_Tags": { "createdAt": "2016-11-26T16:35:29.091Z", "updatedAt": "2016-11-26T16:35:29.091Z", "review_id": 53, "tag_id": 1 } } ] } ]
-
GET /review/:_id
Parameters
_id | String | Review's _id
Response Body
[ { "id": 53, "rating": 3, "hour": "16:35:28", "date": "2016-11-26T00:00:00.000Z", "createdAt": "2016-11-26T16:35:28.768Z", "updatedAt": "2016-11-26T16:35:28.768Z", "idLocal": 1123, "Tags": [ { "id": 1, "name": "Iluminado", "createdAt": "2016-11-08T14:56:40.207Z", "updatedAt": "2016-11-08T14:56:40.207Z", "Review_Tags": { "createdAt": "2016-11-26T16:35:29.091Z", "updatedAt": "2016-11-26T16:35:29.091Z", "review_id": 53, "tag_id": 1 } } ] } ]
-
POST /review
Request Body
{ "rating": 3, "idLocal": 1123, "Tags": [ { "id": 1, } ] }
Response Body
{ "rating": 3, "hour": "16:35:28", "date": "2016-11-26T00:00:00.000Z", "idLocal": 1123, "Tags": [ { "id": 1, } ] }
-
DELETE /review/:_id
Parameters
_id | String | Review's _id
Response Body
{ "message": "Deleted successfully" }
-
-
Local
-
GET /local
Response Body
[ { "address": "Largo Prof. Francisco de Paula Brochado Rocha - Farroupilha, Porto Alegre - RS, 90040-080, Brasil" "average": "4.0000000000000000" "checkins": "0" "createdAt": "2016-11-19T14:23:55.454Z" "description": "Perto do parquinho das crianças e do café." "id": 921 "isPublic": true "lat": "-30.0358392" "lng": "-51.2178544" "photo": "https://s3.amazonaws.com/bikedeboa/images/921.jpeg" "reviews": "1" "structureType": "deroda" "text": "Redenção" "updatedAt": "2016-12-17T19:43:23.982Z" } ]
-
GET /local/:_id
Parameters
_id | String | Local's _id
Response Body
{ "id": 1123, "lat": "-30.037524579889894", "lng": "-51.2110917075396", "structureType": "deroda", "isPublic": true, "text": "Prato Verde", "photo": "https://s3.amazonaws.com/bikedeboa/images/1123.jpeg", "description": "Próximo a garagem", "address": "Rua Santa Terezinha, 50 - Farroupilha, Porto Alegre - RS, 90040-180, Brasil", "reviews": "1", "average": "5.000000", "tags": [ { "name": "Fácil acesso", "count": "1" }, { "name": "Iluminado", "count": "1" }, { "name": "Movimentado", "count": "1" } ] }
-
GET /local/light
Response Body
[ { "average": "4.0000000000000000" "id": 931 "isPublic": true "lat": "-30.037464" "lng": "-51.212618" "photo": "https://s3.amazonaws.com/bikedeboa/images/931.jpeg" "reviews": "1" "structureType": "deroda" "text": "Academia da Redenção" } ]
-
POST /local
Request Body
{ "lat": "-30.037524579889894", "lng": "-51.2110917075396", "structureType": "deroda", "isPublic": true, "text": "Prato Verde", "photo": (blob64), "authorIP": "199.199.99.9", "description": "Próximo a garagem.", "address": "Rua Santa Terezinha, 50 - Farroupilha, Porto Alegre - RS, 90040-180, Brasil" }
Response Body
{ "id": 1123, "lat": "-30.037524579889894", "lng": "-51.2110917075396", "structureType": "deroda", "isPublic": true, "text": "Prato Verde", "photo": "https://s3.amazonaws.com/bikedeboa/images/1123.jpeg", "authorIP": "199.199.99.9", "description": "Próximo a garagem.", "address": "Rua Santa Terezinha, 50 - Farroupilha, Porto Alegre - RS, 90040-180, Brasil", "reviews": "0", "checkins": "0", "tags": [] }
-
PUT /local/:_id
Parameters
_id | String | Local's _id
Request Body
{ "id": "1123", "lat": "-30.037524579889894", "lng": "-51.2110917075396", "structureType": "deroda", "isPublic": true, "text": "Prato Verde", "photo": (blob64), "description": "Próximo a garagem", "address": "Rua Santa Terezinha, 50 - Farroupilha, Porto Alegre - RS, 90040-180, Brasil", "photoUrl": "(url photo update)" }
Response Body
{ "lat": "-30.037524579889894", "lng": "-51.2110917075396", "structureType": "deroda", "isPublic": true, "text": "Prato Verde", "photo": "https://s3.amazonaws.com/bikedeboa/images/1123.jpeg", "description": "Próximo a garagem.", "address": "Rua Santa Terezinha, 50 - Farroupilha, Porto Alegre - RS, 90040-180, Brasil", "tags": [ { "name": "Espaçoso", "count": "1" }, { "name": "Fácil acesso", "count": "1" }, { "name": "Movimentado", "count": "1" } ] }
-
DELETE /local/:_id
Parameters
_id | String | Local's _id
Response Body
{ "message": "Deleted successfully" }
-
-
Checkin
-
GET /checkin
Response Body
[ { "id": 1, "date": "2016-11-30T00:00:00.000Z", "hour": "10:45:56", "createdAt": "2016-11-30T12:45:56.046Z", "updatedAt": "2016-11-30T12:45:56.046Z", "local_id": 1 } ]
-
GET /checkin/:_id
Parameters
_id | String | Checkin's _id
Response Body
{ "id": 1, "date": "2016-11-30T00:00:00.000Z", "hour": "10:45:56", "createdAt": "2016-11-30T12:45:56.046Z", "updatedAt": "2016-11-30T12:45:56.046Z", "local_id": 1 }
-
POST /checkin
Request Body
{ "local_id": 1 }
Response Body
{ "id": 1, "date": "2016-11-30T00:00:00.000Z", "hour": "10:45:56", "createdAt": "2016-11-30T12:45:56.046Z", "updatedAt": "2016-11-30T12:45:56.046Z", "local_id": 1 }
-
-
Tag
-
GET /local
Response Body
[ { "address": "Largo Prof. Francisco de Paula Brochado Rocha - Farroupilha, Porto Alegre - RS, 90040-080, Brasil" "average": "4.0000000000000000" "checkins": "0" "createdAt": "2016-11-19T14:23:55.454Z" "description": "Perto do parquinho das crianças e do café." "id": 921 "isPublic": true "lat": "-30.0358392" "lng": "-51.2178544" "photo": "https://s3.amazonaws.com/bikedeboa/images/921.jpeg" "reviews": "1" "structureType": "deroda" "text": "Redenção" "updatedAt": "2016-12-17T19:43:23.982Z" } ]
-
GET /local/:_id
Parameters
_id | String | Local's _id
Response Body
{ "id": 1123, "lat": "-30.037524579889894", "lng": "-51.2110917075396", "structureType": "deroda", "isPublic": true, "text": "Prato Verde", "photo": "https://s3.amazonaws.com/bikedeboa/images/1123.jpeg", "description": "Próximo a garagem", "address": "Rua Santa Terezinha, 50 - Farroupilha, Porto Alegre - RS, 90040-180, Brasil", "reviews": "1", "average": "5.000000", "tags": [ { "name": "Fácil acesso", "count": "1" }, { "name": "Iluminado", "count": "1" }, { "name": "Movimentado", "count": "1" } ] }
-
POST /local
Request Body
{ "lat": "-30.037524579889894", "lng": "-51.2110917075396", "structureType": "deroda", "isPublic": true, "text": "Prato Verde", "photo": (blob64), "authorIP": "199.199.99.9", "description": "Próximo a garagem.", "address": "Rua Santa Terezinha, 50 - Farroupilha, Porto Alegre - RS, 90040-180, Brasil" }
Response Body
{ "id": 1123, "lat": "-30.037524579889894", "lng": "-51.2110917075396", "structureType": "deroda", "isPublic": true, "text": "Prato Verde", "photo": "https://s3.amazonaws.com/bikedeboa/images/1123.jpeg", "authorIP": "199.199.99.9", "description": "Próximo a garagem.", "address": "Rua Santa Terezinha, 50 - Farroupilha, Porto Alegre - RS, 90040-180, Brasil", "reviews": "0", "checkins": "0", "tags": [] }
-
PUT /local/:_id
Parameters
_id | String | Local's _id
Request Body
{ "id": "1123", "lat": "-30.037524579889894", "lng": "-51.2110917075396", "structureType": "deroda", "isPublic": true, "text": "Prato Verde", "photo": (blob64), "description": "Próximo a garagem", "address": "Rua Santa Terezinha, 50 - Farroupilha, Porto Alegre - RS, 90040-180, Brasil", "photoUrl": "(url photo update)" }
Response Body
{ "lat": "-30.037524579889894", "lng": "-51.2110917075396", "structureType": "deroda", "isPublic": true, "text": "Prato Verde", "photo": "https://s3.amazonaws.com/bikedeboa/images/1123.jpeg", "description": "Próximo a garagem.", "address": "Rua Santa Terezinha, 50 - Farroupilha, Porto Alegre - RS, 90040-180, Brasil", "tags": [ { "name": "Espaçoso", "count": "1" }, { "name": "Fácil acesso", "count": "1" }, { "name": "Movimentado", "count": "1" } ] }
-
DELETE /local/:_id
Parameters
_id | String | Local's _id
Response Body
{ "message": "Deleted successfully" }
-
-
Revision
-
GET /revision
Response Body
[ { "id": 2, "comments": "Teste", "createdAt": "2016-12-29T21:51:00.540Z", "updatedAt": "2016-12-29T21:51:00.540Z", "local_id": 921, "Local": { "id": 921, "lat": "-30.0358392", "lng": "-51.2178544", "structureType": "deroda", "isPublic": true, "text": "Redenção", "photo": "url", "description": "Perto do parquinho das crianças e do café.", "address": "Largo Prof. Francisco de Paula Brochado Rocha - Farroupilha, Porto Alegre - RS, 90040-080, Brasil", "createdAt": "2016-11-19T14:23:55.454Z", "updatedAt": "2016-12-17T19:43:23.982Z" } } ]
-
GET /revision/:_id
Parameters
_id | String | Revision's _id
Response Body
{ "id": 2, "comments": "Teste", "createdAt": "2016-12-29T21:51:00.540Z", "updatedAt": "2016-12-29T21:51:00.540Z", "local_id": 921, "Local": { "id": 921, "lat": "-30.0358392", "lng": "-51.2178544", "structureType": "deroda", "isPublic": true, "text": "Redenção", "photo": "url", "description": "Perto do parquinho das crianças e do café.", "address": "Largo Prof. Francisco de Paula Brochado Rocha - Farroupilha, Porto Alegre - RS, 90040-080, Brasil", "createdAt": "2016-11-19T14:23:55.454Z", "updatedAt": "2016-12-17T19:43:23.982Z" } }
-
POST /revision
Request Body
{ "local_id": 10, "comments": "Message for revision" }
-
PUT /revision/:_id
Parameters
_id | String | Revision's _id
Request Body
{ "comments": "Message for revision" }
Response Body
{ "id": 1, "local_id": 10, "comments": "Message for revision", "createdAt": "2016-11-08T14:56:40.207Z", "updatedAt": "2016-11-08T14:56:40.207Z" }
-
DELETE /revision/:_id
Parameters
_id | String | Revision's _id
Response Body
{ "message": "Deleted successfully" }
-
-
Log
-
GET /log/:_page
Parameters
_page | String | Log's _page
Response Body
{ "result": [ { "id": 1, "user": "pedro", "role": "admin", "endpoint": "http://url.com/local", "body": {}, "method": "GET", "createdAt": "2016-12-23T18:30:44.618Z", "updatedAt": "2016-12-23T18:30:44.618Z" }, { "id": 2, "user": "pedro", "role": "colaborator", "endpoint": "http://url.com/local", "body": {}, "method": "GET", "createdAt": "2016-12-23T18:33:15.053Z", "updatedAt": "2016-12-23T18:33:15.053Z" } ], "count": 2, "pages": 1 }
-