Skip to content

Commit f84bfbe

Browse files
authored
Add missing details to getGJLevels21.md (#83)
1 parent 1b8645f commit f84bfbe

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

docs/endpoints/getGJLevels21.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ Gets a list of levels.
2222

2323
**gauntlet** - The ID of the gauntlet that's currently being loaded.
2424

25-
**type** - Controls the fetch priority.
26-
and if this is left out it's most liked
25+
**type** - Controls the fetch priority. By default it's most liked.
2726

2827
| type | desc |
2928
| ---- | ---- |
@@ -47,19 +46,21 @@ and if this is left out it's most liked
4746
| 21 | Daily History |
4847
| 22 | Weekly History |
4948

50-
**str** - Search string, required when `type` is 5 or 10
49+
**str** - Search string, required when `type` is 5 or 10.
5150

52-
**diff** - Difficulty filter. A list of integers denoting the different difficulties.
51+
**diff** - Difficulty filter. A list of integers denoting the different difficulties. Negative difficulties are ignored when any positive one is specified.
5352

5453
| diff | desc |
5554
| ---- | ---- |
56-
| -1 | N/A (doesn't work) |
57-
| -2 | Demons (use the **demonFilter** parameter to denote which demon type to search) |
55+
| -1 | N/A (doesn't work, always returns no results) |
56+
| -2 | Demons (use the `demonFilter` parameter to denote which demon type to search) (exclusive from -3) |
57+
| -3 | Auto (exclusive from -2) |
5858
| 1 | Easy |
5959
| 2 | Normal |
6060
| 3 | Hard |
6161
| 4 | Harder |
6262
| 5 | Insane |
63+
| 6–10 | Easy to Extreme Demon, respectively |
6364

6465
**len** - Length Filter.
6566

@@ -71,9 +72,11 @@ and if this is left out it's most liked
7172
| 3 | Long |
7273
| 4 | XL |
7374

74-
**page** - Which page of levels you want to see
75+
**page** - Which page of levels you want to see.
7576

76-
**total** - Current use is unknown, defaults to the amount of levels available, up to 9999, but leaving it out or as 0 works.
77+
**total** - Current use is unknown, defaults to the amount of levels available, up to 9999. Most likely it's a caching system for avoiding excessive execution of expensive COUNT database queries.
78+
79+
**count** - Size of a single page of levels. Capped at 10.
7780

7881
**uncompleted** - Uncompleted filter. 0 for off, 1 for on.
7982

@@ -95,16 +98,14 @@ and if this is left out it's most liked
9598

9699
**song** - Official song filter. Not sent when off.
97100

98-
**customSong** Enable newgrounds song filter, **song** parameter will be songID, Not sent when off
101+
**customSong** - Enable newgrounds song filter, **song** parameter will be songID. Not sent when off.
99102

100103
**completedLevels** - A comma separated list of completed levels enclosed in brackets. Only sent if the uncompleted or completed filter is enabled.
101104

102105
**followed** - Required if `type` is 12. A comma separated list of player IDs, **not account IDs** of the people you follow.
103106

104107
**demonFilter** - Denotes which difficulty of demon to search for if `diff` is -2. If left out it will search for all demons, otherwise it's 1-5 for Easy to Extreme, respectively.
105108

106-
**secret** - Wmfd2893gb7
107-
108109
## Response
109110

110111
Returns a list of [level objects](/resources/server/level) separated by pipes `|` and sorted by the parameters, a list of objects denoting the authors sorted by increasing player ID (format is `PLAYERID:USERNAME:ACCOUNTID`) which are also separated by pipes `|`, and a list of [song objects](/resources/server/song) sorted by increasing song ID and separated by `~:~`. The indexers for each are `:`, `:` and `~|~` respectively.
@@ -124,7 +125,7 @@ data = {
124125
"secret": "Wmfd2893gb7",
125126
"type": 4,
126127
"diff": -2,
127-
"epic": 1,
128+
"epic": 1,
128129
"demonFilter": 3
129130
}
130131

0 commit comments

Comments
 (0)