AcademicControlsControlDates

AcademicControlsControlDates

This service provides information about control dates in the AIM System. 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 (CLASS_DATES), when the class schedule for a given semester becomes visible to the public (PUBLIC_VIEW), etc.

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

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

Version: v1

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

Summary

Path Operation Description
/ GET

Shows a list of valid owners
/delete/{date_owner}/{date_type}/{year_term} DELETE

Deletes a control date.
/documentation GET

service definition
/{date_owner} GET

Shows a list of valid types of a specified owner.
/{date_owner}/{date_type} GET

Shows a list of control dates specified by the owner and type.
/{date_owner}/{date_type}/{year_term} GET

Shows a list of control dates specified by the owner and type from the specified year term and later.
PUT

Inserts a new control date or updates if the control date already exists

Paths

Shows a list of valid owners

GET /

Tags: ControlDatesService

Shows a list of valid owners

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

200 OK

Service request is OK and a response has been generated.

ControlDatesService
Example for application/json
{
    "ControlDatesService": {
        "request": {
            "attributes": "",
            "method": "GET",
            "resource": "/json/",
            "status": 200,
            "statusMessage": "Service request is OK and a response has been generated."
        },
        "response": {
            "control_dates": [
            ],
            "date_owner": "",
            "date_type": "",
            "owners_list": [
                {
                    "owner_name": "ID_CENTER"
                },
                {
                    "owner_name": "OWNER-ADMISSIONS"
                }
            ],
            "type_list": [
            ]
        }
    }
}
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.

Deletes a control date.

DELETE /delete/{date_owner}/{date_type}/{year_term}

Tags: ControlDatesService

Deletes a control date.
date_owner

string ->

path string
date_type

string ->

path string
year_term

yearTerm -> [1-2][0-9]{3}[1345]

 path string

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

200 OK

Service request is OK and a response has been generated.

ControlDatesService
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.

ErrorResponse
401 Unauthorized

Failure to authenticate

ErrorResponse
403 Forbidden

The user does not have access to the resource.

ErrorResponse
404 Not Found

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

ErrorResponse
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.

ErrorResponse
service definition

GET /documentation

service definition

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

200 OK

Success

Shows a list of valid types of a specified owner.

GET /{date_owner}

Tags: ControlDatesService

Shows a list of valid types of a specified owner.
date_owner

string ->

path string

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

200 OK

Service request is OK and a response has been generated.

ControlDatesService
Example for application/json
{
    "ControlDatesService": {
        "request": {
            "attributes": "",
            "method": "GET",
            "resource": "/json/ID_CENTER/",
            "status": 200,
            "statusMessage": "Service request is OK and a response has been generated."
        },
        "response": {
            "control_dates": [
            ],
            "date_owner": "ID_CENTER",
            "date_type": "",
            "owners_list": [
                {
                    "owner_name": "ID_CENTER"
                },
                {
                    "owner_name": "OWNER-ADMISSIONS"
                }
            ],
            "type_list": [
                {
                    "type_name": "ID CARD EXP BLACKOUT"
                }
            ]
        }
    }
}
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.

ErrorResponse
401 Unauthorized

Failure to authenticate

ErrorResponse
403 Forbidden

The user does not have access to the resource.

ErrorResponse
404 Not Found

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

ErrorResponse
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.

ErrorResponse
Shows a list of control dates specified by the owner and type.

GET /{date_owner}/{date_type}

Tags: ControlDatesService

Shows a list of control dates specified by the owner and type.
date_owner

string ->

path string
date_type

string ->

path string

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

200 OK

Service request is OK and a response has been generated.

ControlDatesService
Example for application/json
{
    "ControlDatesService": {
        "request": {
            "attributes": "",
            "method": "GET",
            "resource": "/json/ID_CENTER/ID CARD EXP BLACKOUT/",
            "status": 200,
            "statusMessage": "Service request is OK and a response has been generated."
        },
        "response": {
            "control_dates": [
                {
                    "date_updated": "20 Jan 2016",
                    "description": "ID Card expiration blackout period",
                    "end_date": "2023-01-12",
                    "end_time": "00:00:00",
                    "start_date": "2022-12-18",
                    "start_time": "00:00:00",
                    "updated_by": "Person, Name",
                    "year_term": "20231"
                },
                {
                    "date_updated": "20 Jan 2016",
                    "description": "ID Card expiration blackout period",
                    "end_date": "2022-09-09",
                    "end_time": "00:00:00",
                    "start_date": "2022-08-15",
                    "start_time": "00:00:00",
                    "updated_by": "Person, Name",
                    "year_term": "20225"
                }
            ],
            "date_owner": "ID_CENTER",
            "date_type": "ID CARD EXP BLACKOUT",
            "owners_list": [
                {
                    "owner_name": "ID_CENTER"
                },
                {
                    "owner_name": "OWNER-ADMISSIONS"
                }
            ],
            "type_list": [
                {
                    "type_name": "ID CARD EXP BLACKOUT"
                }
            ]
        }
    }
}
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.

