Skip to content

Latest commit

 

History

History
380 lines (328 loc) · 9.02 KB

README.md

File metadata and controls

380 lines (328 loc) · 9.02 KB
Raw

StortkApp

Collaborators:

Johannes Ernstsen, Mathias Søby Jensen & Morten Erfurt Hansen

Intent

This is a simple Android application built for a project for the course Interactive Systems which is a part of Computer Science at The University of Aarhus.

The application should be run on Android. It communicates with the server, which can be found here

Be aware that the hardcoded URL that can be found is down atm, and probably wont be up again.

REPO RULES

  • Remember commiting after EACH change as to maintain a good gitlog
    • Provide good and descriptive commit messages
  • Remember to update Trello board with new tasks as you go
  • Remember to update Trello board upon completion of task
  • Maintain conventions and use ctrl+alt+l to reformat code
    • Don't be an idiot

REST API

Log in

Logs the user in

key value
Type POST
Path /login
Params None
Body Json object LoginRequest
Resp Json object LoginRequest
Code 200/404/500/

Example body:

{
  "mail": "[email protected]",
  "password": "kodeord1"
}

Example response:

{
  "mail": "[email protected]",
  "password": "kodeord1",
  "sessionId": "e7d35d2d-9521-4aa9-a6c5-dc4b08aaf638",
  "userId" : 1
}

Log out

Logs the user out

key value
Type POST
Path /logout
Params None
Body Json object LogoutRequest
Resp Json with success boolean
Code 200/404/500/

Example body:

{
  "success": false,
  "sessionId": "e7d35d2d-9521-4aa9-a6c5-dc4b08aaf638",
  "userId": 1
}

Example response:

{
  "success": true,
  "userId": 1
}

Register new user

Registers new user

key value
Type POST
Path /register
Params None
Body Json object RegisterUserRequest
Resp Json object RegisterUserRequest
Code 201/404/500/

Example body:

{
  "name": "Johannes Ernstsen",
  "password": "password1",
  "mail": "[email protected]"
}

Example response:

{
  "name": "Johannes Ernstsen",
  "password": "password1",
  "mail": "[email protected]",
  "userId": 1,
  "sessionId": "e7d35d2d-9521-4aa9-a6c5-dc4b08aaf638"
}

Update location

Updates the users location on the server

key value
Type POST
Path /updateLocation
Params None
Body Json object UpdateLocationRequest
Resp None
Code 202/404/500/

Example body:

{
  "userId": 1,
  "sessionId": "e7d35d2d-9521-4aa9-a6c5-dc4b08aaf638",
  "location": {
    "longtitude": 1.0,
    "lattitude": 2.0,
    "timeStamp": 1512041409284
  }
}

Change Friend

Adds or removes a friend

key value
Type POST
Path /friend
Params None
Body Json object FriendChangeRequest
Resp None
Code 201/404/500/

Example body:

{
  "action": "ADD",
  "userId": 1,
  "sessionId": "e7d35d2d-9521-4aa9-a6c5-dc4b08aaf638",
  "friends": [
    2,
    3
  ]
}

Change User

Adds or removes a friend

key value
Type POST
Path /changeUser
Params None
Body Json object ChangeUserRequest
Resp Json object ChangeUserRequest
Code 201/404/500/

Example body:

{
  "sessionId": "Sesh",
  "userId": 2,
  "name": "Morten",
  "password": "Kode",
  "newPassword": "nyKode"
}

Example response:

{
  "sessionId": "NYSesh",
  "userId": 2,
  "name": "Morten",
  "password": "nyKode",
  "newPassword": ""
}

Change group activation status

A****ctivates or Deactivates a group

key value
Type POST
Path /changeGroupActivation
Params None
Body Json object GroupChangeActivationRequest
Code 201/404/500/

Example body:

{
  "userId": 1,
  "sessionId": "f373e354-ab5f-41bc-8905-14e4dfd5f9ef",
  "add": [
    1,
    2
  ],
  "remove": [
    2,
    3
  ]
}

Change group

Create or update group

key value
Type POST
Path /changeGroup
Params None
Body Json object ChangeGroupRequest
Code 201/403/404/500/

Example body 1:

{
  "id": 0,
  "name": "Min første gruppe",
  "userId": 1,
  "sessionId": "65a3ca2a-e2ee-4040-91a8-db8581a75e4c",
  "add": [
    2,
    3,
    4
  ]
}

Example body 2:

{
  "id": 3,
  "userId": 1,
  "sessionId": "65a3ca2a-e2ee-4040-91a8-db8581a75e4c",
  "remove": [
    4
  ]
}

Get User

Gets the user information from the server

key value
Type GET
Path /getUser
Params sessionId, userId
Resp Json object UserObject
Code 200/403/404/500/

Example Response:

{
  "userId": 1,
  "name": "Johannes Ernstsen",
  "mail": "[email protected]",
  "sessionId": "e7d35d2d-9521-4aa9-a6c5-dc4b08aaf638"
}

Get Locations

Gets locations for all group members

key value
Type GET
Path /getLocations
Params sessionId, userId
Resp Json object LocationsResponse
Code 200/404/500/

Example Response:

{
  "locations": {
    "Søby": {
      "longtitude": 3.8,
      "lattitude": 4.5,
      "timeStamp": 1512050488140
    },
    "Morten": {
      "longtitude": 1.7,
      "lattitude": 2.3,
      "timeStamp": 1512050488140
    }
  }
}

Get Friends

Gets friends for supplied user

key value
Type GET
Path /getFriends
Params sessionId, userId
Resp Json object UsersResponse
Code 200/404/500/

Example Response:

{
  "locations": {
    "Søby": {
      "longtitude": 3.8,
      "lattitude": 4.5,
      "timeStamp": 1512050488140
    },
    "Morten": {
      "longtitude": 1.7,
      "lattitude": 2.3,
      "timeStamp": 1512050488140
    }
  }
}

Get Users

Get all users name and email for use in searches

key value
Type GET
Path /getUsers
Params
Resp Json object UsersResponse
Code 200/404/500/

Example Response:

{
    "users": [
        {
            "userId": 1,
            "name": "Johannes",
            "mail": "[email protected]"
        },
        {
            "userId": 2,
            "name": "Morten",
            "mail": "[email protected]"
        },
        {
            "userId": 3,
            "name": "Mathias",
            "mail": "[email protected]"
        }
    ]
}