Add documentation of club / activity error message status codes

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
 

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
-}
-```

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
-}
-```

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
 {

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
-}
-```

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
-}
-```

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
-}
-```

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"]
 ```

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"]
 ```

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"]
 ```

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.

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"]
 ```

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"]
 ```

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.

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).

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"]

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
-}
-```

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"]
 ```