Version: 1.1
Availability: Production
Release Date: December 2016
Framework: AITS RESTful Data API
Description: Query detailed academic term date information.
Source System: Banner
GET https://webservices.admin.uillinois.edu/studentWS/data/{senderAppId}/Term/1_0/{term}/{campus}?format={format}
| Parameter | Description | Type | Required |
|---|---|---|---|
| senderAppId | Identifies the client application | String | Yes |
| term | Specific term code (e.g. "120168", "220171", "420168"), or term period ("current", "pastYear", or "nextYear) value to be queried | String | Yes |
| campus | University filter ("uic", "uis", or "uiuc") | String | No |
| format | Desired response format. Supports either "json" (default) or "xml" | String | No |
GET /studentWS/data/mySenderAppId/Term/1_0/120168?format=json HTTP/1.1
Host: webservices-dev.admin.uillinois.edu
{
"Object": "Term",
"Version": "1_0",
"TermList": [
{
"termCode": "120168",
"termDescription": "Fall 2016 - Urbana-Champaign",
"startDate": "2016-08-22",
"endDate": "2016-12-16",
"finaidProcYear": {
"code": "1617",
"description": "2016-2017"
},
"academicYear": {
"code": "1617",
"description": "2016-2017"
},
"housingStartDate": "2016-08-22",
"housingEndDate": "2016-12-16",
"termType": {
"code": "S",
"description": "Semester"
},
"termPart": [
{
"termCode": "120168",
"description": "Full Term",
"startDate": "2016-08-22",
"endDate": "2016-12-07",
"weeks": 16,
"censusDate": "2016-08-22"
},
{
"termCode": "120168",
"description": "First Half",
"startDate": "2016-08-22",
"endDate": "2016-10-14",
"weeks": 8,
"censusDate": "2016-08-22"
},
{
"termCode": "120168",
"description": "Second Half",
"startDate": "2016-10-17",
"endDate": "2016-12-07",
"weeks": 8,
"censusDate": "2016-10-17"
},
{
"termCode": "120168",
"description": "COAR Only Registration",
"startDate": "2016-08-22",
"endDate": "2016-12-07",
"weeks": 16,
"censusDate": "2016-08-22"
},
{
"termCode": "120168",
"description": "Law Full Term",
"startDate": "2016-08-22",
"endDate": "2016-12-05",
"weeks": 16,
"censusDate": "2016-08-22"
},
{
"termCode": "120168",
"description": "Tuition Waiver Fall",
"startDate": "2016-08-22",
"endDate": "2016-12-16",
"weeks": 16,
"censusDate": "2016-08-22"
},
{
"termCode": "120168",
"description": "Extramural",
"startDate": "2016-08-22",
"endDate": "2016-12-07",
"weeks": 16,
"censusDate": "2016-08-22"
}
]
}
]
}
Functional Area: Student
Name: Term
Version: 1.0
| Path | Type | Name | Occurrence | Description | Authority |
|---|---|---|---|---|---|
| TermList | Object-Array | TermList | Zero or One | Collection of data about an academic term. | |
| TermList.termCode | Element | termCode | Exactly One | The term code referenced in the Catalog, Recruiting, Admissions, Gen. Student, Registration, Student Billing and Acad. Hist. Modules. | STVTERM_CODE |
| TermList.termDescription | Element | termDescription | Exactly One | A description of the term associated with a term code. | STVTERM_DESC |
| TermList.startDate | Element | startDate | Exactly One | The term start date, formatted as YYYY-MM-DD. | STVTERM_START_DATE |
| TermList.endDate | Element | endDate | Exactly One | The term end date, formatted as YYYY-MM-DD. | STVTERM_END_DATE |
| TermList.finaidProcYear | Object | finaidProcYear | Zero or One | Collection of elements related to financial aid processing for a given term. | |
| TermList.finaidProcYear.code | Element | code | Exactly One | A code that identifies the financial aid processing start and end years (e.g. 1988 - 1989 is formatted 8889.). Valid per STVACYR. | STVTERM_FA_PROC_YR |
| TermList.finaidProcYear.description | Element | description | Exactly One | A description of the academic year associated with an academic year code. | STVACYR_DESC |
| TermList.academicYear | Object | academicYear | Zero or One | Collection of elements related to the academic year for a given term. | |
| TermList.academicYear.code | Element | code | Exactly One | A code that identifies the academic period start and end years (e.g. 1988 - 1989 is formatted 8889.). Valid per STVACYR. | STVTERM_ACYR_CODE |
| TermList.academicYear.description | Element | description | Exactly One | A description of the academic year associated with an academic year code. | STVACYR_DESC |
| TermList.housingStartDate | Element | housingStartDate | Zero or One | Housing Start Date. | STVTERM_HOUSING_START_DATE |
| TermList.housingEndDate | Element | housingEndDate | Zero or One | Housing End Date. | STVTERM_HOUSING_END_DATE |
| TermList.termType | Object | termType | Zero or One | Collection of elements related to the term type for a given term. | |
| TermList.termType.code | Element | code | Exactly One | Term type for this term. Valid per STVTRMT. | STVTERM_TRMT_CODE |
| TermList.termType.description | Element | description | Exactly One | Description for the type of term associated with term type code. | STVTRMT_DESC |
| TermList.termPart | Object-Array | termPart | Zero or Many | Collection of objects containing elements related to part-of-term periods for a given term. | |
| TermList.termPart.termCode | Element | termCode | Exactly One | The term code associated with the part-of-term entries. | SOBPTRM_TERM_CODE |
| TermList.termPart.description | Element | description | Exactly One | A description of the term code associated with the part-of-term entries. | SOBPTRM_PTRM_CODE |
| TermList.termPart.startDate | Element | startDate | Zero or One | The calendar start date for the Part of Term period. | SOBPTRM_START_DATE |
| TermList.termPart.endDate | Element | endDate | Zero or One | The calendar end date for the Part of Term period. | SOBPTRM_END_DATE |
| TermList.termPart.weeks | Element | weeks | Zero or One | The number of weeks associated the Part of Term period. | SOBPTRM_WEEKS |
| TermList.termPart.censusDate | Element | censusDate | Zero or One | The census date associated with the Part of Term Code. | SOBPTRM_CENSUS_DATE |