MSC REST API - Documentation

Documentation

All API endpoints are listed below.

AcadPage

API	Description	Link
GET v1/AcadPage?programSlug={programSlug}&slug={slug}	Returns a program page.
GET v1/AcadPage?programId={programId}	Returns all pages associated with a program.

AdmissionsProfile

API	Description	Link
GET v1/AdmissionsProfile/{id}	Get a Profile by Id
GET v1/AdmissionsProfile?type_id={type_id}&include_hidden={include_hidden}&include_unapproved={include_unapproved}&norwich={norwich}	Gets all profiles by type
GET v1/AdmissionsProfile?profile_type={profile_type}&program_id={program_id}&norwich={norwich}	Gets a random profile

AdmissionsProfileType

API	Description	Link
GET v1/AdmissionsProfileType/{id}?include_hidden={include_hidden}&include_unapproved={include_unapproved}&norwich={norwich}	Get a Profile type by Id
GET v1/AdmissionsProfileType?include_hidden={include_hidden}&include_unapproved={include_unapproved}&norwich={norwich}	Gets all profiles types

Alum

API	Description	Link
GET v1/Alum?year={year}&letter={letter}	Returns all alumni matching grad year and letter

AlumniProfile

API	Description	Link
GET v1/AlumniProfile?include_hidden={include_hidden}	Get all AlumniProfiles
GET v1/AlumniProfile/{id}	Get AlumniProfile by id
GET v1/AlumniProfile?featured={featured}	Get random featured alumni profile
GET v1/AlumniProfile?random={random}&limit={limit}	Get random alumni profiles, limiting number of results is optional

AlumState

API	Description	Link
GET v1/AlumState	Returns the list of alumni per state statistics	v1/AlumState

Ambassador

API	Description	Link
GET v1/Ambassador/{id}	Gets an ambassador by id.
GET v1/Ambassador?random={random}&program_id={program_id}	Gets a random ambassador
GET v1/Ambassador?include_hidden={include_hidden}&include_unapproved={include_unapproved}&include_graduated={include_graduated}&program_id={program_id}	Gets all ambassadors

Announcements

API	Description	Link
GET v1/Announcements?type={type}	No documentation available.
GET v1/Announcements/{id}	Get an Announcement by id

Articles

API	Description	Link
GET v1/Articles/{id}	Get a news article by id
GET v1/Articles?cat={cat}&count={count}&max_id={max_id}&since_id={since_id}	Get news articles

Author

API	Description	Link
GET v1/Author	Get Morrisville authors	v1/Author
GET v1/Author/{id}	Get author by id

Buildings

API	Description	Link
GET v1/Buildings?include_photos={include_photos}&include_hidden={include_hidden}&include_hidden_photos={include_hidden_photos}	Get all buildings
GET v1/Buildings/{id}?include_photos={include_photos}&include_hidden_photos={include_hidden_photos}	Get building by id

ButtonBoxes

API	Description	Link
GET v1/ButtonBoxes	Get all ButtonBoxes	v1/ButtonBoxes
GET v1/ButtonBoxes/{id}	Get ButtonBox by id

Calendars

API	Description	Link
GET v1/Calendars	Get all Calendars	v1/Calendars
GET v1/Calendars/{id}	Get Calendar by id
GET v1/Calendars?legacyid={legacyid}	Get Calendar by id

Cancellations

API	Description	Link
GET v1/Cancellations/{id}?type={type}	Get Cancellation by id
GET v1/Cancellations?type={type}	Get all Cancellations of type
GET v1/Cancellations	Get all Cancellations	v1/Cancellations

College

API	Description	Link
GET v1/College?code={code}	Get College by code

CollegeInfo

API	Description	Link
GET v1/CollegeInfo	Get All college information	v1/CollegeInfo
GET v1/CollegeInfo?campus={campus}	Get campus information

CopperAnnouncement

