The Kompis project aims to make it easy to for everyone to get home after a night out. We will provide a platform where users can ask for someone to drive them home, or drivers to advertise when they are available.
- Create user :
POST /users→ open endpoint - Authorize :
POST /users/authorize→ open endpoint - Get user :
GET /users/{id:number} - Get current user :
GET /users/current - Delete current user :
DELETE /users/current - Send firebase token :
PUT /users/current/firebase
- Get listings :
GET /listings - Create listing :
POST /listings - Get listing :
GET /listings/{id:number} - Delete listing :
DELETE /listings/{id:number} - Activate listing :
GET /listings/{id:number}/activate - Deactivate listing :
GET /listings/{id:number}/deactivate - Assign current user to listing :
POST /listings/{id:number}/assign - Unassign user from listing :
GET /listings/{id:number}/unassign
POST /usersCreates a new user that can be logged into.
Request
Headers:
Content-Type: application/jsonBody:
{
"email": "[email protected]",
"password": "password",
"displayName": "Roger Doger"
}Responses
200 OKon success
Headers:
Content-Type: application/jsonBody:
{
"id": 1,
"displayName": "Roger Doger"
}409 CONFLICTif a user with the given email exists
POST /users/authorizeReceive authorization for use with endpoints requiring authorization. If the client supports firebase cloud messaging, a token should be provided in the body.
Request
Headers:
Content-Type: application/jsonBody:
{
"email": "[email protected]",
"password": "password",
"firebaseToken": "(optional)"
}Responses
200 OKon success
Headers:
Content-Type: application/json
Authorization: Bearer xxx.yyy.zzzBody:
{
"id": 1,
"displayName": "Roger Doger"
}404 CONFLICTif a user with the given email does not exist403 FORBIDDENif a user with the given email already exist
GET /users/{id:number}Get the user with the given ID.
Request
Headers:
Authorization: Bearer xxx.yyy.zzzResponses
200 OKon success
Headers:
Content-Type: application/json
Authorization: Bearer xxx.yyy.zzzBody:
{
"id": 1,
"displayName": "Roger Doger"
}403 FORBIDDENifAuthorizationheader is invalid404 NOT FOUNDif user with the given id was not found
GET /users/currentGet the current authorized user.
Request
Headers:
Authorization: Bearer xxx.yyy.zzzResponses
200 OKon success
Headers:
Authorization: Bearer xxx.yyy.zzzBody:
{
"id": 1,
"displayName": "Roger Doger"
}403 FORBIDDENifAuthorizationheader is invalid
DELETE /users/currentDelete the current authorized user. All listings where this user is the assignee will be unassigned and all listings where this user is the owner will be deleted.
The client should get rid of the Authorization token manually.
Request
Headers:
Authorization: Bearer xxx.yyy.zzzResponses
200 OKon success
Headers:
Authorization: Bearer xxx.yyy.zzz403 FORBIDDENifAuthorizationheader is invalid
PUT /users/current/firebaseUpdate the firebase token for the current authorized user.
Request
Headers:
Authorization: Bearer xxx.yyy.zzzParameters:
- token - the firebase token assigned to the client of the current authorized user
Responses
200 OKon success
Headers:
Authorization: Bearer xxx.yyy.zzz403 FORBIDDENifAuthorizationheader is invalid
Body:
{
"id": 1,
"displayName": "Roger Doger"
}403 FORBIDDENifAuthorizationheader is invalid
GET /listingsGets a list of all listings.
Request
Headers:
Authorization: Bearer xxx.yyy.zzzResponses
200 OKon success
Headers:
Content-Type: application/json
Authorization: Bearer xxx.yyy.zzzBody:
[
{
"id": 2,
"title": "Need pickup at Oslo",
"driver": false,
"active": true,
"owner": {
"id": 1,
"displayName": "Roger Doger"
},
"location": {
"id": 10,
"latitude": "98.76",
"longitude": "54.32",
"accuracy": "99.1"
},
"assignee": {
"id": 12,
"user": {
"id": 9,
"displayName": "Harry"
},
"location": {
"id": 10,
"latitude": "12.34",
"longitude": "23.45",
"accuracy": "99.1"
}
}
}, ...
]403 FORBIDDENifAuthorizationheader is invalid
POST /listingsCreates a new listing owned by the current logged in user.
Request
Headers:
Content-Type: application/json
Authorization: Bearer xxx.yyy.zzzBody:
{
"title": "Need pickup at Oslo",
"driver": false,
"location": {
"latitude": "98.76",
"longitude": "54.32",
"accuracy": "99.1"
}
}Responses
200 OKon success
Headers:
Content-Type: application/json
Authorization: Bearer xxx.yyy.zzzBody:
{
"id": 2,
"title": "Need pickup at Oslo",
"driver": false,
"active": true,
"owner": {
"id": 1,
"displayName": "Roger Doger"
},
"location": {
"id": 10,
"latitude": "98.76",
"longitude": "54.32",
"accuracy": "99.1"
},
"assignee": null
}403 FORBIDDENifAuthorizationheader is invalid
GET /listings/{id:number}Gets the listing with the given ID.
Request
Headers:
Authorization: Bearer xxx.yyy.zzzResponses
200 OKon success
Headers:
Content-Type: application/json
Authorization: Bearer xxx.yyy.zzzBody:
{
"id": 2,
"title": "Need pickup at Oslo",
"driver": false,
"active": true,
"owner": {
"id": 1,
"displayName": "Roger Doger"
},
"location": {
"id": 10,
"latitude": "98.76",
"longitude": "54.32",
"accuracy": "99.1"
},
"assignee": null
}403 FORBIDDENifAuthorizationheader is invalid404 NOT FOUNDif a listing with the given ID was not found
DELETE /listings/{id:number}Delete the listing with the given ID if it is owned by the current authorized user.
Request
Headers:
Authorization: Bearer xxx.yyy.zzzResponses
200 OKon success
Headers:
Authorization: Bearer xxx.yyy.zzz403 FORBIDDENif the listing is not owned by the current authorized user403 FORBIDDENifAuthorizationheader is invalid404 NOT FOUNDif a listing with the given ID was not found
GET /listings/{id:number}/activateActivate the listing with the given ID if it is owned by the current authorized user.
Request
Headers:
Authorization: Bearer xxx.yyy.zzzResponses
200 OKon success
Headers:
Authorization: Bearer xxx.yyy.zzz403 FORBIDDENif the listing is not owned by the current authorized user403 FORBIDDENifAuthorizationheader is invalid404 NOT FOUNDif a listing with the given ID was not found
GET /listings/{id:number}/deactivateDeactivate the listing with the given ID if it is owned by the current authorized user.
Request
Headers:
Authorization: Bearer xxx.yyy.zzzResponses
200 OKon success
Headers:
Authorization: Bearer xxx.yyy.zzz403 FORBIDDENif the listing is not owned by the current authorized user403 FORBIDDENifAuthorizationheader is invalid404 NOT FOUNDif a listing with the given ID was not found
POST /listings/{id:number}/assignAssign the current logged in user to the listing with the given ID and store the assignees location in the listing.
Request
Headers:
Authorization: Bearer xxx.yyy.zzzBody:
{
"latitude": "12.34",
"longitude": "23.45",
"accuracy": "99.1"
}Responses
200 OKon success
Headers:
Authorization: Bearer xxx.yyy.zzz403 FORBIDDENifAuthorizationheader is invalid404 NOT FOUNDif a listing with the given ID was not found409 CONFLICTif the listing already has an assignee
GET /listings/{id:number}/unassignIf the current authorized user is the owner of the listing with the given ID, the assignee will be removed from the listing. If the current authorized user is assigned to the listing, they will remove themselves from the listing.
Request
Headers:
Authorization: Bearer xxx.yyy.zzzResponses
200 OKon success
Headers:
Authorization: Bearer xxx.yyy.zzz403 FORBIDDENif you either don't own the listing, or are not assigned to the listing403 FORBIDDENifAuthorizationheader is invalid404 NOT FOUNDif a listing with the given ID was not found