BYU ControlDatesWS Service API
(Adapted from documentation provided by BYU Office of Information Technology)

Description

This service provides information about control dates. Controls dates are used to manage events in the system and mark boundaries for different types of activities. For example, if I wanted to know what the registration boundary was for specific semester or term I would look at the REGISTRATION control date for that year term. The start and end dates in that record would mark the beginning and ending of registration for that semester or term. The same applies to identifying the first day of class (CURRICULUM), when the class schedule for a given semester becomes visible to the public (PUBLIC_VIEW), etc.

Author

Bill Cope, OIT Core Services.

Date Created : Last Changed

March 7, 2011 : March 9, 2016.

Authentication

This is public information; therefore it does NOT require authentication.

Authorization

This is public information; therefore it does NOT require authorization.

Usage

BASE URI: https://ws.byu.edu/rest/v1/academic/controls/controldatesws

Options (following base URI):
/{output-format}/{date-clarifier}[/{year-term-code|date-range|date}]/{date-request-type}[,{date-request-type},{date-request-type}...]

OPTIONS:

{output-format} is xml or json. If this option is omitted, xml is returned.

{date-clarifier} is one of:
	all - [no following date required; returns all available semesters past and future]
	range - next option must be {date-range}, eg. 20161,20165
	yearterm - next option must be {year-term-code}, eg. 20163
	asofdate - next option must be {date}, eg. 20160307
	registration - gives currently available registration dates for all available semesters past and future

	{year-term-code} is YYYYN
	Where N is one of:
	1 = Winter
	3 = Spring
	4 = Summer
	5 = Fall
  e.g., 20161 is Winter 2016
  
	{date-range} is {year-term-code},{year-term-code}; eg. 20161,20165
  
	{date} format is YYYYMMDD, where YYYY is the full year, MM is the month and DD is the day. July 4, 2011 would be represented as 20110704 (need to include leading zeros for day or month when less than 10).

{date-request-type} is one of:
	class_dates - 1st day of class to last day of class
	final_dates - 1st day of finals to last day of finals
	curriculum - Year terms for admissions (no gap like <strike>curriculum</strike> semester)
	current_yyt - day after prev finals to last day of finals, 4 yrt
	semester - 1st day of cls to last day of finals
	registration - First date registration opens through add deadline for the term
	public_view - first date class schedule is visible for this semester
	class block1 - 1st day of block 1 to last day of block 1 (note: encode space as %20)
 	class block2 - 1st day of block 2 to last day of block 2 (note: encode space as %20)
 	class dates sprummer - 1st day of class to last day of class for spring or summer term (note: encode spaces as %20--class%20dates%20sprummer)
 	final_dates_sprummer - 1st day of finals to last day of finals for spring or summer term
 

Examples:

Return First and last days of class for Winter 2016, as json:
https://ws.byu.edu/rest/v1/academic/controls/controldatesws/json/yearterm/20161/class_dates

Return First and last days of finals for Winter 2016, as json:
https://ws.byu.edu/rest/v1/academic/controls/controldatesws/json/yearterm/20161/final_dates

Given current date, return information for current year term, as xml:
https://ws.byu.edu/rest/v1/academic/controls/controldatesws/xml/asofdate/20160307/current_yyt

Return curriculum and semester dates for all terms in 2016, as xml:
https://ws.byu.edu/rest/v1/academic/controls/controldatesws/xml/range/20161,20165/curriculum,semester

Return curriculum dates for all years and terms since 1900, as json:
https://ws.byu.edu/rest/v1/academic/controls/controldatesws/json/all/curriculum

Returns the data for the curriculum, final_dates, class_dates and semester control dates that are/were in effect as of March 8, 2016, as xml:
https://ws.byu.edu/rest/v1/academic/controls/controldatesws/xml/asofdate/20160308/curriculum,final_dates,class_dates,semester

Output

XML output schema for all XML control date requests. If more than one date type is returned then the output would have multiple <date_row> entries. To view sample output, use XML test cases above.

<ControlDatesWSService xsi:schemaLocation="uri:[location]/service.xsd">
 <request>
  <method>
  <resource>
  <attributes>
  <status>
  <statusMessage>
 </request>
 <response>
  <request_count>
  <date_list>
   <date_row>
    <date_type>
    <year_term>
    <start_date>
    <end_date>
    <description>
   </date_row>
  </date_list>
 </response>
</ControlDatesWSService>


JSON output schema for JSON control date requests. if more than one date type request is returned then the output would have multiple arrays within the date_list entry. To view sample output, use json test cases above.

{
  "ControldateswsService" : {
    "request" : {
      "method" : "GET",
      "resource" : "",
      "attributes" : null,
      "status" : 200,
      "statusMessage" : ""
    },
    "response" : {
      "request_count" : 0,
      "date_list" : [
        {
          "date_type" : "",
          "year_term" : "",
          "year_term_desc" : "",
          "start_date" : "",
          "end_date" : "",
          "description" : ""
        }
      ]
    }
  }
}


Support Info

Office of Information Technology

The Support Contact listed below will provide information about how to use the web service, how to get access to the web service, and can confirm the proper operation of the web service. Support is provided: 24x7 for production down issues; 8:00 AM - 5:00 PM MST, M-F, Holidays Excluded for new consumer assistance.

Primary Support Contact:
Name: Office of IT
Office Phone: 801-422-4000
E-mail: it@byu.edu

Collaboration Contact(s):
Name: Bill Cope
Office Phone: 801-420-1684
E-mail: bill_cope@byu.edu