Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update activities.md #23

Merged
merged 2 commits into from
Sep 28, 2024
Merged

Update activities.md #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15801eb
Update activities.md
ezio416 Sep 28, 2024
77e04bf
Update active parameter and remarks
davidbmaier Sep 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/live/clubs/activities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ parameters:
required: true
- name: active
type: Boolean
description: Whether to only include currently active entries
required: true
description: Optional filter for enabled/disabled activities
required: false
---

Gets a list of club activities, including news, rooms, campaigns and others.
Expand All @@ -35,7 +35,7 @@ Gets a list of club activities, including news, rooms, campaigns and others.

**Remarks**:

- For clubs you are not an admin of, `active` needs to be set to `true` because only admins are allowed to see disabled activities. Otherwise you'll get an error complaining that you're not a member/admin of the club.
- Omitting the `active` parameter implicitly requests both enabled and disabled activities. For clubs you are not an admin of, `active` needs to be explicitly set to `true` because only admins are allowed to see disabled activities - otherwise you'll get an error complaining that you're not a member/admin of the club.
- 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).

---
Expand Down
Loading