"Hold That Thought" (HTT)

Motion-based Mind Palace generation for memorisation assistance - a BSc Computer Science dissertation (2018-19)
Demo: https://youtu.be/RwE5stBE0IA
A RESTful service for CRUD operations on Mind Palace project data.
Service URL: https://mindpalaceservice.herokuapp.com/

REST API

The following endpoints have been implemented

GET /users
GET /palaces
GET /notes
GET /user/<user_id>
GET /userbyusername/<user_username>
GET /palace/<palace_id>
GET /palacesbyuser
GET /note/<note_id>
GET /notesbypalace/<palace_id>
GET /nearestnote/<palace_id>
GET /unrememberednotes
GET /progress
POST /newuser
POST /newpalace
POST /newnote
POST /updatenotestatus/<note_id>
DELETE /user/<user_id>
DELETE /userbyusername/<user_username>
DELETE /palace/<palace_id>
DELETE /note/<note_id>

More detail below:

USERS

List all users

Definition

GET /users

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

[
  {
    "user_id": 1, 
    "user_name": "Chris Davies", 
    "user_password": "pass", 
    "user_username": "cjd47"
  }, 
  {
    "user_id": 2, 
    "user_name": "James Armitstead", 
    "user_password": "pass", 
    "user_username": "ja336"
  }, 
  {
    "user_id": 3, 
    "user_name": "Jamie Thompson", 
    "user_password": "pass", 
    "user_username": "jt554"
  }
]

CURL Command

curl -i -H "Accept: application/json" -H "Content-Type: application/json" https://mindpalaceservice.herokuapp.com/users

Get existing user details

Definition

GET /user/<user_id:integer>

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

[
  {
    "user_id": 1, 
    "user_name": "Chris Davies", 
    "user_password": "pass", 
    "user_username": "cjd47"
  }
]

CURL Command

curl -i -H "Accept: application/json" -H "Content-Type: application/json" https://mindpalaceservice.herokuapp.com/user/1

Definition

GET /userbyusername/<user_username:string>

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

[
  {
    "user_id": 1, 
    "user_name": "Chris Davies", 
    "user_password": "pass", 
    "user_username": "cjd47"
  }
]

CURL Command

curl -i -H "Accept: application/json" -H "Content-Type: application/json" https://mindpalaceservice.herokuapp.com/userbyusername/cjd47

Add new user

Definition

POST /newuser

Arguments

"user_name":string the name of the new user
"user_username":string a friendly username for the user
"user_password":string a password for the user to login to the application

{
  "user_name" : "Joe Bloggs",
  "user_username" : "jbloggs999",
  "user_password" : "pass"
}

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

{
  "Success": "Database updated"
}

CURL Command

curl -H "Content-Type: application/json" -X POST -d @ExampleNewUser.json https://mindpalaceservice.herokuapp.com/newuser

Delete a user

Definition

DELETE /user/<user_id>

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

{
  "Success": "Database updated"
}

CURL Command

curl -X "DELETE" https://mindpalaceservice.herokuapp.com/user/1

Definition

DELETE /userbyusername/<user_username>

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

{
  "Success": "Database updated"
}

CURL Command

curl -X "DELETE" https://mindpalaceservice.herokuapp.com/userbyusername/cjd47

PALACES

List all palaces

Definition

GET /palaces

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

[
  {
    "palace_description": "dummy description 1", 
    "palace_id": 1, 
    "palace_title": "palace 1", 
    "user_id": 1
  }, 
  {
    "palace_description": "dummy description 2", 
    "palace_id": 2, 
    "palace_title": "palace 2", 
    "user_id": 2
  }, 
  {
    "palace_description": "dummy description 3", 
    "palace_id": 3, 
    "palace_title": "palace 3", 
    "user_id": 3
  }
]

CURL Command

curl -i -H "Accept: application/json" -H "Content-Type: application/json" https://mindpalaceservice.herokuapp.com/palaces

Get existing palace details

Definition

GET /palace/<palace_id:integer>

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

[
  {
    "palace_description": "dummy description 1", 
    "palace_id": 1, 
    "palace_title": "palace 1", 
    "user_id": 1
  }
]

CURL Command

curl -i -H "Accept: application/json" -H "Content-Type: application/json" https://mindpalaceservice.herokuapp.com/palace/1

Get palaces for a given user

Definition

GET /palacesbyuser

URL Parameters

user the username of the user we are interested in

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

[
  {
    "palace_description": "dummy description 1", 
    "palace_id": 1, 
    "palace_title": "palace 1", 
    "user_id": 1
  }
]

CURL Command

curl -i -H "Accept: application/json" -H "Content-Type: application/json" https://mindpalaceservice.herokuapp.com/palacesbyuser?user=cjd47

Add new palace

Definition

POST /newpalace

Arguments

"user_username":string username of the user the palace is to be registered with
"palace_title":string a friendly title for the palace
"palace_description":string a description of what the palace is for

{
  "user_username" : "cjd47",
  "palace_title" : "Test Palace",
  "palace_description" : "Palace added by example JSON"
}

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

{
  "Success": "Database updated"
}

CURL Command

