GET Grades

Retrieves the list of all the grade information of the student for all the active courses for the term passed. The following grades of the student will be returned in the response:

Mid term grade

Final grade

Grade in Academic History

Note

The term is optional Url parameter to the API.
If term is provided, the API fetches the grade information for the provided term.
If the term is not provided, the API fetches the grade information for each term the student has registered courses.

URI

	
			GET /epWS/StudentApi/api/students/{uin}/grades?term={term} HTTP/1.1

uin:	The University Identification Number used to access a person

HTTP request headers

Header	Value
Accept	application/vnd.hedtech.v1+xml
X-senderAppId

URL parameters

Name	Description	Required
uin	University Identification Number	yes
term	Code value to identify the term	false

JSON version 1

HTTP request headers

Header	Value
Accept	application/vnd.hedtech.v1+json
X-senderAppId	Authorized sender application ID

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 grades attributes:

[
    {
        "courseNumber": "Field that identifies the course number associated with the CRN",
        "courseTitle": "Course title",
        "creditHour": Field that identifies the credit hours associated with the CRN,
        "crn": "Field that identifies the course reference number associated with the class section",
        "gradeFinal": "Field that identifies the grade code associated with the CRN",
        "gradeInAcadHistory": "Field that identifies the grade code associated with the CRN in Academic History",
        "gradeMidterm": "Field that identifies the mid-term grade code associated with the CRN",
        "gradeRolled": "Field that identifies whether the grade has been rolled to Academic History",
        "level":
        {
            "code": "Field that identifies the level the registrant is enrolled for the CRN",
            "description": "Field that describes the level code associated"
        },
        "registrationStatus":
        {
            "code": "Field that identifies the course registration status associated with the CRN",
            "description": "Description of the course registration status code"
        },
        "classFormat":
        {
            "code": "Field that identifies instructional type code of the section being scheduled",
            "description": "Field that identifies the schedule type associated with the schedule type code"
        },
        "sequenceNumber": "Field that identifies the section number of a course",
        "subject":
        {
            "code": "Field that identifies the subject associated with the CRN",
            "description": "Description of the subject code"
        },
        "term":
        {
            "code": "Code value to identify the term",
            "description": "Description of the term associated with the term code"
        }
    },
    record 2,
    record 3,
    ........
    record n
]

XML version 1

Response

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

<list>
    <studentCourseGrade>
        <courseNumber> Field that identifies the course number associated with the CRN </courseNumber>
        <courseTitle> Course title </courseTitle>
        <creditHour> Field that identifies the credit hours associated with the CRN </creditHour>
        <crn> Field that identifies the course reference number associated with the class section </crn>
        <gradeFinal> Field that identifies the grade code associated with the CRN </gradeFinal>
        <gradeInAcadHistory> Field that identifies the grade code associated with the CRN in Academic History </gradeInAcadHistory>
        <gradeMidterm> Field that identifies the mid-term grade code associated with the CRN </gradeMidterm>
        <gradeRolled> Field that identifies whether the grade has been rolled to Academic History </gradeRolled>
        <level>
            <code> Field that identifies the level the registrant is enrolled for the CRN </code>
            <description> Field that describes the level code associated </description>
        </level>
        <registrationStatus>
            <code> Field that identifies the course registration status associated with the CRN </code>
            <description> Description of the course registration status code </description>
        </registrationStatus>
        <classFormat>
            <code> Field that identifies instructional type code of the section being scheduled </code>
            <description> Field that identifies the schedule type associated with the schedule type code </description>
        </classFormat>
        <sequenceNumber> Field that identifies the section number of a course </sequenceNumber>
        <subject>
            <code> Field that identifies the subject associated with the CRN </code>
            <description> Description of the subject code </description>
        </subject>
        <term>
            <code> Code value to identify the term </code>
            <description> Description of the term associated with the term code </description>
        </term>
    </studentCourseGrade>
    record 2
    record 3
    ........
    record n
</list>