Endpoints

The following is a list of endpoints on the server that you may access. Endpoints with {...} on them should have those be substituted with the appropriate data.

Endpoint	Method
/user/login	POST
/user/signup	POST
/user/profile/{user_id}	GET
/post/{post_id}	GET
/post/{post_id}/media	GET
/post/publish	POST
/post/publish/{post_id}/media	POST
/post/user/{user_id}	POST
/media/{media_id}	GET
/media/video/{filename}	GET

/user/login

This POST endpoint asks for a JSON containing login information then sends back verification information about the sent login information.

/user/signup

This POST endpoint asks for a JSON containing signup information then sends back success and verification information about the sent signup information.

/user/profile/{user_id}

This GET endpoint is used to gather profile data of the user with the userid, {user_id}.

/post/{post_id}

This GET endpoint is used to fetch post information except for media.

TIP

Should media be needed after making a request to this endpoint, one should make a follow-up GET request to /post/{post_id}/media to gather the needed media IDs. The actual media files should then be gathered by making a GET request to /media/{media_id} using the media IDs that were retreived from the previous request.

/post/{post_id}/media

This GET endpoint is used to fetch a list of media IDs related to a post with the post ID, {post_id}.

/post/publish

This POST endpoint asks for a JSON containing post data except for media. A post will be generated on the server and published. Assuming that the success status of the request is "success", the Response will contain post information about the created post.

TIP

The post information that comes with the response from this endpoint will contain the post's post_id which can be used to make follow-up requests.

/post/publish/{post_id}/media

This POST endpoint serves as a follow-up request endpoint for uploading media for a previously sent /post/publish request. This endpoint only accepts one media file at a time. So if a post has multiple media files, multiple requests to this endpoint should be made.

/post/user/{user_id}

This POST endpoint is used to gather post IDs related to the user with the user ID, {user_id}. This endpoint asks for a JSON which contains a list of "loadedIds". This tells the server that the client already gathered information about these posts, and should not be included in the response.

/media/{media_id}

This GET endpoint is used to get a media file from the server. This endpoint's generated response will contain a JSON containing the file's filename and raw byte data.

/media/video/{filename}

This GET endpoint is used to get a video file from the server. This endpoint's generated response will contain the raw byte data of the video file.