API-Documentation

Documentation for National Central University API

Root URL

https://api.cc.ncu.edu.tw

Authorization

Before you making any API calls, you have to register a client at OAuth Management first. There are two situations to use our API:

• Access resources that contains personal information :
  1. Follow the OAuth 2.0 protocol to get an access token, see documentation.
  2. Read the documentation to use access token.
• Access resources without personal information :
  1. Get an api token from OAuth Management.
  2. Read the documentation to use api token.

Internationalization

Some NCU APIs are bilingual(zh-TW, en-US) and default to zh-TW. Use Accept-Language header to specify your language.

Encoding

All strings are encoded in UTF-8.

Endpoints

Activity-Service

/activity/v1

• /activities
• /announces
• /clubs

Location-Service

/location/v1

• /search
• /places
• /units
• /faculties
• /buildings

Course-Service

/course/v1

• /status
• /colleges
• /colleges/{collegeId}/departments
• /departments/{departmentId}/targets
• /departments/{departmentId}
• /courses/{serialNo}
• /courses/{serialNo}/limit
• /courses
• /targets/{targetId}/courses
• /summer/{stage}/courses
• /student/selected
• /student/rejected
• /student/tracking

Personnel-Service

/personnel/v1

• /cards/{cardNumber}
• /info

Calendar-Service

/calendar/v1

• /categories
• /event
• /events

Bus-Service

/bus/v1

• /routes/{routeId}/estimate_times

Error Status Code

HTTP Status Code	Description
400	invalid body or parameter.
401	access a protected resource with an invalid token.
403	access a protected resource with an token from invalid client.
404	resource not found.
405	invalid request method
500	internal server error.

Problems?

If you have any problems, please file a issue or just send us pull requests. Any pull requests submitted to master branch are not allowed, please submit to develop branch. It would be appreciated that with brief descriptions and some unit tests to proof.

Format Reference

The format of this document refer to Documentation for University of Waterloo API.

License

MIT License Copyright © 2015-2015 Computer Center, National Central University