Documentation for National Central University API
Switch branches/tags
Nothing to show
Clone or download
Latest commit 29405a7 Jun 24, 2016
Permalink
Failed to load latest commit information.
activity-service/v1 update api Jul 30, 2015
bus-service/v1 fix typo Dec 30, 2015
calendar-service/v1 fix tables Nov 6, 2015
course-service/v1 update api Jul 30, 2015
location-service/v1 update api Jul 30, 2015
oauth-service update oauth scope Jul 12, 2015
personnel-service/v1 fix typo Nov 3, 2015
LICENSE.md add LICENSE.md Mar 2, 2015
README.md add bus api Dec 30, 2015

README.md

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

Location-Service

/location/v1

Course-Service

/course/v1

Personnel-Service

/personnel/v1

Calendar-Service

/calendar/v1

Bus-Service

/bus/v1

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