GET Class schedules

Retrieves the list of the class schedules information of the student.

Note

Exception will be thrown for deceased student.
In the response header, X-hedtech-totalCount will show total number of student’s active courses registered.
If term is not passed from the URL parameter, response body will return active registrations for all terms.
If term is passed, the fields “totalCue”, totalCredit” and “totalBill” retrieves appropriate values else they always return “0”.

URI

    
            GET /api/students/{bannerId}/class-schedules HTTP/1.1

bannerId:	The identification number used to access a person

JSON version 1

HTTP request headers

Header	Value
Accept	application/vnd.hedtech.v1+json

URL parameters

Name	Description	Required
term	Code value to identify the term	false

Response

Returns a JSON-formatted string of data that contains the following student’s class schedules attributes:

[
    {
        "studentCourseRegistrations":
        [
           {
               "academicYear": "Code value to identify the academic year to which this term code is assigned",
               "academicYearDescription": "Description of the academic year associated with the academic year code",
               "completionDate": "Field that identifies part-of-term end date(yyyy-MM-dd)",
               "courseNumber": "Field that identifies the course number associated with the CRN",
               "courseReferenceNumber": "Field that identifies the course reference number associated with the class section",
               "courseRegistrationStatus":
               {
                   "code": "Field that identifies the course registration status associated with the CRN",
                   "description": "Description of the course registration status code"
               },
               "courseTitle": "Course title",
               "creditHour": "Field that identifies the credit hours associated with the CRN",
               "faculty":
               [
                   {
                       "bannerId": "The identification number used to access a person",
                       "displayName": "Field that identifies Instructor's display name",
                       "emailAddress": "Field that identifies Instructor's email address",
                       "primaryIndicator": "Field that identifies Instructor's primary indicator"
                   },
                   record 2,
                   record 3,
                   ........
                   record n
               ],
               "gradingMode": "Field that identifies grading mode code for the section",
               "gradingModeDescription": "Field that identifies the grading mode associated with the grading mode code",
               "instructionalMethod": "Field that identifies the instructional method code assigned to the section",
               "instructionalMethodDescription": "Field that identifies the instructional method associated with the instructional method code",
               "level":
               {
                   "ceuInd": "Field that identifies the continuing education indicator"
               },
               "meetingTimes":
               [
                   {
                       "beginTime": "Field that identifies the begin time of the course section being scheduled",
                       "building": "Field that identifies building code meets in",
                       "buildingDescription": "Field that identifies the building associated with the building code",
                       "campus": "Field that identifies the campus code in which the building is located",
                       "campusDescription": "Field that identifies the campus associated with the campus code",
                       "creditHourSession": "Field that identifies the session credit hours",
                       "endDate": "Field that identifies section end date",
                       "endTime": "Field that identifies the End Time of the course section being scheduled",
                       "friday": "Field that identifies section meeting time Friday indicator",
                       "hoursWeek": "Field that identifies section meeting hours per week",
                       "meetingScheduleType": "Field that identifies meeting schedule type code",
                       "monday": "Field that identifies section meeting time Monday indicator",
                       "room": "Field that identifies the room where the course section will be scheduled",
                       "saturday": "Field that identifies section meeting time Saturday indicator",
                       "startDate": "Field that identifies section meeting start date",
                       "sunday": "Field that identifies section meeting time Sunday indicator",
                       "thursday": "Field that identifies section meeting time Thrusday indicator",
                       "tuesday": "Field that identifies section meeting time Tuesday indicator",
                       "wednesday": "Field that identifies section meeting time Wednesday indicator"
                   },
                   record 2,
                   record 3,
                   ........
                   record n
               ],
               "partOfTerm": "Code value to identify the part-of-term for the base part-of-term",
               "partOfTermDescription": "Description of the part-of-term associated with the part-of-term code",
               "scheduleDescription": "Field that identifies the schedule type associated with the schedule type code",
               "scheduleType": "Field that identifies instructional type code of the section being scheduled",
               "sequenceNumber": "Field that identifies the section number of a course",
               "startDate": "Field that identifies the part-of-term start date(yyyy-MM-dd)",
               "subject": "Field that identifies the subject associated with the CRN",
               "subjectDescription": "Description of the subject code",
               "term": "Code value to identify the term",
               "termDescription": "Description of the term associated with the term code"
           },
           record 2,
           record 3,
           ........
           record n
        ],
        "totalBill": "Field that identifies the sum of all bill hours registered for the courses in the given term",
        "totalCeu": "Field that identifies the sum of all credit hours registered for the continuous educational courses in the given term",
        "totalCredit": "Field that identifies the sum of all credit hours registered for the courses other then CEU in the given term"
    }
]

XML version 1

HTTP request headers

Header	Value
Accept	application/vnd.hedtech.v1+xml

URL parameters

Name	Description	Required
term	Code value to identify the term	false