API	Description	Link
GET v1/CopperAnnouncement?include_hidden={include_hidden}	Gets all Announcements
GET v1/CopperAnnouncement/{id}	Gets a announcement by Id

CopperHours

API	Description	Link
GET v1/CopperHours	Gets all Hours	v1/CopperHours
GET v1/CopperHours/{id}	Gets a hours by Id

CopperItemCategory

API	Description	Link
GET v1/CopperItemCategory	Gets all ItemCategories	v1/CopperItemCategory
GET v1/CopperItemCategory/{id}	Gets a itemCategory by Id

CopperMenu

API	Description	Link
GET v1/CopperMenu	Gets all Menus	v1/CopperMenu
GET v1/CopperMenu/{id}	Gets a menu by Id

CopperMenuItem

API	Description	Link
GET v1/CopperMenuItem	Gets all MenuItems	v1/CopperMenuItem
GET v1/CopperMenuItem/{id}	Gets a menuItem by Id
GET v1/CopperMenuItem?sub_menu_id={sub_menu_id}	Gets all MenuItems of a SubMenu

CopperMusic

API	Description	Link
GET v1/CopperMusic	Gets all Musics	v1/CopperMusic
GET v1/CopperMusic/{id}	Gets a music by Id

CopperPage

API	Description	Link
GET v1/CopperPage	Gets all Pages	v1/CopperPage
GET v1/CopperPage/{id}	Gets a page by Id

CopperSpecial

API	Description	Link
GET v1/CopperSpecial?include_hidden={include_hidden}	Gets all Specials
GET v1/CopperSpecial/{id}	Gets a special by Id

CopperSubMenu

API	Description	Link
GET v1/CopperSubMenu	Gets all SubMenus	v1/CopperSubMenu
GET v1/CopperSubMenu/{id}	Gets a subMenu by Id

Counselor

API	Description	Link
GET v1/Counselor	Get all Counselors	v1/Counselor
GET v1/Counselor/{id}	Get Counselor by id
GET v1/Counselor?territory={territory}	Get first Counselor by territory
GET v1/Counselor?territoryId={territoryId}	Get Counselor by territory id

Departments

API	Description	Link
GET v1/Departments	Get all Departments	v1/Departments
GET v1/Departments/{id}?msckey={msckey}	Get Department by id

Dining

API	Description	Link
GET v1/Dining/{id}	Get Dining object by id

DiningLocations

API	Description	Link
GET v1/DiningLocations/{id}	Get DiningLocation by id
GET v1/DiningLocations	Get all DiningLocations	v1/DiningLocations

DocHeadings

API	Description	Link
GET v1/DocHeadings?include_docs={include_docs}	Get DocHeadings
GET v1/DocHeadings/{id}?include_docs={include_docs}&max_subheading_levels={max_subheading_levels}	Get DocHeading by id
GET v1/DocHeadings?section_id={section_id}&include_docs={include_docs}&max_subheading_levels={max_subheading_levels}	Get DocHeadings by section_id

Docs

API	Description	Link
GET v1/Docs?include_heading={include_heading}	No documentation available.
GET v1/Docs/{id}	Get Doc by id
GET v1/Docs?headingid={headingid}	Get Docs by headingid
GET v1/Docs?section_id={section_id}	Get Docs by section_id

Dropdowns

API	Description	Link
GET v1/Dropdowns	Get all Dropdowns	v1/Dropdowns
GET v1/Dropdowns/{id}	Get Dropdown by id

DropdownValues

API	Description	Link
GET v1/DropdownValues	Get all DropdownValues	v1/DropdownValues
GET v1/DropdownValues/{id}	Get DropdownValue by id
GET v1/DropdownValues?dropdownId={dropdownId}&value={value}	Get DropdownValue by Dropdown id and value.
GET v1/DropdownValues?dropdownId={dropdownId}	Gets DropdownValues by Dropdown id

EtcCourse