ErrorResponse
401 Unauthorized

Failure to authenticate

ErrorResponse
403 Forbidden

The user does not have access to the resource.

ErrorResponse
404 Not Found

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

ErrorResponse
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.

ErrorResponse
Shows a list of control dates specified by the owner and type from the specified year term and later.

GET /{date_owner}/{date_type}/{year_term}

Tags: ControlDatesService

Shows a list of control dates specified by the owner and type from the specified year term and later.
date_owner

string ->

path string
date_type

string ->

path string
year_term

yearTerm -> [1-2][0-9]{3}[1345]

 path string

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

200 OK

Service request is OK and a response has been generated.

ControlDatesService
Example for application/json
{
    "ControlDatesService": {
        "request": {
            "attributes": "",
            "method": "GET",
            "resource": "/json/ID_CENTER/ID CARD EXP BLACKOUT/20231/",
            "status": 200,
            "statusMessage": "Service request is OK and a response has been generated."
        },
        "response": {
            "control_dates": [
                {
                    "date_updated": "20 Jan 2016",
                    "description": "ID Card expiration blackout period",
                    "end_date": "2023-01-12",
                    "end_time": "00:00:00",
                    "start_date": "2022-12-18",
                    "start_time": "00:00:00",
                    "updated_by": "Person, Name",
                    "year_term": "20231"
                }
            ],
            "date_owner": "ID_CENTER",
            "date_type": "ID CARD EXP BLACKOUT",
            "owners_list": [
                {
                    "owner_name": "ID_CENTER"
                },
                {
                    "owner_name": "OWNER-ADMISSIONS"
                }
            ],
            "type_list": [
                {
                    "type_name": "ID CARD EXP BLACKOUT"
                }
            ]
        }
    }
}
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.

ErrorResponse
401 Unauthorized

Failure to authenticate

ErrorResponse
403 Forbidden

The user does not have access to the resource.

ErrorResponse
404 Not Found

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

ErrorResponse
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.

ErrorResponse
Inserts a new control date or updates if the control date already exists

PUT /{date_owner}/{date_type}/{year_term}

Tags: ControlDatesService

Inserts a new control date or updates if the control date already exists
date_owner

string ->

path string
date_type

string ->

path string
year_term

yearTerm -> [1-2][0-9]{3}[1345]

 path string
start_date_time

DD MM YYYY HH24

 query string
end_date_time

DD MM YYYY HH24

 query string
description

description

 query string

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

200 OK

Service request is OK and a response has been generated.

ControlDatesService
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.

ErrorResponse
401 Unauthorized

Failure to authenticate

ErrorResponse
403 Forbidden

The user does not have access to the resource.

ErrorResponse
404 Not Found

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

ErrorResponse
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.

ErrorResponse

Schema definitions

control_dates: object

year_term: year_term
start_date: start_date
start_time: start_time
end_date: end_date
end_time: end_time
description: description
date_updated: date_updated
updated_by: updated_by

ControlDatesService: object

ControlDatesService: object
request: request
response: response

date_owner: string

date_type: string

date_updated: string

description: string

end_date: string

end_time: string

error_data: object

code: string
name: string
message: string
httpStatusCode: number

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

error_data

owner_name: string

owners_list: object

owner_name: owner_name

request: object

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

response: object

owners_list: object[]
owners_list
type_list: object[]
type_list
date_owner: date_owner
date_type: date_type
control_dates: object[]
control_dates

start_date: string

start_time: string

type_list: object

type_name: type_name

type_name: string

updated_by: string

year_term: string

Service Path: 
/domains/legacy/academic/controls/controldates
Domain or University API: 
/domains/D/academic/controls/controldates
Tags: 
domains
legacy
Academic
controls
controldates

Community

 

Don't see your question listed here? Ask!

View This API in the API Store

Get Elevated Access