intranet.apps.api package

Submodules

intranet.apps.api.authentication module

class intranet.apps.api.authentication.ApiBasicAuthentication

Bases: BasicAuthentication

authenticate_credentials(userid, password, request=None)

Authenticate the userid and password.

class intranet.apps.api.authentication.CsrfExemptSessionAuthentication

Bases: SessionAuthentication

enforce_csrf(request)

intranet.apps.api.tests module

class intranet.apps.api.tests.ApiTest(methodName='runTest')

Bases: IonTestCase

Tests for the api module.

get_api_eighth_block_list(query='')

get_api_eighth_signup_list(query='')

make_token()

setUp()

test_api_bus_detail()

test_api_bus_list()

test_api_eighth_block_list()

test_api_eighth_signup_list()

test_api_root()

test_api_schedule_detail()

test_get_announcements()

test_get_emerg()

test_get_profile()

test_no_credentials_read()

test_oauth_client_credentials_read()

test_oauth_client_credentials_read_anonymous()

test_oauth_read()

test_oauth_write()

intranet.apps.api.urls module

intranet.apps.api.utils module

intranet.apps.api.utils.custom_exception_handler(exc, context)

intranet.apps.api.views module

intranet.apps.api.views.api_root(self, request, *args, **kwargs)

Welcome to the Ion API!

Documentation is below. <pk> refers to the unique id of a certain object - this is shown as “id” in most lists and references. The general form of the API link (with /api/ assumed to be prepended) is shown, along with an example URL. All of the API methods, except for those relating to the Bell Schedule, require authentication.

Use of the Ion API is subject to the TJHSST Intranet API and OAuth Acceptable Use Policy, which can be found at https://ion.tjhsst.edu/docs/api-oauth-aup. Activity inconsistent with the AUP may result in revocation of API and/or OAuth access. All API activity is logged and monitored, and may be used to identify and investigate violations of the AUP.

intranet.apps.api.views.perma_reverse(request, view, *args, **kwargs)

Module contents