API	Description	Link
GET v1/EtcCourse	Get all Courses	v1/EtcCourse
GET v1/EtcCourse/{id}	Get Course by id

EtcTestimonials

API	Description	Link
GET v1/EtcTestimonials	Get all Testimonials	v1/EtcTestimonials
GET v1/EtcTestimonials/{id}	Get Testimonial by id
GET v1/EtcTestimonials?random={random}	Get Testimonial at random

Events

API	Description	Link
GET v1/Events/{id}	Get Event by id
GET v1/Events?startdate={startdate}&enddate={enddate}&calid={calid}&embedTerritory={embedTerritory}&onlyTerritories={onlyTerritories}&limit={limit}	Get Events by date range
GET v1/Events?repeatid={repeatid}	Get Events by repeatId

HighSchool

API	Description	Link
GET v1/HighSchool?code={code}	Get HighSchool by code

Pages

API	Description	Link
GET v1/Pages/{id}?trim={trim}	Get Page by id
GET v1/Pages?permalink={permalink}	Get Page by permalink
GET v1/Pages?section_id={section_id}&trim={trim}&show={show}	Get Pages by section id

ParkingLots

API	Description	Link
GET v1/ParkingLots?include_hidden={include_hidden}	Get all Parking Lots
GET v1/ParkingLots/{id}	Get Parking Lot by id

ParkingOverlays

API	Description	Link
GET v1/ParkingOverlays?include_hidden={include_hidden}	Get all Parking Overlays
GET v1/ParkingOverlays/{id}	Get Parking Overlay by id
GET v1/ParkingOverlays?lot_id={lot_id}&include_hidden={include_hidden}	Get all Parking Overlays associated with a Parking Lot

People

API	Description	Link
GET v1/People?msckey={msckey}&include_building={include_building}&include_hidden={include_hidden}	Returns all people within the directory.
GET v1/People/{id}?msckey={msckey}	Looks up a person by ID.
GET v1/People?username={username}&msckey={msckey}	Looks up a person by their username.
GET v1/People?employer_id={employer_id}&msckey={msckey}	Looks up a person by their employer ID 1:State, 2:MAC
GET v1/People?employee_type={employee_type}&msckey={msckey}	Looks up a person by their employee type faculty/staff
GET v1/People?campus={campus}&msckey={msckey}	Looks up people by their campus morrisville/norwich
GET v1/People?searchterms={searchterms}&fallback_search={fallback_search}&msckey={msckey}	Looks up people by searchterm case-insensitive contains within the following fields(username, first name, last name, area, titles, departments, building)
GET v1/People?order_result={order_result}&msckey={msckey}	Get People from usernames
GET v1/People?department={department}&msckey={msckey}	Get People within a department by department name
GET v1/People?department_id={department_id}&msckey={msckey}	Get People within a department by department id

Programs

API	Description	Link
GET v1/Programs?major={major}&include_faculty={include_faculty}	Get Program by major
GET v1/Programs?slug={slug}&include_faculty={include_faculty}	Get Program by shortName
GET v1/Programs/{id}?include_faculty={include_faculty}	Get Program by id
GET v1/Programs?legacy_slug={legacy_slug}&include_faculty={include_faculty}	Get Program by folder
GET v1/Programs?banner_code={banner_code}&include_faculty={include_faculty}	Get Program by BannerCode
GET v1/Programs	Get all Programs	v1/Programs
GET v1/Programs?school_slug={school_slug}	Get Programs by school slug
GET v1/Programs?morrisville={morrisville}&norwich={norwich}	No documentation available.

ProgramTags

API	Description	Link
GET v1/ProgramTags	Get all Program Tags	v1/ProgramTags

Schools

API	Description	Link
GET v1/Schools/{id}	Get School by id
GET v1/Schools?include_hidden={include_hidden}	Get all Schools

ShuttleEvents

API	Description	Link
GET v1/ShuttleEvents	Get all ShuttleEvents	v1/ShuttleEvents
GET v1/ShuttleEvents/{id}	Get ShuttleEvent by id

