aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e2e6948e174cf3a99172ff48b495501af6561e4b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# API
The api is available on `/api`.

GET `/`
Gets information about the server
- Return type: JSON
- Returns: <information>

GET `/ping`
Pings the server
- Return type: JSON
- Returns: pong

GET `/create_user/<name>`
Creates a new user with name
- Return type: JSON
- Returns: <user_id>

GET `/get_user/<id>`
Gets a user from id
- Return type: JSON
- Returns: <user>

GET `/get_user_by_name/<name>`
Gets a user from name
- Return type: JSON
- Returns: <user>

GET `/get_message/<id>`
Gets a message by id
- Return type: JSON
- Returns: <message>

GET `/get_message_id_newest`
Gets the newest message id
- Return type: JSON
- Returns: <message_id>

GET `/get_message_id_list/<from_id>/<to_id>`
Gets a list of messages from_id to to_id inclusive
- Return type: JSON
- Returns: <Array<message_id>>

GET `/send_message/<user_id>/<message>`
Sends a message
- Return type: JSON
- Returns: <message_id>

GET `/send_reply/<user_id>/<message_id>/<message>`
Sends a reply to a message
- Return type: JSON
- Returns: <message_id>

GET `/delete_message/<message_id>`
Deletes a message
- Return type: JSON
- Returns: Deleted