AcademicControlsControlDatesWS

This service provides information about controldates. Controls dates are used to manage events in the system and mark boundaries for different types of activities.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/legacy/academic/controls/controldatesws

Version: v1

Default response content-types: application/json, application/xml
Schemes: https

Summary

Path Operation Description
/all/{date_type} GET

Get all instances of a control date

/asofdate/{as_of_date}/{+date_type} GET

Get control dates for a given date

/range/{year_term_start},{year_term_end}/{date_type} GET

Get range of instances of a control date

/registration GET

Get the current_yyt control date to expose which year terms are currently open for registration

/yearterm/{year_term}/{+date_type} GET

Get control dates for a given year term

Paths

Get all instances of a control date

GET /all/{date_type}

Tags: ControlDatesService

Get all instances of a control date

date_type

The type of date

path string

Uses default content-types: application/json application/xml

200 OK

Provides a full list for a given control date

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/all/current_yyt",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"date_list": [
{
"date_type": "CURRENT_YYT",
"description": "day after prev finals to last day of finals",
"end_date": "19000322 23:59:59",
"start_date": "19000101 00:00:00",
"year_term": "19001",
"year_term_desc": "Winter 1900"
}
]
,
"request_count": 476
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get control dates for a given date

GET /asofdate/{as_of_date}/{+date_type}

Tags: ControlDatesService

Get control dates for a given date

as_of_date

Determines a given date

path string
+date_type

The type of date, can have up to 10 separated by commas

path string

Uses default content-types: application/json application/xml

200 OK

List of date types for a given year term.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/all/current_yyt",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"date_list": [
{
"date_type": "CURRENT_YYT",
"description": "day after prev finals to last day of finals",
"end_date": "19000322 23:59:59",
"start_date": "19000101 00:00:00",
"year_term": "19001",
"year_term_desc": "Winter 1900"
}
]
,
"request_count": 476
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get range of instances of a control date

GET /range/{year_term_start},{year_term_end}/{date_type}

Tags: ControlDatesService

Get range of instances of a control date

year_term_start

The start of the time period

path string
year_term_end

The end of the time period

path string
date_type

The type of date

path string

Uses default content-types: application/json application/xml

200 OK

Range list for a control date

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/all/current_yyt",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"date_list": [
{
"date_type": "CURRENT_YYT",
"description": "day after prev finals to last day of finals",
"end_date": "19000322 23:59:59",
"start_date": "19000101 00:00:00",
"year_term": "19001",
"year_term_desc": "Winter 1900"
}
]
,
"request_count": 476
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get the current_yyt control date to expose which year terms are currently open for registration

GET /registration

Tags: ControlDatesService

Get the current_yyt control date to expose which year terms are currently open for registration

Uses default content-types: application/json application/xml

200 OK

Get the current_yyt control date to expose which year terms are currently open for registration

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/all/current_yyt",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"date_list": [
{
"date_type": "CURRENT_YYT",
"description": "day after prev finals to last day of finals",
"end_date": "19000322 23:59:59",
"start_date": "19000101 00:00:00",
"year_term": "19001",
"year_term_desc": "Winter 1900"
}
]
,
"request_count": 476
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Get control dates for a given year term

GET /yearterm/{year_term}/{+date_type}

Tags: ControlDatesService

Get control dates for a given year term

year_term

Year and term desired

path string
+date_type

The type of date, can have up to 10 separated by commas

path string

Uses default content-types: application/json application/xml

200 OK

List of date types that are/were active as of a certain date.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/all/current_yyt",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"date_list": [
{
"date_type": "CURRENT_YYT",
"description": "day after prev finals to last day of finals",
"end_date": "19000322 23:59:59",
"start_date": "19000101 00:00:00",
"year_term": "19001",
"year_term_desc": "Winter 1900"
}
]
,
"request_count": 476
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Schema definitions

ControlDatesWSService: object

request: request
response: response

date_list: object[]

object
date_type: date_type
year_term: year_term
year_term_desc: year_term_desc
start_date: start_date
end_date: end_date
description: description

date_type: string

description: string

end_date: string

request: object

method: string
resource: string
attributes: string
status: number
statusMessage: string

request_count: number

response: object

request_count: request_count
date_list: date_list

start_date: string

year_term: string

year_term_desc: string

Service Path: 
/domains/legacy/academic/controls/controldatesws
Domain or University API: 
/domains/D/academic/controls/controldatesws

Community

 

Don't see your question listed here? Ask!