Repository navigation
Expand file tree
/
Copy pathTeamChallengesapi
More file actions
197 lines (163 loc) Β· 3.94 KB
/
Copy pathTeamChallengesapi
File metadata and controls
197 lines (163 loc) Β· 3.94 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
# π Team Challenges API
RESTful API for managing team and individual challenges in a sports management platform.
### Role Permissions
- **`coach` / `manager`**: Full access (create, update, delete)
- **`athlete` / `parent`**: Read-only access to assigned/viewable challenges
## π API Endpoints
### Get All Team Challenges
```http
GET /api/teamChallenges
```
Retrieve all team challenges accessible to the authenticated user.
**Response:**
```json
[
{
"_id": "666000d529dcab001e9d50b1",
"title": "Sprint Challenge",
"team": "665f3b17c6c3e8e5dbb45a20",
"description": "Run 3km in 15 mins",
"points": 100,
"category": "Fitness",
"status": "active",
"startDate": "2025-06-06T16:39:00.000Z",
"endDate": "2025-06-21T16:39:00.000Z"
}
]
```
### Get My Challenges
```http
GET /api/teamChallenges/my
```
Get all challenges assigned to the logged-in user (athlete/parent).
### Create Challenge
```http
POST /api/teamChallenges
```
**Roles:** `coach`, `manager`
Create a new team or individual challenge.
**Request Body:**
```json
{
"title": "Sprint Challenge",
"type": "team",
"team": "665f3b17c6c3e8e5dbb45a20",
"users": [],
"description": "Run 3km in 15 mins",
"points": 100,
"category": "Fitness",
"status": "active",
"startDate": "2025-06-06T16:39:00.000Z",
"endDate": "2025-06-21T16:39:00.000Z"
}
```
**For Individual Challenges:**
```json
{
"title": "Personal Goal Challenge",
"type": "individual",
"users": ["665f3b17c6c3e8e5dbb45a21", "665f3b17c6c3e8e5dbb45a22"],
"description": "Improve personal best by 10%",
"points": 150,
"category": "Performance",
"status": "active",
"startDate": "2025-06-06T16:39:00.000Z",
"endDate": "2025-06-21T16:39:00.000Z"
}
```
**Response:**
```json
{
"status": "success",
"data": {
"_id": "666000d529dcab001e9d50b1",
"title": "Sprint Challenge",
"type": "team",
"team": "665f3b17c6c3e8e5dbb45a20",
"description": "Run 3km in 15 mins",
"points": 100,
"category": "Fitness",
"status": "active",
"startDate": "2025-06-06T16:39:00.000Z",
"endDate": "2025-06-21T16:39:00.000Z"
}
}
```
### Get Challenge by ID
```http
GET /api/teamChallenges/:id
```
Fetch a specific challenge by its ID.
### Get Team Challenges
```http
GET /api/teamChallenges/team/:teamId
```
Get all challenges for a specific team.
### Get User Challenges
```http
GET /api/teamChallenges/user/:userId
```
Get all challenges assigned to a specific user.
### Update Challenge
```http
PUT /api/teamChallenges/:id
```
**Roles:** `coach`, `manager`
Update an existing challenge.
**Request Body (partial update):**
```json
{
"status": "completed",
"points": 120,
"description": "Updated challenge description"
}
```
### Delete Challenge
```http
DELETE /api/teamChallenges/:id
```
**Roles:** `coach`, `manager`
Delete a challenge by ID.
## ποΈ Challenge Schema
```json
{
"_id": "ObjectId",
"title": "String",
"type": "team | individual",
"team": "ObjectId (if type is team)",
"users": ["ObjectId"],
"description": "String",
"points": "Number",
"category": "String",
"status": "active | in-progress | completed",
"startDate": "Date",
"endDate": "Date",
"createdAt": "Date",
"updatedAt": "Date"
}
```
## π Usage Notes
- Use `type: "individual"` with `users` array for personalized challenges
- Use `type: "team"` with `team` field for group challenges
- Coaches/Managers can only operate on teams they belong to
- Parents can only view challenges assigned to their children
- All dates should be in ISO 8601 format
- Points field defaults to 0 if not specified
- Status defaults to "active" if not specified
## π¨ Error Responses
The API returns standard HTTP status codes:
- `200` - Success
- `201` - Created
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found
- `500` - Internal Server Error
**Error Response Format:**
```json
{
"status": "error",
"message": "Error description",
"code": "ERROR_CODE"
}
```