curl -H "Content-Type: application/json" -X POST -d @ExampleNewPalace.json https://mindpalaceservice.herokuapp.com/newpalace

Delete a palace

Definition

DELETE /palace/<palace_id>

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

{
  "Success": "Database updated"
}

CURL Command

curl -X "DELETE" https://mindpalaceservice.herokuapp.com/palace/1

NOTES

List all notes

Definition

GET /notes

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

[
  {
    "note_description": "Apple Description", 
    "note_id": 1, 
    "note_image_url": "http://1.bp.blogspot.com/-sm2PC8KW-l4/UDP7Z4Mz80I/AAAAAAAAB6g/j91oeuESMcs/s1600/apple.jpg", 
    "note_location_x": "5.33", 
    "note_location_y": "2.11", 
    "note_status": false, 
    "note_title": "Apple", 
    "palace_id": 1
  }, 
  {
    "note_description": "Orange Description", 
    "note_id": 2, 
    "note_image_url": "http://producemadesimple.ca/wp-content/uploads/2015/01/orange-web-1024x768.jpg", 
    "note_location_x": "1.7", 
    "note_location_y": "8.4", 
    "note_status": true, 
    "note_title": "Orange", 
    "palace_id": 1
  }, 
  {
    "note_description": "Banana Description", 
    "note_id": 3, 
    "note_image_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/9/9b/Cavendish_Banana_DS.jpg/1920px-Cavendish_Banana_DS.jpg", 
    "note_location_x": "6.1", 
    "note_location_y": "9.0", 
    "note_status": false, 
    "note_title": "Banana", 
    "palace_id": 2
  }, 
  {
    "note_description": "Grapes Description", 
    "note_id": 4, 
    "note_image_url": "http://www.viralnovelty.net/wp-content/uploads/2014/02/Red-Grapes.jpg", 
    "note_location_x": "4.5", 
    "note_location_y": "6.3", 
    "note_status": true, 
    "note_title": "Grapes", 
    "palace_id": 2
  }, 
  {
    "note_description": "Melon Description", 
    "note_id": 5, 
    "note_image_url": "https://sanjeevkapoor.files.wordpress.com/2015/08/melon.jpg", 
    "note_location_x": "4.4", 
    "note_location_y": "3.3", 
    "note_status": false, 
    "note_title": "Melon", 
    "palace_id": 3
  }, 
  {
    "note_description": "Pineapple Description", 
    "note_id": 6, 
    "note_image_url": "https://www.toledoblade.com/image/2013/12/05/800x_b1_cCM_z/pineapple-jpg.jpg", 
    "note_location_x": "0.9", 
    "note_location_y": "8.9", 
    "note_status": true, 
    "note_title": "Pineapple", 
    "palace_id": 3
  }, 
  {
    "note_description": "Test", 
    "note_id": 7, 
    "note_image_url": "https://sanjeevkapoor.files.wordpress.com/2015/08/melon.jpg", 
    "note_location_x": "8.176919867728891", 
    "note_location_y": "9.167381688904456", 
    "note_status": false, 
    "note_title": "Test", 
    "palace_id": 1
  }
]

CURL Command

curl -i -H "Accept: application/json" -H "Content-Type: application/json" https://mindpalaceservice.herokuapp.com/notes

Get existing note details

Definition

GET /note/<note_id:integer>

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

[
  {
    "note_description": "Apple Description", 
    "note_id": 1, 
    "note_image_url": "http://1.bp.blogspot.com/-sm2PC8KW-l4/UDP7Z4Mz80I/AAAAAAAAB6g/j91oeuESMcs/s1600/apple.jpg", 
    "note_location_x": "5.33", 
    "note_location_y": "2.11", 
    "note_status": false, 
    "note_title": "Apple", 
    "palace_id": 1
  }
]

CURL Command

curl -i -H "Accept: application/json" -H "Content-Type: application/json" https://mindpalaceservice.herokuapp.com/note/1

Get notes under palace

Definition

GET /notesbypalace/<palace_id:integer>

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

[
  {
    "note_description": "Melon Description", 
    "note_id": 5, 
    "note_image_url": "https://sanjeevkapoor.files.wordpress.com/2015/08/melon.jpg", 
    "note_location_x": "4.4", 
    "note_location_y": "3.3", 
    "note_status": false, 
    "note_title": "Melon", 
    "palace_id": 3
  }, 
  {
    "note_description": "Pineapple Description", 
    "note_id": 6, 
    "note_image_url": "https://www.toledoblade.com/image/2013/12/05/800x_b1_cCM_z/pineapple-jpg.jpg", 
    "note_location_x": "0.9", 
    "note_location_y": "8.9", 
    "note_status": true, 
    "note_title": "Pineapple", 
    "palace_id": 3
  }
]

CURL Command

curl -i -H "Accept: application/json" -H "Content-Type: application/json" https://mindpalaceservice.herokuapp.com/notesbypalace/3

Get nearest note details

Definition

GET /nearestnote/<palace_id:integer>

URL Parameters

xpos the x co-ordinate of the user's current location
ypos the y co-ordinate of the user's current location
rad the chosen senitivity radius

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

