University of Illinois System

StudentRoster

Service Information:

Version: 1.0

Availability: Production

Framework: AITS RESTful Data API

Description: Student roster for given term and course (CRN).

Source System: Banner

Operations:

 GET /studentWS/data/{senderAppId}/StudentRoster/1_0/{termCode}/{crn}?format={format}

A table detailing the parameter set for a Directory Data GET request.
Parameter Description Type Required
senderAppId
 Authorized sender application ID.
 String
Yes
termCode
 Academic term code filter.
 String
 Yes
crn
 Course Reference Number (Banner identifier)
 String
 Yes
format Desired response format. Supports either "json" (default) or "xml".
 String No

Sample REST Request

GET /studentWS/data/edu.uillinois.aits.enterprisetester.uiuc/StudentRoster/1_0/120175/12345?format=json HTTP/1.1
Host: webservices-dev.admin.uillinois.edu

Sample REST Response

{
    "object": "StudentRoster",
    "version": "1_0",
    "list": [
        {
            "lightweightPerson": {
                "Name": {
                "LastName": "Doe",
                "FirstName": "Jane"
                },
                "InstitutionalId": "123456789"
            },
            "email": [
                {
                    "displayOnWeb": "Y",
                    "status": "A",
                    "type": "UI",
                    "preferred": "Y",
                    "emailAddress": "sampleuser@illinois.edu.xxxyyyzzz"
                }
            ],
            "courseReferenceNumber": "12345",
            "validTerm": {
                "code": "120175",
                "description": "Summer 2017 - Urbana-Champaign"
            },
            "validRegistrationStatus": {
                "code": "RW",
                "description": "**Web Registered**"
            }
        },
        {
            "lightweightPerson": {
                "name": {
                    "lastName": "Person",
                    "firstName": "Some",
                    "middleName": "Other"
                },
                "institutionalId": "987654321"
            },
            "email": [
                {
                    "displayOnWeb": "Y",
                    "status": "A",
                    "type": "UI",
                    "preferred": "Y",
                    "emailAddress": "sampleuser2@illinois.edu.xxxyyyzzz"
                }
            ],
            "courseReferenceNumber": "12345",
            "validTerm": {
                "code": "120175",
                "description": "Summer 2017 - Urbana-Champaign"
            },
            "validRegistrationStatus": {
                "code": "RW",
                "description": "**Web Registered**"
            }
        },
        ...
      ]
}

Data Model:

Functional Area: Student

Name: StudentRoster

Version: 1.0

Element Map:

A table detailing the attributes and elements within the Student Enrollment object
Path Type Name Occurrence Description Authority
QueryRequestResult Object-Array QueryRequestResult Exactly One Root container housing one or more StudentRoster children.
StudentRoster.LightweightPerson Object/Array LightweightPerson Exactly One Array of data about a person
StudentRoster.LightweightPerson.Name Object/Array Name Zero or One Array of data about a person's name
StudentRoster.LightweightPerson.Name.LastName Element LastName Exactly One Student's last name
 SPRIDEN_LAST_NAME
StudentRoster.LightweightPerson.Name.FirstName Element FirstName Exactly One Student's first name
 SPBPERS_PREF_FIRST_NAME then SPRIDEN_FIRST_NAME
StudentRoster.LightweightPerson.InstitutionalId Element InstitutionalId Exactly One Student's University ID number (UIN) [9-character alphanumeric string. The first character will always be a 6 for a person. The remaining characters will be unique numeric combination that identifies the person.] SPRIDEN_ID
StudentRoster.Email Object/Array Email Zero or Many Array of data about a person's email settings
StudentRoster.Email.@displayOnWeb Attribute displayOnWeb Exactly One Web Display Indicator GOREMAL_DISP_WEB_IND
StudentRoster.Email.@preferred Attribute preferred Exactly One Preferred Email Indicator GOREMAL_PREFERRED_IND
StudentRoster.Email.@status Attribute status Exactly One Inactive Email Indicator GOREMAL_STATUS_IND
StudentRoster.Email.@type Attribute type Exactly One Email Type Code: Ex. UI (University Assigned Email Address) GOREMAL_EMAL_CODE
StudentRoster.Email.EmailAddress Element EmailAddress Exactly One Email Address GOREMAL_EMAIL_ADDRESS
StudentRoster.CourseReferenceNumber Element CourseReferenceNumber Exactly One Course Reference Number assigned to Section (ex. "44870") SSBSECT_CRN
StudentRoster.ValidTerm Object/Array ValidTerm Exactly One Describes the term code associated with a roster entry
StudentRoster.ValidTerm.Code Element Code Exactly One Student's Course Enrollment Term Code Ex. 220081 (Spring 2008 - Chicago) STVTERM_CODE
StudentRoster.ValidTerm.Description Element Description Exactly One Student's Course Enrollment Term Description Ex. Spring 2008 - Chicago STVTERM_DESC
StudentRoster.ValidRegistrationStatus Object/Array ValidRegistrationStatus Exactly One Describes the registration status code associated with a roster entry
StudentRoster.ValidRegistrationStatus.Code Element Code Exactly One This field identifies the course registration status associated with this CRN. SFRSTCR_RSTS_CODE
StudentRoster.ValidRegistrationStatus.Description Element Description Exactly One This field specifies the course registration status associated with the code. STVRSTS_DESC