Get
Obtain all user info
GET /users/{username} : Obtain all user informationExample Request
This is a protected route, a valid JWT is required in the header field
Header
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1OTU4MjQyNzUsImlhdCI6IjIwMjAtMDctMjdUMDA6MjY6MTUuNzg5NTg0Mi0wNDowMCIsInN1YiI6ImNocmlzIn0.5US2_ITKcfgkpEbfsR-gxXbGPFY6XsgJPcGA5qaBD1M
Possible Responses
Immediate Success
{
"code": 1,
"message": "user found",
"data": {
"email": "example@email.com",
"manages": [
{
"id": 1,
"name": "Cool Club",
"email": "coolClub@email.com",
"bio": "Cool Club",
"size": 15,
"logo": "/photos/club/1",
"tags": [
{
"id": 4,
"name": "Computer Science",
"isActive": true
},
{
"id": 10,
"name": "Arts",
"isActive": true
}
],
"hosts": [
{
"id": 40,
"name": "Annual Barbecue",
"description": "Burgers, Hotdogs and more!",
"datetime": "2020-10-25T04:10:30-04:00",
"location": "The Park",
"fee": 10
}
],
"isOwner": true
},
{
"id": 2,
"name": "Club2",
"email": "club2@email.com",
"bio": "Club2!",
"size": 20,
"logo": "/photos/club/2",
"tags": [],
"hosts": [],
"isOwner": false
}
],
"tags": [
{
"id": 1,
"name": "Mathematics",
"isActive": true
},
{
"id": 3,
"name": "Physics",
"isActive": true
},
{
"id": 11,
"name": "Robotics",
"isActive": true
}
],
"attends": [
{
"id": 40,
"name": "Annual Barbecue",
"description": "Burgers, Hotdogs and more!",
"datetime": "2020-10-25T04:10:30-04:00",
"location": "The Park",
"fee": 10
},
{
"id": 41,
"name": "Cheese Festival",
"description": "Cheese Cheese Cheese!",
"datetime": "2020-11-30T04:10:30-04:00",
"location": "Cheeseland",
"fee": 0
}
],
"swiped": [
{
"id": 579,
"name": "Robotics Club",
"email": "robotics@email.com",
"bio": "Robots!",
"size": 15,
"logo": "/photos/club/579",
"tags": [
{
"id": 11,
"name": "Robotics",
"isActive": true
}
],
"hosts": []
}
]
}
}
Note: DateTimes are returned in the RFC3339 format in UTC (with the EST time difference).
Failure
{
"code": -1,
"message": "Forbidden",
"data": {}
}
Obtain user managed clubs
GET /users/{username}/manages : Obtain all clubs that a user managesExample Request
This is a protected route, a valid JWT is required in the header field
Header
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1OTU4MjQyNzUsImlhdCI6IjIwMjAtMDctMjdUMDA6MjY6MTUuNzg5NTg0Mi0wNDowMCIsInN1YiI6ImNocmlzIn0.5US2_ITKcfgkpEbfsR-gxXbGPFY6XsgJPcGA5qaBD1M
Possible Responses
Immediate Success
{
"code": 1,
"message": "user found",
"data": {
"manages": [
{
"id": 4,
"name": "Fantastic Club",
"email": "FantasticClub@email.com",
"bio": "Fantastic!",
"size": 20,
"logo": "/photos/club/4",
"tags": [],
"hosts": [
{
"id": 2,
"name": "Fantastic Event",
"description": "A very good event",
"datetime": "2020-08-24T04:10:30-04:00",
"location": "In-Person",
"fee": 30
}
],
"isOwner": true
}
]
}
}
Note: DateTimes are returned in the RFC3339 format in UTC (with the EST time difference).
Failure
{
"code": -1,
"message": "Forbidden",
"data": {}
}
Obtain user attended events
GET /users/{username}/attends : Obtain all events that a user will attendExample Request
This is a protected route, a valid JWT is required in the header field
Header
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1OTU4MjQyNzUsImlhdCI6IjIwMjAtMDctMjdUMDA6MjY6MTUuNzg5NTg0Mi0wNDowMCIsInN1YiI6ImNocmlzIn0.5US2_ITKcfgkpEbfsR-gxXbGPFY6XsgJPcGA5qaBD1M
Possible Responses
Immediate Success
{
"code": 1,
"message": "user found",
"data": {
"attends": [
{
"id": 40,
"name": "Annual Barbecue",
"description": "Burgers, Hotdogs and more!",
"datetime": "2020-10-25T04:10:30-04:00",
"location": "The Park",
"fee": 10
}
]
}
}
Note: DateTimes are returned in the RFC3339 format in UTC (with the EST time difference).
Failure
{
"code": -1,
"message": "Forbidden",
"data": {}
}