[
  {
    "note_description": "Apple Description", 
    "note_id": 1, 
    "note_image_url": "http://1.bp.blogspot.com/-sm2PC8KW-l4/UDP7Z4Mz80I/AAAAAAAAB6g/j91oeuESMcs/s1600/apple.jpg", 
    "note_location_x": "5.33", 
    "note_location_y": "2.11", 
    "note_status": false, 
    "note_title": "Apple", 
    "palace_id": 1
  }
]

or

[
  {
    "Message": "No notes within radius!"
  }
]

CURL Command

curl -i -H "Accept: application/json" -H "Content-Type: application/json" https://mindpalaceservice.herokuapp.com/nearestnote/1?xpos=8.22334567&ypos=1.456566754&rad=2.99

Get unremembered note details

Definition

GET /unrememberednotes

URL Parameters

ptitle the title of the palace we are interested in
user the username of the user we are interested in

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

[
  {
    "note_description": "Apple Description", 
    "note_id": 1, 
    "note_image_url": "http://1.bp.blogspot.com/-sm2PC8KW-l4/UDP7Z4Mz80I/AAAAAAAAB6g/j91oeuESMcs/s1600/apple.jpg", 
    "note_location_x": "5.33", 
    "note_location_y": "2.11", 
    "note_status": false, 
    "note_title": "Apple", 
    "palace_id": 1
  }
]

CURL Command

curl -i -H "Accept: application/json" -H "Content-Type: application/json" https://mindpalaceservice.herokuapp.com/unrememberednotes?ptitle=Fruit&user=cjd47

Get number of remembered notes and total notes in a given palace

Definition

GET /progress

URL Parameters

ptitle the title of the palace we are interested in
user the username of the user we are interested in

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

[
  {
    "remembered": 1, 
    "total": 2
  }
]

CURL Command

curl -i -H "Accept: application/json" -H "Content-Type: application/json" https://mindpalaceservice.herokuapp.com/progress?ptitle=Fruit&user=cjd47

Add new note

Definition

POST /newnote

Arguments

palace_id:string id of the palace the note is to be registered with
note_title:string a friendly title for the note
note_description:string a description of what the note is
note_location_x:string a string representing the x location of the note in the room
note_location_y:string a string representing the y location of the note in the room
note_image_url:string a string representing the URL of the image chosen for the note
note_status:boolean a status over whether the note has been remembered

{
  "palace_id" : 1,
  "note_title" : "Test Note",
  "note_description" : "Note added by example JSON",
  "note_location_x" : "10.0",
  "note_location_y" : "7.3",
  "note_image_url": "http://1.bp.blogspot.com/-sm2PC8KW-l4/UDP7Z4Mz80I/AAAAAAAAB6g/j91oeuESMcs/s1600/apple.jpg", 
  "note_status" : false
}

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

{
  "Success": "Database updated"
}

CURL Command

curl -H "Content-Type: application/json" -X POST -d @ExampleNewNote.json https://mindpalaceservice.herokuapp.com/newnote

Update note status

Definition

POST /updatenotestatus/<note_id>

URL Parameters

status the new status for the current note

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

{
  "Success": "Database updated"
}

CURL Command

curl -H "Content-Type: application/json" -X POST https://mindpalaceservice.herokuapp.com/updatenotestatus/1?status=true

Delete a note

Definition

DELETE /note/<note_id>

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

{
  "Success": "Database updated"
}

CURL Command

curl -X "DELETE" https://mindpalaceservice.herokuapp.com/note/1

Definition

DELETE /notesbypalace/<palace_id>

Response

200 OK on success
505 INTERNAL SERVER ERROR on failure (e.g. SQL error)

{
  "Success": "Database updated"
}

CURL Command

curl -X "DELETE" https://mindpalaceservice.herokuapp.com/notesbypalace/2

Name		Name	Last commit message	Last commit date
Latest commit History 78 Commits
db		db
img		img
json		json
.gitignore		.gitignore
LICENSE		LICENSE
PITCHME.md		PITCHME.md
Procfile		Procfile
README.md		README.md
mindpalaceservice.py		mindpalaceservice.py
requirements.txt		requirements.txt
runtime.txt		runtime.txt

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

"Hold That Thought" (HTT)

REST API

USERS

List all users

Get existing user details

Add new user

Delete a user

PALACES

List all palaces

Get existing palace details

Get palaces for a given user

Add new palace

Delete a palace

NOTES

List all notes

Get existing note details

Get notes under palace

Get nearest note details

Get unremembered note details

Get number of remembered notes and total notes in a given palace

Add new note

Update note status

Delete a note

About

Releases

Packages

Languages

License

cd223/MindPalaceService

Folders and files

Latest commit

History

Repository files navigation

"Hold That Thought" (HTT)

REST API

USERS

List all users

Get existing user details

Add new user

Delete a user

PALACES

List all palaces

Get existing palace details

Get palaces for a given user

Add new palace

Delete a palace

NOTES

List all notes

Get existing note details

Get notes under palace

Get nearest note details

Get unremembered note details

Get number of remembered notes and total notes in a given palace

Add new note

Update note status

Delete a note

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages