-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathapi-guide-collection.txt
More file actions
66 lines (58 loc) · 1.24 KB
/
Copy pathapi-guide-collection.txt
File metadata and controls
66 lines (58 loc) · 1.24 KB
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
58
59
60
61
62
63
64
65
66
/*
RETRIEVE ALL COLLECTIONS THAT ARE NOT A SUB-COLLECTION
route:
"/api/collections/"
method:
"GET"
RETRIEVE ALL SUB-COLLECTIONS IN A GIVEN COLLECTION
route:
"/api/collections/subcollections"
method:
"GET"
CREATE A NEW COLLECTION
route:
"/api/collections/"
method:
"POST"
expected body parameters (parameters in square brackets [] are optional):
{
name: <string>,
[color: <color enum>],
[ParentCollection: <integer, ID of parent collection>]
}
RENAME A COLLECTION
route:
"/api/collections/name"
method:
"PUT"
expected body parameters:
{
newName: <string>,
id: <integer, ID of collection to rename>
}
MOVE COLLECTION TO A NEW PARENT
route:
"/api/collections/parent"
method:
"PUT"
expected body parameters:
{
newParentCollection: <integer, ID of new parent collection>,
ids: <ARRAY of integers, list of collections IDs to move to new parent>
}
CHANGE A COLLECTION'S COLOR
route:
"/api/collection/color"
method:
"PUT"
expected body parameters:
{
newColor: <color enum>,
ids: <ARRAY of integers, list of collection IDs to re-color>
}
REMOVE A COLLECTION
route:
"/api/collection/:id"
method:
"DELETE"
*/