iSchool Site API Reference

This is a full list of the API root nodes. Each root node represents a section of content for the website. All nodes return json data. All nodes can be queried further based on their key values/child nodes. For a query which has multiple filters, the order of the path is important without which you will receive an empty json object/incorrect data. Study each node thoroughly to avoid this. In order to get all fields in a section (all the sub-root nodes and all the subsequent childnodes) query using api/root-node/. If the child node consists of unnamed objects, they can be queried using name=value. Only nodes with name-value pairs can be used to query the api. Please note that an array of values cannot be queried.

For example: looking at the api/degrees/ endpoint, queries could look like (in increasing granularity):

  1. https://ischool.gccis.rit.edu/api/degrees/
  2. https://ischool.gccis.rit.edu/api/degrees/graduate/
  3. https://ischool.gccis.rit.edu/api/degrees/undergraduate/
  4. https://ischool.gccis.rit.edu/api/degrees/undergraduate/degreeName=cit

Please use the data given below to make your queries to the API.

Nodes Description
About

The About section is a short introduction to our website. To query for all fields in this section use : api/about/

    The following sub-root nodes exist in this section:
  • title
  • description
  • quote
  • quoteAuthor
Degrees

The degrees section lists out the type of graduate and undergraduate degrees offered by the department. To filter your request, use api/degrees/{field-name}. Example of a request: api/degrees/undergraduate/degreeName=cit

Working: https://ischool.gccis.rit.edu/api/degrees/undergraduate/degreeName=cit

    The following sub-root nodes exist in this section:
  • undergraduate
  • graduate
    Each child node has the following fields to be queried:
  • degreeName
  • title
  • description
  • concenteration
Minors

The minors section lists out the type of undergraduate minors offered by the department. To filter your request, use api/minors/UgMinors/{field-name}. Example of a request: api/minors/UgMinors/name=DBDDI-MN

Working: https://ischool.gccis.rit.edu/api/minors/UgMinors/name=DBDDI-MN

This will return all information with regards to the "Database Design, Development, and Implementation" minor.
    Each child node has the following fields to be queried:
  • name
  • title
  • description
  • courses

Note: In order to get more information on any of the courses specifically, you can use api/course/courseID={course-name}. For e.g. api/course/courseID=CSEC-101. For more information see the courses section below.
Employment The employment section refers to the history of co-op and full-time employment information of the current and past students in the department. It also lists out general statistics like average salary,ranking etc.

To query this section use api/employment/{field-name}

An example of using this can be api/employment/coopTable/coopInformation/employer=Skyvo

Working: https://ischool.gccis.rit.edu/api/employment/coopTable/coopInformation/employer=Skyvo

    The sub-root nodes are :
  • introduction
  • degreeStatistics
  • employers
  • careers
  • coopTable
  • employmentTable

Note: The employment section could use a map, marking the places where our students work/have worked. If you want a challenge/extra points, you can build your own map using the google maps api with all the employment data provided above.

If you want to build your own map, use Locations to place the pins.

People The people section includes all information about the faculty and staff of the department.

To query this field use, api/people/{field-name}.

People node comprises of faculty and staff nodes. Faculty and Staff can be queried with their RIT usernames.

For example to query for Daniel Bogaard, you will have to use the path: api/people/faculty/username=dsbics

Working: https://ischool.gccis.rit.edu/api/people/faculty/username=dsbics

    The sub-root nodes are :
  • username
  • name
  • tagline
  • imagePath
  • title
  • interestArea
  • office
  • website
  • phone
  • email
  • twitter
  • facebook

Note: In order to get the images for the people in our department , use the absolute path provided in the json. For example: use https://ischool.gccis.rit.edu/api/assets/img/people/dsbics.jpg for Daniel Bogaard.

Course

In order to get individual course information use api/course/courseID={course-name}

An example of a query to this section will be api/course/courseID=ISTE-340

Working: https://ischool.gccis.rit.edu/api/course/courseID=ISTE-340

This is for completeness, the below are not required for the project.

Nodes Description
Research The research section returns two sub-root nodes,
  • byInterestArea
  • byFaculty
To filter your request for this section, use api/research/{field-name}.

Research by interest area gives information regarding all ongoing/past research in a particular field of interest like:

HCI, Education, Geo, Analytics, Networking, Mobile, etc.

Research by faculty gives information regarding all ongoing/past research of the faculty members in the department

An example of a query to this section will be api/research/byInterestArea/areaName=Geo

Working: https://ischool.gccis.rit.edu/api/research/byInterestArea/areaName=Geo

Resources All information included in the Resources section.To filter your request, use api/resources/{field-name}.
    The sub-root nodes are :
  • title
  • subTitle
  • studyAbroad
  • studentServices
  • tutorsAndLabInformation
  • studentAmbassadors
  • forms
  • coopEnrollment

An example of a query to this section would be /api/resources/studyAbroad/places/nameOfPlace=Dubrovnik,%20Croatia

Working: https://ischool.gccis.rit.edu/api/resources/studyAbroad/places/nameOfPlace=Dubrovnik,%20Croatia

News All information included in the News section.To filter your request, use api/news/{field-name}. The json will return following sub-root nodes :
  • year
  • older

The 'older' node signifies all news items which are more than a year old.

This section might contain monthor quarter root nodes if there is any news item available in that time frame.

An example of a query to this section will be api/news/year/date=2015-09-08 16:33:58

Working: https://ischool.gccis.rit.edu/api/news/older/date=2015-09-08 16:33:58

Footer All information included in the Footer section. To filter your request, use api/footer/{field-name}. The following sub-root nodes exist in this section:
  • social
  • quickLinks
  • copyright
  • news

An example of a query to this section will be

Working: https://ischool.gccis.rit.edu/api/footer/quickLinks/title=Apply%20Now

Courses

This node returns all courses available by a particular degree. To use this node query api/courses/degreeName={name of degree} For e.g. api/courses/degreeName=BSCIT will return list of courses offered by the BSCIT degree.

Working: https://ischool.gccis.rit.edu/api/courses/degreeName=BSCIT

Maps Returns the employment map which can be used directly.Does not return json.

To query this section use /api/map/

Working: https://ischool.gccis.rit.edu/api/map/