Skip to content

profile-page.md

Latest commit

 

History

History
65 lines (38 loc) · 2.09 KB

profile-page.md

File metadata and controls

65 lines (38 loc) · 2.09 KB

Design Guide - Profile

Profile Page

Depends where this page is accessed from, if this page is accessed from the top-right profile button, then it is supposed to be your own profile.

However, wherever this page is accessed from, the specific ID of the user is recommended to be used in the URL, instead of using the flexible current user API.

Retrieve User

Call this API to retrieve the user by ID in order to display the profile page. If the user is not authenticated, only a few fields of information will be shown.

GET api/user/user/{int}

Rendering Edit Profile Button

After retrieving the user, call this API to retrieve the current logged-in user and check if the ID matches. If matches, render the edit profile button.

GET api/user/user/me

Update User

After clicking the edit profile button, the user will be redirected to the edit profile page, displaying the form for the user. There is a few fields, but only 6 of these fields below can be edited.

PUT api/user/user/{int}

PATCH api/user/user/{int}

{
    "email": "string",
    "nickname": "string",
    "bio": "string",
    "profile_picture": "image",
    "cover_photo": "image",
    "birthdate": "date"
}

Profile Feed

By visiting anyone's profile, the visitor can see any user's past activities. If the user is not authenticated, activities involving the non-publicly visible communities will be filtered out automatically.

The profile feed is divided into 2 sections, including the current memberships section and the past memberships section.

Current Memberships Section

Call these 4 APIs to retrieve all current memberships of the user.

GET api/membership/membership?user={int}&community_type=club&status=A

GET api/membership/membership?user={int}&community_type=event&status=A

GET api/membership/membership?user={int}&community_type=community_event&status=A

GET api/membership/membership?user={int}&community_type=lab&status=A

The {int} is the ID of the current user.

Past Memberships Section

Call this API to retrieve past memberships of the user.

GET api/membership/membership/past/{int}