ShuttleInfo

API	Description	Link
GET v1/ShuttleInfo	Get all ShuttleInfos	v1/ShuttleInfo
GET v1/ShuttleInfo/{id}	Get ShuttleInfo by id

ShuttleRoutes

API	Description	Link
GET v1/ShuttleRoutes	Get all ShuttleRoutes	v1/ShuttleRoutes
GET v1/ShuttleRoutes/{id}	Get ShuttleRoute by id

ShuttleSchedule

API	Description	Link
GET v1/ShuttleSchedule/{id}	Get ShuttleSchedule by id
GET v1/ShuttleSchedule	Get all ShuttleSchedules	v1/ShuttleSchedule

ShuttleStops

API	Description	Link
GET v1/ShuttleStops	Get all ShuttleStops	v1/ShuttleStops
GET v1/ShuttleStops?route_id={route_id}	Get ShuttleStops by route

ShuttleTimes

API	Description	Link
GET v1/ShuttleTimes?stop_id={stop_id}	Get ShuttleTimes by stop
GET v1/ShuttleTimes?stop_id={stop_id}&route_id={route_id}	Get ShuttleTimes by stop and route

Slides

API	Description	Link
GET v1/Slides?page_id={page_id}	Get Slides by page

Song

API	Description	Link
GET v1/Song	Get Song	v1/Song

Tag

API	Description	Link
GET v1/Tag	Get all Tags	v1/Tag

Territories

API	Description	Link
GET v1/Territories	Get Territories	v1/Territories
GET v1/Territories/{id}	Get Territory by id
GET v1/Territories?startdate={startdate}&enddate={enddate}	Get Territories with Events by date range

Testimonials

API	Description	Link
GET v1/Testimonials/{id}	Gets an testimonial by id.
GET v1/Testimonials?random={random}&program_id={program_id}	Gets a random testimonial
GET v1/Testimonials?program_id={program_id}&include_hidden={include_hidden}	Gets by program id

TourCategories

API	Description	Link
GET v1/TourCategories?include_sub_cats={include_sub_cats}&include_videos={include_videos}&include_links={include_links}	Get all categories
GET v1/TourCategories/{id}?include_sub_cats={include_sub_cats}&include_videos={include_videos}&include_links={include_links}	Get category by id
GET v1/TourCategories?sub_cat_id={sub_cat_id}&include_sub_cats={include_sub_cats}&include_videos={include_videos}&include_links={include_links}	Get categories by subcategory
GET v1/TourCategories?video_id={video_id}&include_sub_cats={include_sub_cats}&include_videos={include_videos}&include_links={include_links}	Get categories by video

TourLinks

API	Description	Link
GET v1/TourLinks/{id}	Get links by id
GET v1/TourLinks	Get all links	v1/TourLinks
GET v1/TourLinks?sub_cat_id={sub_cat_id}	Gets links by subcategory

TourSubCategories

API	Description	Link
GET v1/TourSubCategories/{id}?include_videos={include_videos}&include_links={include_links}	Get subcategory by id
GET v1/TourSubCategories?video_id={video_id}&include_videos={include_videos}&include_links={include_links}	Get subcategories by video

TourVideos

API	Description	Link
GET v1/TourVideos/{id}	Get videos by id
GET v1/TourVideos	Get videos by ids
GET v1/TourVideos?sub_cat_id={sub_cat_id}	Gets videos by subcategory
GET v1/TourVideos?cat_id={cat_id}	Gets videos by category

VisitOption

API	Description	Link
GET v1/VisitOption/{id}	Get Visit Option By ID
GET v1/VisitOption	Git visit options by ids

VisitSlot

API	Description	Link
GET v1/VisitSlot/{id}	Get VisitSlot by id
GET v1/VisitSlot?month={month}&year={year}&showAll={showAll}	Get VisitSlots by month

Copyright © Morrisville State College