intelligent-EMB API (1.0.0)

Download OpenAPI specification:Download

Introduction

This is the official intelligent-EMB API documentation, created for users to interact with https://iemb.hci.edu.sg programmatically.. We are not affiliated with nor do we represent the school.

Login

Operations associated with logging in

Login user

Obtain verification tokens, session ids and authentication tokens.

query Parameters

username required	string Username of user you are logging in
password required	string Password of user you are logging in

Responses

Response samples

200
400
500

Content type

application/json

{"success": true,
"VERI_TOKEN_COOKIE": "...",
"SESSION_ID": "...",
"AUTH_TOKEN": "..."
}

Board

Operations associated with iemb boards

Get board

Retrieve a board from Inbox, My Messages, Updated Messages and My Drafts.

Authorizations:

(Verification TokenAuthentication TokenSession ID)

query Parameters

veriToken required	string Verification Token
authToken required	string Authentication Token
sessionID required	string Session ID
boardID required	string Board ID
t	string Default: "0" type - 0, 1, 2, 3 for Inbox, Updated Messages, My Messages and My Drafts respectively
postBy	string Filter posts by author (Only works for t=2)

Responses

Response samples

200
400
401
500

Content type

application/json

{"success": true,
"name": "Rasis Man",
"message": "Messages fetched!",
"messages": [{"date": "03-Feb-22",
"sender": "RASIS MAN,",
"username": "rasism,",
"subject": "Why I'm called Rasis Man ,",
"url": "/Board/content/69420?board=1048&isArchived=False,",
"boardID": "1048,",
"pid": "69420,",
"urgency": "Important,",
"recipient": "2022 JC1 IP & DSA;,",
"viewCount": "3842",
"replyCount": "992",
"read": true
}
]
}

Get archived board

Retrieve a board from Archived.

Authorizations:

(Verification TokenAuthentication TokenSession ID)

query Parameters

veriToken required	string Verification Token
authToken required	string Authentication Token
sessionID required	string Session ID
boardID required	string Board ID
page	string Default: "1" Page
sender	string Filter posts by sender
subject	string Filter posts by subject
content	string Filter posts by content

Responses

Response samples

200
400
401
500

Content type

application/json

{"success": true,
"name": "Rasis Man",
"message": "Messages fetched!",
"messages": [{"date": "03-Feb-22",
"sender": "RASIS MAN,",
"username": "rasism,",
"subject": "Why I'm called Rasis Man ,",
"url": "/Board/content/69420?board=1048&isArchived=False,",
"boardID": "1048,",
"pid": "69420,",
"urgency": "Important,",
"recipient": "2022 JC1 IP & DSA;,",
"viewCount": 3842,
"replyCount": 992,
"read": true
}
],
"totalPages": "69",
"currentPage": "1"
}

Get starred board

Retrieve a board from Starred.

Authorizations:

(Verification TokenAuthentication TokenSession ID)

query Parameters

veriToken required	string Verification Token
authToken required	string Authentication Token
sessionID required	string Session ID
boardID required	string Board ID
page	string Default: "1" Page

Responses

Response samples

200
400
401
500

Content type

application/json

{"success": true,
"name": "Rasis Man",
"message": "Messages fetched!",
"messages": [{"date": "03-Feb-22",
"sender": "RASIS MAN,",
"username": "rasism,",
"subject": "Why I'm called Rasis Man ,",
"url": "/Board/content/69420?board=1048&isArchived=False,",
"boardID": "1048,",
"pid": "69420,",
"urgency": "Important,",
"recipient": "2022 JC1 IP & DSA;,",
"viewCount": 3842,
"replyCount": 992,
"read": true
}
],
"totalPages": "69",
"currentPage": "1"
}

Post

Operations associated with iemb posts

Get post

Retrieve a post.

Authorizations:

(Verification TokenAuthentication TokenSession ID)

query Parameters

veriToken required	string Verification Token
authToken required	string Authentication Token
sessionID required	string Session ID
boardID required	string Board ID
pid required	string Post ID

Responses

Response samples

200
400
401
500

Content type

application/json

{"success": true,
"message": "Post successfully fetched!",
"post": "...",
"attachments": [{"url": "Board/showFile?t=2&ctype=1&id=95326&file=dummy.pdf&boardId=1048",
"fileName": "dummy.pdf",
"fileType": "2",
"fileID": "95326",
"boardID": "1048",
"cotainerType": "1"
}
],
"postInfo": {"title": "You're so cute",
"sender": "LIU JIASHU",
"receiver": "EVERYONE",
"date": "February 02, 2022 09:54:42 PM"
},
"postReply": {"canReply": true,
"selection": "A",
"text": "I really agree with this statement"
}
}

Download attachment

Download attachment from post

Authorizations:

(Verification TokenAuthentication TokenSession ID)

Request Body schema: application/x-www-form-urlencoded

veriToken	string Verification Token
authToken	string Authentication Token
sessionID	string Session ID
	object Attachment Info (See getPost example)

Responses

Response samples

400
401
500

Content type

application/json

{"success": false,
"message": "Missing parameters"
}

Reply to post

Reply to a post

Authorizations:

(Verification TokenAuthentication TokenSession ID)

query Parameters

veriToken required	string Verification Token
authToken required	string Authentication Token
sessionID required	string Session ID
boardID required	string Board ID
pid required	string Post ID
replyContent	string Content to reply with
selection	string Option to reply with

Responses

Response samples

200
400
401
500

Content type

application/json

{"success": true,
"message": "Successfully replied"
}

Star / Unstar a post

Update the "starred" status of a post

Authorizations:

(Verification TokenAuthentication TokenSession ID)

query Parameters

veriToken required	string Verification Token
authToken required	string Authentication Token
sessionID required	string Session ID
bid required	string Board ID
pid required	string Post ID
status required	boolean Status

Responses

Response samples

200
400
401
500

Content type

application/json

{"success": true,
"message": "Successfully starred message"
}