Response

Returns an XML-formatted string of data that contains the following student’s class schedules attributes:

<list>
    <registrationProcessDecorator>
        <studentCourseRegistrations array="true">
            <registrationStudentCourseRegistrationQueryView>
                <academicYear> Code value to identify the academic year to which this term code is assigned </academicYear>
                <academicYearDescription> Description of the academic year associated with the academic year code </academicYearDescription>
                <completionDate> Field that identifies part-of-term end date(yyyy-MM-dd) </completionDate>
                <courseNumber> Field that identifies the course number associated with the CRN </courseNumber>
                <courseReferenceNumber> Field that identifies the course reference number associated with the class section </courseReferenceNumber>
                <courseRegistrationStatus>
                    <code> Field that identifies the course registration status associated with the CRN </code>
                    <description> Description of the course registration status code </description>
                </courseRegistrationStatus>
                <courseTitle> Course title </courseTitle>
                <creditHour> Course title </creditHour>
                <faculty array="true">
                    <facultyResultDecorator>
                        <bannerId> The identification number used to access a person </bannerId>
                        <displayName> Field that identifies Instructor's display name </displayName>
                        <emailAddress> Field that identifies Instructor's email address </emailAddress>
                        <primaryIndicator> Field that identifies Instructor's primary indicator </primaryIndicator>
                    </facultyResultDecorator>
                    record 2
                    record 3
                    ........
                    record n
                </faculty>
                <gradingMode> Field that identifies grading mode code for the section </gradingMode>
                <gradingModeDescription> Field that identifies the grading mode associated with the grading mode code </gradingModeDescription>
                <instructionalMethod> Field that identifies the instructional method code assigned to the section </instructionalMethod>
                <instructionalMethodDescription> Field that identifies the instructional method associated with the instructional method code </instructionalMethodDescription>
                <level>
                    <ceuInd> Field that identifies the continuing education indicator </ceuInd>
                </level>
                <meetingTimes array="true">
                    <meetingTimeDecorator>
                        <beginTime> Field that identifies the begin time of the course section being scheduled </beginTime>
                        <building> Field that identifies building code meets in </building>
                        <buildingDescription> Field that identifies the building associated with the building code </buildingDescription>
                        <campus> Field that identifies the campus code in which the building is located </campus>
                        <campusDescription> Field that identifies the campus associated with the campus code </campusDescription>
                        <creditHourSession> Field that identifies the session credit hours </creditHourSession>
                        <endDate> Field that identifies section end date </endDate>
                        <endTime> Field that identifies the End Time of the course section being scheduled </endTime>
                        <friday> Field that identifies section meeting time Friday indicator </friday>
                        <hoursWeek> Field that identifies section meeting hours per week </hoursWeek>
                        <meetingScheduleType> Field that identifies meeting schedule type code </meetingScheduleType>
                        <monday> Field that identifies section meeting time Monday indicator </monday>
                        <room> Field that identifies the room where the course section will be scheduled </room>
                        <saturday> Field that identifies section meeting time Saturday indicator </saturday>
                        <startDate> Field that identifies section meeting start date </startDate>
                        <sunday> Field that identifies section meeting time Sunday indicator </sunday>
                        <thursday> Field that identifies section meeting time Thrusday indicator </thursday>
                        <tuesday> Field that identifies section meeting time Tuesday indicator </tuesday>
                        <wednesday> Field that identifies section meeting time Wednesday indicator </wednesday>
                    </meetingTimeDecorator>
                    record 2
                    record 3
                    ........
                    record n
                </meetingTimes>
                <partOfTerm> Code value to identify the part-of-term for the base part-of-term </partOfTerm>
                <partOfTermDescription> Description of the part-of-term associated with the part-of-term code </partOfTermDescription>
                <scheduleDescription> Field that identifies the schedule type associated with the schedule type code </scheduleDescription>
                <scheduleType> Field that identifies instructional type code of the section being scheduled </scheduleType>
                <sequenceNumber> Field that identifies the section number of a course </sequenceNumber>
                <startDate> Field that identifies the part-of-term start date(yyyy-MM-dd) </startDate>
                <subject> Field that identifies the subject associated with the CRN </subject>
                <subjectDescription> Description of the subject code </subjectDescription>
                <term> Code value to identify the term </term>
                <termDescription> Description of the term associated with the term code </termDescription>
            </registrationStudentCourseRegistrationQueryView>
            record 2
            record 3
            ........
            record n
        </studentCourseRegistrations>
        <totalBill> Field that identifies the sum of all bill hours registered for the courses in the given term </totalBill>
        <totalCeu> Field that identifies the sum of all credit hours registered for the continuous educational courses in the given term </totalCeu>
        <totalCredit> Field that identifies the sum of all credit hours registered for the courses other then CEU in the given term </totalCredit>
    </registrationProcessDecorator>
</list>