Feeds
Get user's feed
Type: GET
Route: /users/{userame}/feed
1
2
2
URI Parameters
Name: username
Type: String
Required: True
1
2
3
2
3
Response 200
{
"message": "Successfully retrieved feeds.",
"feeds": [
{
"id": 54323,
"type": 1,
"content": "Feed content",
"createdAt": "2018-06-04T04:25:51.506Z",
"editedAt": "2018-06-04T04:25:51.506Z",
"author": {
"uuid": "345c45aa-5h76-9zh4-6tr7-6tkl52rn5783",
"username": "testuser",
"displayName": "TestUser",
"avatarImage": "testuser-512x512.jpg"
},
"user": {
"uuid": "345c45aa-5h76-9zh4-6tr7-6tkl52rn5782",
"username": "anothertestuser",
"displayName": "AnotherTestUser",
"avatarImage": "anothertestuser-512x512.jpg"
},
"followTarget": [],
"song": null,
"upload": null,
"comments": 1
},
...
]
}
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
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
TIP
Depending the type property returned, the response structure changes a bit. Here's a breakdown of what's different on each case.
Type 1: Someone commented on the user's feed.
Type 2: The user favorited a song
Type 3: The user uploaded a song
Type 4: The user approved an upload (only admins)
1
2
3
4
2
3
4
When type is 2 or 4
"content": null,
"song": {
"title": "sigh",
"titleRomaji": null,
"artists": [
{
"id": 2761,
"name": "Luschka",
"nameRomaji": null
}
]
},
"upload": null
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
When type is 3
"content": null,
"song": null,
"upload": {
"title": "ぼなぺてぃーと♡S -Hall staff ver.-",
"titleRomaji": null,
"artists": [
"桜ノ宮苺香 (CV: 和氣あず未)",
"日向夏帆 (CV: 鬼頭明里)",
"星川麻冬 (CV: 春野 杏)",
"天野美雨 (CV: 種﨑敦美)",
"神崎ひでり (CV: 徳井青空)"
],
"artistsRomaji": [
"Maika Sakuranomiya (CV: Azumi Waki)",
"Kaho Hinata (CV: Akari Kito)",
"Hoshikawa Mafuyu (CV: Haruno Anzu)",
"Amano Miu (CV: Atsumi Tanezaki)",
"Hideri Kanzaki (CV: Sora Tokui)"
],
"artistGroups": [],
"artistGroupsRomaji": []
},
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Delete a feed
Type: DELETE
Route: /feeds/{id}
1
2
2
URI Parameters
Name: id
Type: String
Required: True
1
2
3
2
3
Response 204
Possible errors
# Code 400
{ "message": "No params provided." }
{ "message": "Invalid params provided." }
# Code 403
{ "message": "Not authorized." }
# Code 404
{ "message": "No feed found." }
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Get feed comments
Type: GET
Route: /feeds/{id}/comments
1
2
2
URI Parameters
Name: id
Type: String
Required: True
1
2
3
2
3
Response 200
{
"message": "Successfully retrieved comments.",
"comments": [
{
"id": 1,
"parentId": 0,
"content": "some-content",
"createdAt": "1970-01-01T00:00:00.000Z",
"editedAt": "1970-01-01T00:00:00.000Z",
"user": {
"uuid": "345c45aa-5h76-9zh4-6tr7-6tkl52rn5783",
"username": "testuser",
"displayName": "TestUser",
"avatarImage": "testuser-512x512.jpg"
}
},
...
]
}
{
"message": "No comments found.",
"comments": []
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Possible errors
# Code 400
{ "message": "No params provided." }
{ "message": "Invalid params provided." }
# Code 404
{ "message": "No feed found." }
1
2
3
4
5
6
2
3
4
5
6
Post a new comment
Type: POST
Route: /feeds/{id}/comments
1
2
2
URI Parameters
Name: id
Type: String
Required: True
1
2
3
2
3
Body
{
"parentId": 0,
"content": "Your comment."
}
1
2
3
4
2
3
4
Response 200
{
"message": "Successfully commented on the feed",
"comment": {
"id": 1,
"parentId": 0,
"content": "some-content",
"createdAt": "1970-01-01T00:00:00.000Z",
"editedAt": "1970-01-01T00:00:00.000Z",
"user": {
"uuid": "345c45aa-5h76-9zh4-6tr7-6tkl52rn5783",
"username": "testuser",
"displayName": "TestUser",
"avatarImage": "testuser-512x512.jpg"
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Possible errors
# Code 400
{ "message": "No params provided." }
{ "message": "Invalid params provided." }
{ "message": "No body provided." }
{ "message": "Invalid body provided." }
# Code 404
{ "message": "No comment found." }
{ "message": "No feed found." }
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9