AcademicClassScheduleEvent
This service accesses event schedule information in the AIM System.
Base URL: /domains/legacy/academic/classschedule/event
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/documentation | GET | service definition |
/{yearTerm} | GET | Shows all events (id, sponsor, description) for the specified yearTerm. |
/{yearTerm}/{scheduleId} | GET | Shows the event schedule record for the given id and yearTerm. |
Paths
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
GET /{yearTerm}
Tags: EventServiceShows all events (id, sponsor, description) for the specified yearTerm.
yearTerm | 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.
Example for application/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/20181/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"allEventsThisYearTerm": [
{
"description": "Phys S 100 set up",
"eventId": "0",
"sponsor": "PHY S"
}
],
"yearTerm": "20181"
}
} - 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 /{yearTerm}/{scheduleId}
Tags: EventServiceShows the event schedule record for the given id and yearTerm.
yearTerm | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
scheduleId | string -> The id associated with an event. | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/20181/0/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"contactInfo": "",
"creditInstitution": "BYU PROVO",
"descriptionOfEvent": "Phys S 100 set up",
"eventsScheduled": "6",
"nonAcadEventList": [
{
"building": "CB",
"capacity": "342",
"dateUpdated": "10 Mar 2017",
"days": "MW F",
"endDate": "18 Apr 2018",
"endTime": "8:50",
"eventId": "BYU PROVO 201810",
"room": "377",
"sequenceNumber": "1",
"startDate": "08 Jan 2018",
"startTime": "8:00",
"status": "C",
"updatedBy": "Person, Name"
}
],
"scheduleType": "",
"schedulingId": "0",
"schedulingNumber": "",
"sponsor": "PHY S",
"yearTerm": "20181"
}
} - 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.
Schema definitions
- eventId: eventId
-
- sponsor: sponser
-
- description: description
-
- request: request
-
- response: scheduleIdResponse
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- yearTerm: yearTerm
-
- allEventsThisYearTerm: allEventsThisYearTerm
-
- yearTerm: yearTerm
-
- schedulingId: schedulingId
-
- sponsor: sponsor
-
- contactInfo: contactInfo
-
- descriptionOfEvent: descriptionOfEvent
-
- creditInstitution: creditInstitution
-
- scheduleType: scheduleType
-
- schedulingNumber: schedulingNumber
-
- eventsScheduled: eventsScheduled
-
- nonAcadEventList: nonAcadEventList
-