diff --git a/docs/glossary.md b/docs/glossary.md index fd9b9f1..38a7cb8 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -111,11 +111,29 @@ List of connected platform identities for a player account. Useful for retrievin Game content-specific terms and identifiers. +### Club ID + +An incremental ID that identifies a club (starting from 1). + ### Activity ID -An incremental ID that identifies a club activity. +An incremental ID that identifies a club activity (starting from 1). + +Not to be confused with more specific IDs for activity types such as [campaign IDs](#campaign-id) or [room IDs](#room-id). + +### Campaign ID + +An incremental ID that identifies a club campaign (starting from 1). +Many campaign API routes require a campaign ID to be used, rather than an activity ID + +Not to be confused with the campaign's activity ID. + +### Room ID + +An incremental ID that identifies a club room (starting from 1). +This is only given when requesting a room's info, and not used in room API routes. -Not to be confused with more specific IDs for activity types such as club campaign IDs or club room IDs. +Not to be confused with the room's activity ID. ### Competition ID diff --git a/docs/live/campaigns/campaigns-v2.md b/docs/live/campaigns/campaigns-v2.md index d53caba..6e4cb2b 100644 --- a/docs/live/campaigns/campaigns-v2.md +++ b/docs/live/campaigns/campaigns-v2.md @@ -76,14 +76,3 @@ GET https://live-services.trackmania.nadeo.live/api/campaign/official?offset=0&l "relativeNextRequest": 704811 } ``` - -If the campaign does not exist, the response will show an empty list: - -```json -{ - "itemCount": 18, - "campaignList": [], - "nextRequestTimestamp": 1735747200, - "relativeNextRequest": 704825 -} -``` diff --git a/docs/live/campaigns/campaigns.md b/docs/live/campaigns/campaigns.md index 4e1d5f5..4e9ba78 100644 --- a/docs/live/campaigns/campaigns.md +++ b/docs/live/campaigns/campaigns.md @@ -138,16 +138,3 @@ GET https://live-services.trackmania.nadeo.live/api/token/campaign/official?offs "relativeNextRequest": 3439884 } ``` - -If the campaign does not exist, the response will show an empty list: - -```json -{ - "itemCount": 9, - "campaignList": [ - - ], - "nextRequestTimestamp": 1664636400, - "relativeNextRequest": 3439827 -} -``` diff --git a/docs/live/campaigns/map-info.md b/docs/live/campaigns/map-info.md index ed2adf9..978a6c8 100644 --- a/docs/live/campaigns/map-info.md +++ b/docs/live/campaigns/map-info.md @@ -51,7 +51,7 @@ GET https://live-services.trackmania.nadeo.live/api/campaign/map/ClF9ty2T55DZq4a } ``` -Example response if the requested map does not exist or is not part of any campaigns or TOTDs: +Example response if the requested map does not exist or is not part of any campaigns or TOTDs (status 200): ```json { diff --git a/docs/live/campaigns/totds.md b/docs/live/campaigns/totds.md index ce50d88..d71a923 100644 --- a/docs/live/campaigns/totds.md +++ b/docs/live/campaigns/totds.md @@ -91,16 +91,3 @@ GET https://live-services.trackmania.nadeo.live/api/token/campaign/month?offset= "relativeNextRequest": 4041 } ``` - -If the month does not exist, the response will show an empty list: - -```json -{ - "monthList": [ - - ], - "itemCount": 26, - "nextRequestTimestamp": 1661274000, - "relativeNextRequest": 77366 -} -``` diff --git a/docs/live/campaigns/weekly-grands.md b/docs/live/campaigns/weekly-grands.md index f5357cb..ac5c742 100644 --- a/docs/live/campaigns/weekly-grands.md +++ b/docs/live/campaigns/weekly-grands.md @@ -72,14 +72,3 @@ GET https://live-services.trackmania.nadeo.live/api/campaign/weekly-grands?offse "relativeNextRequest": 17115 } ``` - -If the campaign does not exist, the response will show an empty list: - -```json -{ - "itemCount": 1, - "campaignList": [], - "nextRequestTimestamp": 1769965200, - "relativeNextRequest": 17097 -} -``` diff --git a/docs/live/campaigns/weekly-shorts.md b/docs/live/campaigns/weekly-shorts.md index aa65d87..9b449a8 100644 --- a/docs/live/campaigns/weekly-shorts.md +++ b/docs/live/campaigns/weekly-shorts.md @@ -84,14 +84,3 @@ GET https://live-services.trackmania.nadeo.live/api/campaign/weekly-shorts?offse "relativeNextRequest": 449802 } ``` - -If the campaign does not exist, the response will show an empty list: - -```json -{ - "itemCount": 2, - "campaignList": [], - "nextRequestTimestamp": 1735491600, - "relativeNextRequest": 449777 -} -``` diff --git a/docs/live/club-management/delete-activity.md b/docs/live/club-management/delete-activity.md index 2f26b5c..d6d67b5 100644 --- a/docs/live/club-management/delete-activity.md +++ b/docs/live/club-management/delete-activity.md @@ -42,26 +42,20 @@ POST https://live-services.trackmania.nadeo.live/api/token/club/103034/activity/ Activity deleted ``` -If the club does not exist or the authenticated account is not a member of the club, the response will contain an error: +If the club does not exist or the authenticated account is not a member of the club, the response will contain an error (status 403): ```json -[ - "clubMemberRole:error-notMember" -] +["clubMemberRole:error-notMember"] ``` -If the activity does not exist, the response will contain an error: +If the activity does not exist, the response will contain an error (status 404): ```json -[ - "activity:error-notFound" -] +["activity:error-notFound"] ``` -If the player does not have enough permissions in the club to delete activities, the response will contain an error: +If the player does not have enough permissions in the club to delete activities, the response will contain an error (status 403): ```json -[ - "clubMemberRole:error-notContentCreator" -] +["clubMemberRole:error-notAdmin"] ``` diff --git a/docs/live/club-management/delete-club.md b/docs/live/club-management/delete-club.md index 8ac73bc..5a9847a 100644 --- a/docs/live/club-management/delete-club.md +++ b/docs/live/club-management/delete-club.md @@ -40,18 +40,14 @@ POST https://live-services.trackmania.nadeo.live/api/token/club/131063/delete Club deleted. ``` -If the club does not exist or the player is not a member of the club, the response will contain an error: +If the club does not exist or the player is not a member of the club, the response will contain an error (status 403): ```json -[ - "clubMemberRole:error-notMember" -] +["clubMemberRole:error-notMember"] ``` -If the player is not the creator of the club, the response will contain an error: +If the player is not the creator of the club, the response will contain an error (status 403): ```json -[ - "clubMemberRole:error-notCreator" -] +["clubMemberRole:error-notCreator"] ``` diff --git a/docs/live/club-management/delete-member.md b/docs/live/club-management/delete-member.md index f73e857..5946f77 100644 --- a/docs/live/club-management/delete-member.md +++ b/docs/live/club-management/delete-member.md @@ -43,18 +43,14 @@ POST https://live-services.trackmania.nadeo.live/api/token/club/383/member/69f31 Club member deleted ``` -If the club or account does not exist, or the player is not a member of the club, the response will contain an error: +If the club does not exist, or the authenticated account is not an admin in the club (except when removing yourself from a club, ie the `accountId` parameter matches the authenticated account), the response will contain an error (status 403): ```json -[ - "clubMember:error-notFound" -] +["clubMemberRole:error-notAdmin"] ``` -If the authenticated account is not an admin in the club and its account ID does not match the `accountId` parameter, the response will contain an error: +If the account does not exist, or the player is not a member of the club, the response will contain an error (status 404): ```json -[ - "clubMemberRole:error-notAdmin" -] +["clubMember:error-notFound"] ``` diff --git a/docs/live/club-management/member-requests.md b/docs/live/club-management/member-requests.md index 547fae4..693df48 100644 --- a/docs/live/club-management/member-requests.md +++ b/docs/live/club-management/member-requests.md @@ -10,7 +10,7 @@ audience: NadeoLiveServices parameters: path: - name: clubId - type: string + type: integer description: The club's ID required: true query: @@ -84,12 +84,4 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/354/member/reques } ``` -If the club does not exist or support requests, the response will contain an empty list of pending member requests: - -```json -{ - "clubMemberList": [], - "maxPage": 0, - "itemCount": 0 -} -``` +If the `clubId` is invalid, or the club does not support requests, the response will contain an empty list of pending member requests. diff --git a/docs/live/club-management/set-vip.md b/docs/live/club-management/set-vip.md index 0e24afe..ac49c5f 100644 --- a/docs/live/club-management/set-vip.md +++ b/docs/live/club-management/set-vip.md @@ -52,26 +52,20 @@ POST https://live-services.trackmania.nadeo.live/api/token/club/131063/vip/69f31 } ``` -If the `accountID` is invalid or does not belong to a member of the club, the response will contain an error: +If the club does not exist or the authenticated account is not a member of the club, the response will contain an error (status 403): ```json -[ - "clubMember:error-notFound" -] +["clubMemberRole:error-notMember"] ``` -If the club does not exist or the authenticated account is not a member of the club, the response will contain an error: +If the authenticated account does not have enough permissions in the club to manage VIP members, the response will contain an error (status 403): ```json -[ - "clubMemberRole:error-notMember" -] +["clubMemberRole:error-notAdmin"] ``` -If the authenticated account does not have enough permissions in the club to manage VIP members, the response will contain an error: +If the `accountID` is invalid or does not belong to a member of the club, the response will contain an error (status 404): ```json -[ - "clubMemberRole:error-notAdmin" -] +["clubMember:error-notFound"] ``` diff --git a/docs/live/club-management/unset-vip.md b/docs/live/club-management/unset-vip.md index fa0a44f..07c8021 100644 --- a/docs/live/club-management/unset-vip.md +++ b/docs/live/club-management/unset-vip.md @@ -51,26 +51,20 @@ POST https://live-services.trackmania.nadeo.live/api/token/club/131063/vip/69f31 } ``` -If the `accountId` is invalid or does not belong to a member of the club, the response will contain an error: +If the club does not exist or the authenticated account is not a member of the club, the response will contain an error (status 403): ```json -[ - "clubMember:error-notFound" -] +["clubMemberRole:error-notMember"] ``` -If the club does not exist or the authenticated account is not a member of the club, the response will contain an error: +If the authenticated account does not have enough permissions in the club to manage VIP members, the response will contain an error (status 403): ```json -[ - "clubMemberRole:error-notMember" -] +["clubMemberRole:error-notAdmin"] ``` -If the authenticated account does not have enough permissions in the club to manage VIP members, the response will contain an error: +If the `accountId` is invalid or does not belong to a member of the club, the response will contain an error (status 404): ```json -[ - "clubMemberRole:error-notAdmin" -] +["clubMember:error-notFound"] ``` diff --git a/docs/live/clubs/activities.md b/docs/live/clubs/activities.md index 4722c2c..c3ab9be 100644 --- a/docs/live/clubs/activities.md +++ b/docs/live/clubs/activities.md @@ -10,7 +10,7 @@ audience: NadeoLiveServices parameters: path: - name: clubId - type: string + type: integer description: The club's ID required: true query: @@ -135,10 +135,4 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/4764/activity?len } ``` -If the club does not exist or the player is not a member of the club, the response will contain an error: - -```json -[ - "clubMemberRole:error-notMember" -] -``` +If the `clubId` is invalid, the response will contain an empty list of activities. diff --git a/docs/live/clubs/campaign-by-id.md b/docs/live/clubs/campaign-by-id.md index 462ba3d..6c94e5a 100644 --- a/docs/live/clubs/campaign-by-id.md +++ b/docs/live/clubs/campaign-by-id.md @@ -123,10 +123,17 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/19489/campaign/28 } ``` -If the club or campaign does not exist, the response will contain an error: +If the club or campaign does not exist, the response will contain an error (status 404): ```json -[ - "activity:error-notFound" -] +["activity:error-notFound"] ``` + +If the campaign is private and the player is not a member of the club, the response will contain an error (status 403): + +```json +["clubMemberRole:error-notMember"] +``` + +In some rare cases the response may be empty for unknown reasons (status 200): +This is consistent for a given campaign; and campaigns with this issue still appear as normal in [get club activities](/live/clubs/activities). diff --git a/docs/live/clubs/club.md b/docs/live/clubs/club.md index 03a948e..5b96276 100644 --- a/docs/live/clubs/club.md +++ b/docs/live/clubs/club.md @@ -10,7 +10,7 @@ audience: NadeoLiveServices parameters: path: - name: clubId - type: string + type: integer description: The club's ID required: true --- @@ -106,7 +106,7 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/9 } ``` -If the club does not exist, the response will contain an error: +If the club does not exist, the response will contain an error (status 404): ```json ["club:error-notFound"] diff --git a/docs/live/clubs/clubs-mine.md b/docs/live/clubs/clubs-mine.md index 5ca996b..1680416 100644 --- a/docs/live/clubs/clubs-mine.md +++ b/docs/live/clubs/clubs-mine.md @@ -117,13 +117,3 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/mine?length=1&off "clubCount": 41 } ``` - -If you aren't a member of any clubs, the response will contain an empty list: - -```json -{ - "clubList": [], - "maxPage": 0, - "clubCount": 0 -} -``` diff --git a/docs/live/clubs/join-club.md b/docs/live/clubs/join-club.md index 9470d6d..6633890 100644 --- a/docs/live/clubs/join-club.md +++ b/docs/live/clubs/join-club.md @@ -50,18 +50,14 @@ POST https://live-services.trackmania.nadeo.live/api/token/club/103034/member/cr } ``` -If the club does not exist, the response will contain an error: +If the club does not exist, the response will contain an error (status 404): ```json -[ - "club:error-notFound" -] +["club:error-notFound"] ``` -If the club is private, the response will contain an error: +If the club is private, the response will contain an error (status 500): ```json -[ - "clubState:error-wrongState" -] +["clubState:error-wrongState"] ``` diff --git a/docs/live/clubs/map-review-by-id.md b/docs/live/clubs/map-review-by-id.md index fec178b..5cc72d3 100644 --- a/docs/live/clubs/map-review-by-id.md +++ b/docs/live/clubs/map-review-by-id.md @@ -64,10 +64,14 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/31644/map-review/ } ``` -If the club or map review does not exist, the response will contain an error: +If the club or map review does not exist, the response will contain an error (status 404): ```json -[ - "activity:error-notFound" -] +["activity:error-notFound"] +``` + +If the map review is private and the player is not a member of the club, the response will contain an error (status 403): + +```json +["clubMemberRole:error-notMember"] ``` diff --git a/docs/live/clubs/member-by-name.md b/docs/live/clubs/member-by-name.md index e23939e..92ebaca 100644 --- a/docs/live/clubs/member-by-name.md +++ b/docs/live/clubs/member-by-name.md @@ -10,7 +10,7 @@ audience: NadeoLiveServices parameters: path: - name: clubId - type: string + type: integer description: The club's ID required: true - name: memberName @@ -59,10 +59,8 @@ If the club does not exist or the player is not a member of the club, the respon } ``` -If the player name can't be resolved to an account, the response will contain an error: +If the player name can't be resolved to an account, the response will contain an error (status 404): ```json -[ - "player:error-notFound" -] +["player:error-notFound"] ``` diff --git a/docs/live/clubs/member.md b/docs/live/clubs/member.md index de1f0ec..80f9e37 100644 --- a/docs/live/clubs/member.md +++ b/docs/live/clubs/member.md @@ -10,7 +10,7 @@ audience: NadeoLiveServices parameters: path: - name: clubId - type: string + type: integer description: The club's ID required: true - name: memberId diff --git a/docs/live/clubs/members.md b/docs/live/clubs/members.md index d37cfb5..fd0df36 100644 --- a/docs/live/clubs/members.md +++ b/docs/live/clubs/members.md @@ -10,7 +10,7 @@ audience: NadeoLiveServices parameters: path: - name: clubId - type: string + type: integer description: The club's ID required: true query: @@ -79,12 +79,4 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/9/member?length=3 } ``` -If the club does not exist, the response will contain an empty list of members: - -```json -{ - "clubMemberList": [], - "maxPage": 0, - "itemCount": 0 -} -``` +If the `clubId` is invalid, the response will contain an empty list of members. diff --git a/docs/live/clubs/news-by-id.md b/docs/live/clubs/news-by-id.md index 2ffac1f..bdf5990 100644 --- a/docs/live/clubs/news-by-id.md +++ b/docs/live/clubs/news-by-id.md @@ -57,10 +57,14 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/103034/news/10068 } ``` -If the club or news does not exist, the response will contain an error: +If the club or news does not exist, the response will contain an error (status 404): ```json -[ - "activity:error-notFound" -] +["activity:error-notFound"] +``` + +If the news is private and the player is not a member of the club, the response will contain an error (status 403): + +```json +["clubMemberRole:error-notMember"] ``` diff --git a/docs/live/clubs/pin-club.md b/docs/live/clubs/pin-club.md index cee96eb..8985f62 100644 --- a/docs/live/clubs/pin-club.md +++ b/docs/live/clubs/pin-club.md @@ -44,10 +44,8 @@ POST https://live-services.trackmania.nadeo.live/api/token/club/131063/pin } ``` -If the club does not exist or the authenticated account is not a member of the club, the response will contain an error: +If the club does not exist or the player is not a member of the club, the response will contain an error (status 403): ```json -[ - "clubMemberRole:error-notMember" -] +["clubMemberRole:error-notMember"] ``` diff --git a/docs/live/clubs/room-by-id.md b/docs/live/clubs/room-by-id.md index b673d75..9b33eda 100644 --- a/docs/live/clubs/room-by-id.md +++ b/docs/live/clubs/room-by-id.md @@ -27,6 +27,7 @@ Gets the details of a specific club room. - Club rooms connected to a dedicated server will have less information available - specifically, `maps` and `scriptSettings` will likely be empty. - As of 2024-01-17, this endpoint's response links to `.dds` media files by default, while several scaled `.png` versions are available using separate fields (see example below for reference). This only applies for custom media files, and not for preset themes. +- In some rare cases, the room's maps will be returned as an object whose keys are integers starting from `0`, instead of an array. --- @@ -89,6 +90,7 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/25/room/381929 "type": "integer" } }, + "shufflePlaylist": true, "serverInfo": null }, "popularityLevel": 0, @@ -105,10 +107,25 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/25/room/381929 } ``` -If the club or room does not exist, the response will contain an error: +If the club or room does not exist, the response will contain an error (status 404): ```json -[ - "activity:error-notFound" -] +["activity:error-notFound"] +``` + +If the room is private and the player is not a member of the club, the response will contain an error (status 403): + +```json +["clubMemberRole:error-notMember"] +``` + +In some rare cases the response may contain one of the following errors for unknown reasons (status 404): +This is consistent for a given room; and rooms with this error still appear as normal in [get club activities](/live/clubs/activities). + +```json +["playerServer:error-notFound"] +``` + +```json +["room:error-notFound"] ``` diff --git a/docs/live/clubs/room-join-link.md b/docs/live/clubs/room-join-link.md index c50afe4..8e0c626 100644 --- a/docs/live/clubs/room-join-link.md +++ b/docs/live/clubs/room-join-link.md @@ -47,23 +47,28 @@ POST https://live-services.trackmania.nadeo.live/api/token/club/25/room/381929/j If the requested room has been deactivated in the club, the response will contain an error: ```json -[ - "roomServer:error-NoServerAvailable" -] +["roomServer:error-NoServerAvailable"] ``` -If the club or room does not exist, the response will contain an error: +If the club or room does not exist, the response will contain an error (status 404): ```json -[ - "activity:error-notFound" -] +["activity:error-notFound"] ``` -If the requested room is private and the authenticated account is not a member of the club, the response will contain an error: +If the room is private and the player is not a member of the club, the response will contain an error (status 403): ```json -[ - "clubMemberRole:error-notMember" -] +["clubMemberRole:error-notMember"] +``` + +In some rare cases the response may contain one of the following errors for unknown reasons (status 404): +This is consistent for a given room; and rooms with this error still appear as normal in [get club activities](/live/clubs/activities). + +```json +["playerServer:error-notFound"] +``` + +```json +["room:error-notFound"] ``` diff --git a/docs/live/clubs/room-password.md b/docs/live/clubs/room-password.md index 9715c29..a0707c9 100644 --- a/docs/live/clubs/room-password.md +++ b/docs/live/clubs/room-password.md @@ -43,26 +43,31 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/150/room/17541/ge } ``` -If the room does not exist, it's deactivated in the club, or it's not password protected, the response will contain an error: +If the room does not exist, it's deactivated in the club, or it's not password protected, the response will contain an error (status 404): ```json -[ - "activity:error-notFound" -] +["activity:error-notFound"] ``` -If the club does not exist or the authenticated account is not a member of the club, the response will contain an error: +If the club does not exist or the authenticated account is not a member of the club, the response will contain an error (status 403): ```json -[ - "clubMemberRole:error-notMember" -] +["clubMemberRole:error-notMember"] ``` -If the authenticated account does not have enough permissions in the club to get the password, the response will contain an error: +If the authenticated account does not have enough permissions in the club to get the password, the response will contain an error (status 403): ```json -[ - "clubMemberRole:error-notContentCreator" -] +["clubMemberRole:error-notContentCreator"] +``` + +In some rare cases the response may contain one of the following errors for unknown reasons (status 404): +This is consistent for a given room; and rooms with this error still appear as normal in [get club activities](/live/clubs/activities). + +```json +["playerServer:error-notFound"] +``` + +```json +["room:error-notFound"] ``` diff --git a/docs/live/clubs/set-tag.md b/docs/live/clubs/set-tag.md index a1ecf5c..6330e05 100644 --- a/docs/live/clubs/set-tag.md +++ b/docs/live/clubs/set-tag.md @@ -44,10 +44,8 @@ POST https://live-services.trackmania.nadeo.live/api/token/club/131063/tag } ``` -If the club does not exist or the authenticated account is not a member of the club, the response will contain an error: +If the club does not exist or the authenticated account is not a member of the club, the response will contain an error (status 403): ```json -[ - "clubMemberRole:error-notMember" -] +["clubMemberRole:error-notMember"] ``` diff --git a/docs/live/clubs/upload-by-id.md b/docs/live/clubs/upload-by-id.md index 41e0588..ff6c7dd 100644 --- a/docs/live/clubs/upload-by-id.md +++ b/docs/live/clubs/upload-by-id.md @@ -93,10 +93,14 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/42175/bucket/3444 } ``` -If the club or upload activity does not exist, the response will contain an error: +If the club or upload activity does not exist, the response will contain an error (status 404): ```json -[ - "activity:error-notFound" -] +["activity:error-notFound"] +``` + +If the upload activity is private and the player is not a member of the club, the response will contain an error (status 403): + +```json +["clubMemberRole:error-notMember"] ``` diff --git a/docs/live/clubs/uploads.md b/docs/live/clubs/uploads.md index 7fc5fe7..b2bd205 100644 --- a/docs/live/clubs/uploads.md +++ b/docs/live/clubs/uploads.md @@ -113,7 +113,7 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/bucket/item-uploa } ``` -Invalid bucket types will result in an error in the response: +Invalid bucket types will result in an error in the response (status 400): ```json ["type:error-inArray"] diff --git a/docs/live/leaderboards/campaign-club-ranking.md b/docs/live/leaderboards/campaign-club-ranking.md index 8eb0064..7ea13f4 100644 --- a/docs/live/leaderboards/campaign-club-ranking.md +++ b/docs/live/leaderboards/campaign-club-ranking.md @@ -14,7 +14,7 @@ parameters: description: The ID of the group/season required: true - name: clubId - type: string + type: integer description: The ID of the club required: true --- diff --git a/docs/live/leaderboards/campaign-club-top.md b/docs/live/leaderboards/campaign-club-top.md index dc0f96e..444352e 100644 --- a/docs/live/leaderboards/campaign-club-top.md +++ b/docs/live/leaderboards/campaign-club-top.md @@ -14,7 +14,7 @@ parameters: description: The ID of the group/season required: true - name: clubId - type: string + type: integer description: The ID of the club required: true query: @@ -93,15 +93,6 @@ GET https://live-services.trackmania.nadeo.live/api/token/leaderboard/group/dccd } ``` -If the `clubId` is invalid, the response will contain an empty list: - -```json -{ - "top": [], - "clubId": 1239790, - "groupUid": "dccdf820-6a24-4ab1-9078-58fea41282db", - "length": 0 -} -``` +If the `clubId` is invalid, the response will contain an empty list. An invalid `groupUid` results in a `200` response code and an empty response. diff --git a/docs/live/leaderboards/medals.md b/docs/live/leaderboards/medals.md index b75856a..3148a97 100644 --- a/docs/live/leaderboards/medals.md +++ b/docs/live/leaderboards/medals.md @@ -79,14 +79,4 @@ If the `groupUid` is invalid, the response will be an empty object: {} ``` -If the map does not exist, the response will return an empty list of medals: - -```json -{ - "groupUid": "Personal_Best", - "mapUid": "q1kDVh5fq1OCKfyFjJ2QAnB9UW8_fake", - "medals": [ - - ] -} -``` +If the map does not exist, the response will return an empty list of medals. diff --git a/docs/live/leaderboards/player-club-record.md b/docs/live/leaderboards/player-club-record.md index af50ee8..d62985f 100644 --- a/docs/live/leaderboards/player-club-record.md +++ b/docs/live/leaderboards/player-club-record.md @@ -18,7 +18,7 @@ parameters: description: The UID of the map required: true - name: clubId - type: string + type: integer description: The ID of the club required: true --- diff --git a/docs/live/leaderboards/top-club.md b/docs/live/leaderboards/top-club.md index abf7b67..b588a11 100644 --- a/docs/live/leaderboards/top-club.md +++ b/docs/live/leaderboards/top-club.md @@ -18,7 +18,7 @@ parameters: description: The UID of the map required: true - name: clubId - type: string + type: integer description: The ID of the club required: true query: diff --git a/docs/live/map-review/club-submitted.md b/docs/live/map-review/club-submitted.md index 8265e30..9403912 100644 --- a/docs/live/map-review/club-submitted.md +++ b/docs/live/map-review/club-submitted.md @@ -103,10 +103,8 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/103034/map-review } ``` -If the club or map review activity does not exist, the response will contain an error: +If the club or map review activity does not exist, the response will contain an error (status 404): ```json -[ - "activity:error-notFound" -] +["activity:error-notFound"] ``` diff --git a/docs/live/map-review/connect.md b/docs/live/map-review/connect.md index b267880..23444e9 100644 --- a/docs/live/map-review/connect.md +++ b/docs/live/map-review/connect.md @@ -52,7 +52,7 @@ If a dedicated server account is used, the response will contain an error: } ``` -If a map review type does not exist, the response will contain a 403 error: +If a map review type does not exist, the response will contain an error (status 403): ```plain Only official MapReview diff --git a/docs/live/map-review/members-submissions.md b/docs/live/map-review/members-submissions.md index 19ca11f..ecb588f 100644 --- a/docs/live/map-review/members-submissions.md +++ b/docs/live/map-review/members-submissions.md @@ -159,26 +159,20 @@ GET https://live-services.trackmania.nadeo.live/api/token/club/103034/map-review } ``` -If the club does not exist or the authenticated account is not a member of the club, the response will contain an error: +If the club does not exist or the authenticated account is not a member of the club, the response will contain an error (status 403): ```json -[ - "clubMemberRole:error-notMember" -] +["clubMemberRole:error-notMember"] ``` -If the map review activity does not exist, the response will contain an error: +If the authenticated account does not have enough permissions in the club to manage map review activities, the response will contain an error (status 403): ```json -[ - "activity:error-notFound" -] +["clubMemberRole:error-notContentCreator"] ``` -If the authenticated account does not have enough permissions in the club to manage map review activities, the response will contain an error: +If the map review activity does not exist, the response will contain an error (status 404): ```json -[ - "clubMemberRole:error-notContentCreator" -] +["activity:error-notFound"] ``` diff --git a/docs/live/map-review/submitted.md b/docs/live/map-review/submitted.md index b45be79..f6d2888 100644 --- a/docs/live/map-review/submitted.md +++ b/docs/live/map-review/submitted.md @@ -93,10 +93,8 @@ GET https://live-services.trackmania.nadeo.live/api/token/map-review/totd/submit } ``` -If a map review type does not exist, the response will contain an error: +If a map review type does not exist, the response will contain an error (status 404): ```json -[ - "mapReview:error-notFound" -] +["mapReview:error-notFound"] ``` diff --git a/docs/live/map-review/waiting-time.md b/docs/live/map-review/waiting-time.md index d8705e3..d998829 100644 --- a/docs/live/map-review/waiting-time.md +++ b/docs/live/map-review/waiting-time.md @@ -40,7 +40,7 @@ GET https://live-services.trackmania.nadeo.live/api/token/map-review/totd/waitin The `"seconds"` field in the response should be a multiple of 180 seconds (3 minutes). -If a map review type does not exist, the response will contain a 403 error: +If a map review type does not exist, the response will contain an error (status 403): ```plain Only official MapReview diff --git a/docs/live/maps/add-favorite.md b/docs/live/maps/add-favorite.md index 5463b02..19efb80 100644 --- a/docs/live/maps/add-favorite.md +++ b/docs/live/maps/add-favorite.md @@ -35,4 +35,12 @@ POST https://live-services.trackmania.nadeo.live/api/token/map/favorite/EgUgXeBV Both successful and unsuccessful responses have no content and return a `204` response code. -An invalid `mapUid` results in a `500` response code with an error object in the response body. +If the map does not exist, the response will contain an error (status 500): + +```json +{ + "error":"InternalServerError", + "message":"Nadeo Live Services Internal Log", + "traceId":"Root=1-69d40bd6-34cab79440814f711e17f38a" +} +``` \ No newline at end of file diff --git a/docs/live/maps/info.md b/docs/live/maps/info.md index ececa5e..d38f9d3 100644 --- a/docs/live/maps/info.md +++ b/docs/live/maps/info.md @@ -60,12 +60,12 @@ GET https://live-services.trackmania.nadeo.live/api/token/map/QleO8OiNAkIXrZs6r0 } ``` -Example response if the requested map does not exist: +If the map does not exist, the response will contain an error (status 500): ```json { "error": "NotFoundHttpException", - "message": "", + "message": "Nadeo Live Services Internal Log", "traceId": "Root=1-68b47f2d-6c4f97f5124aa8ab32d2914e" } ``` diff --git a/docs/live/maps/remove-favorite.md b/docs/live/maps/remove-favorite.md index 52943e8..8d8c3a2 100644 --- a/docs/live/maps/remove-favorite.md +++ b/docs/live/maps/remove-favorite.md @@ -34,4 +34,12 @@ POST https://live-services.trackmania.nadeo.live/api/token/map/favorite/EgUgXeBV Both successful and unsuccessful responses (including requests for maps that are not part of your favorites) have no content and return a `204` response code. -An invalid `mapUid` results in a `500` response code with an error object in the response body. +If the map does not exist, the response will contain an error (status 500): + +```json +{ + "error":"InternalServerError", + "message":"Nadeo Live Services Internal Log", + "traceId":"Root=1-69d40bd6-34cab79440814f711e17f38a" +} +```