Skip to content

Commit fe5a9a9

Browse files
authored
docs: add get user set request docs (#69)
1 parent 13f4e8d commit fe5a9a9

File tree

4 files changed

+76
-0
lines changed

4 files changed

+76
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Click the function names to open their complete docs on the docs site.
4646
- [Want to Play Games List](https://api-docs.retroachievements.org/v1/get-user-want-to-play-list.html) - Get a user's list of Want to Play Games.
4747
- [Users I Follow](https://api-docs.retroachievements.org/v1/get-users-i-follow.html) - Get the caller's list of followed users.
4848
- [Users Following Me](https://api-docs.retroachievements.org/v1/get-users-following-me.html) - Get the caller's list of followers users.
49+
- [User Set Requests](https://api-docs.retroachievements.org/v1/get-user-set-requests.html) - Get a user's list of set requests.
4950

5051
### Game
5152

docs/.vitepress/config.mts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,10 @@ export default defineConfig({
118118
text: "Users Following Me",
119119
link: "/v1/get-users-following-me",
120120
},
121+
{
122+
text: "User Set Requests",
123+
link: "/v1/get-user-set-requests",
124+
},
121125
],
122126
},
123127
{

docs/public/set-requests.png

505 KB
Loading

docs/v1/get-user-set-requests.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
<script setup>
2+
import SampleRequest from '../components/SampleRequest.vue';
3+
</script>
4+
5+
# User Set Requests
6+
7+
A call to this endpoint will retrieve a given user's set requests, maximum total requests and points until next request.
8+
9+
[[toc]]
10+
11+
## On-Site Representation
12+
13+
![Set Requests](/set-requests.png)
14+
15+
## HTTP Request
16+
17+
<SampleRequest httpVerb="GET">https://retroachievements.org/API/API_GetUserSetRequests.php?u=MaxMilyin</SampleRequest>
18+
19+
### Query Parameters
20+
21+
| Name | Required? | Description |
22+
| :--- | :-------- | :--------------------------------------------------------------------------- |
23+
| `y` | Yes | Your web API key. |
24+
| `u` | Yes | The target username. |
25+
| `t` | No | Request List Type: 0 for active requests, 1 for all requests. Defaults to 0. |
26+
27+
## Client Library
28+
29+
Not Yet Supported
30+
31+
## Response
32+
33+
::: code-group
34+
35+
```json [HTTP Response]
36+
{
37+
"RequestedSets": [
38+
{
39+
"GameID": 8149,
40+
"Title": "Jurassic Park Institute Tour: Dinosaur Rescue",
41+
"ConsoleID": 5,
42+
"ConsoleName": "Game Boy Advance",
43+
"ImageIcon": "/Images/000001.png"
44+
},
45+
{
46+
"GameID": 600,
47+
"Title": "Psycho Pinball",
48+
"ConsoleID": 1,
49+
"ConsoleName": "Genesis/Mega Drive",
50+
"ImageIcon": "/Images/039797.png"
51+
},
52+
{
53+
"GameID": 1,
54+
"Title": "Sonic the Hedgehog",
55+
"ConsoleID": 1,
56+
"ConsoleName": "Genesis/Mega Drive",
57+
"ImageIcon": "/Images/085573.png"
58+
}
59+
],
60+
"TotalRequests": 5,
61+
"PointsForNext": 5000
62+
}
63+
```
64+
65+
:::
66+
67+
## Source
68+
69+
| Repo | URL |
70+
| :---- | :------------------------------------------------------------------------------------------- |
71+
| RAWeb | https://github.com/RetroAchievements/RAWeb/blob/master/public/API/API_GetUserSetRequests.php |

0 commit comments

Comments
 (0)