StudentEnrollment

Service Information:

Version: 1.0

Availability: Production

Framework: AITS Web Services

Description: Student enrollment information, by term.

Source System: Banner

Operations:

GET /studentWS/query/edu.uillinois.Student.StudentEnrollment_1_0/{senderAppId}/{institutionalId}/{termCode}?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
institutionalId	University Identification Number (UIN) for subject to be queried.	String	Yes
termCode	(Optional) Academic term code filter.	String	No
format	Desired response format. Supports either "json" (default) or "xml".	String	No

Sample REST Request

GET /studentWS/query/edu.uillinois.Student.StudentEnrollment_1_0/mySenderAppId/123456789/420171?format=json HTTP/1.1
Host: webservices-dev.admin.uillinois.edu

Sample REST Response

{
  "QueryRequestResult": [
    {
      "StudentEnrollment": {
        "LightweightPerson": {
          "Name": {
            "LastName": "Doe",
            "FirstName": "Jane"
          },
          "InstitutionalId": "123456789"
        },
        "ValidEnrollmentStatus": {
          "Code": "EL",
          "Description": "Eligible to Register"
        },
        "ValidTerm": {
          "Code": "420171",
          "Description": "Spring 2017 - Springfield"
        },
        "CourseRegistration": [
          {
            "ValidRegistrationStatus": {
              "Code": "RW",
              "Description": "**Web Registered**"
            },
            "ValidGradingMode": {
              "Code": "S",
              "Description": "Standard Letter"
            },
            "CourseSection": {
              "CourseReferenceNumber": "10223",
              "ValidTerm": {
                "Code": "420171",
                "Description": "Spring 2017 - Springfield"
              },
              "Course": {
                "CourseSubjectAbbreviation": "TST",
                "CourseNumber": "509",
                "ValidCampus": {
                  "Code": "400",
                  "Description": "Springfield"
                },
                "CourseTitle": "Web Service Testing",
                "ValidCollege": {
                  "Code": "DI",
                  "Description": "Data Integration"
                },
                "ValidDepartment": {
                  "Code": "4442",
                  "Description": "Educational Leadership"
                }
              },
              "CourseSectionSession": [
                {
                  "CourseSectionSessionID": "01",
                  "MeetsOnMondayFlag": "M",
                  "CourseSessionInstructor": [
                    {
                      "LightweightPerson": {
                        "Name": {
                          "LastName": "Instructor",
                          "FirstName": "Some",
                        },
                        "InstitutionalId": "987654321"
                      },
                      "EmailAddress": "noreply@uis.edu.xxxyyyzzz"
                    }
                  ],
                  "StartTime": "1730",
                  "EndTime": "2100",
                  "ValidCourseScheduleType": {
                    "Code": "LCD",
                    "Description": "Lecture-Discussion"
                  },
                  "StartDate": "1-17-2017",
                  "EndDate": "5-6-2017"
                }
              ],
              "CreditHours": "4.0",
              "ValidPartTerm": {
                "Code": "1",
                "Description": "Full Term"
              },
              "StartDate": "1-17-2017",
              "EndDate": "5-6-2017"
            }
          }
        ]
      }
    }
  ]
}

Sample SOAP Request

POST /studentWS/services/proxyWS HTTP/1.1
Host: webservices-dev.admin.uillinois.edu
Content-Type: text/xml
SOAPAction: blah
Cache-Control: no-cache
Postman-Token: b9ded031-f8ed-0f9e-9b48-86a177a2baa2

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aits="http://aits.uillinois.edu">
   <soapenv:Header/>
   <soapenv:Body>
      <aits:queryRequest>
         <senderAppId>mySenderAppId</senderAppId>
         <msgObject>edu.uillinois.Student.StudentEnrollment_1_0</msgObject>
         <data>
            <LightweightPersonWithAttribute>
            	<LightweightPerson>
            		<InstitutionalId>123456789</InstitutionalId>
            	</LightweightPerson>
            	<AdditionalAttribute attributeName="TermCode" attributeValue="420171"/>
            </LightweightPersonWithAttribute>
         </data>
      </aits:queryRequest>
   </soapenv:Body>
</soapenv:Envelope>

Sample SOAP Response

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
        <QueryRequestResult>
            <StudentEnrollment>
                <LightweightPerson>
                    <Name>
                        <LastName>Doe</LastName>
                        <FirstName>Jane</FirstName>
                    </Name>
                    <InstitutionalId>123456789</InstitutionalId>
                </LightweightPerson>
                <ValidEnrollmentStatus>
                    <Code>EL</Code>
                    <Description>Eligible to Register</Description>
                </ValidEnrollmentStatus>
                <ValidTerm>
                    <Code>420171</Code>
                    <Description>Spring 2017 - Springfield</Description>
                </ValidTerm>
                <CourseRegistration>
                    <ValidRegistrationStatus>
                        <Code>RW</Code>
                        <Description>**Web Registered**</Description>
                    </ValidRegistrationStatus>
                    <ValidGradingMode>
                        <Code>S</Code>
                        <Description>Standard Letter</Description>
                    </ValidGradingMode>
                    <CourseSection>
                        <CourseReferenceNumber>10223</CourseReferenceNumber>
                        <ValidTerm>
                            <Code>420171</Code>
                            <Description>Spring 2017 - Springfield</Description>
                        </ValidTerm>
                        <Course>
                            <CourseSubjectAbbreviation>TST</CourseSubjectAbbreviation>
                            <CourseNumber>509</CourseNumber>
                            <ValidCampus>
                                <Code>400</Code>
                                <Description>Springfield</Description>
                            </ValidCampus>
                            <CourseTitle>Web Services Testing</CourseTitle>
                            <ValidCollege>
                                <Code>DI</Code>
                                <Description>Data Integratio</Description>
                            </ValidCollege>
                            <ValidDepartment>
                                <Code>4442</Code>
                                <Description>Educational Leadership</Description>
                            </ValidDepartment>
                        </Course>
                        <CourseSectionSession>
                            <CourseSectionSessionID>01</CourseSectionSessionID>
                            <MeetsOnMondayFlag>M</MeetsOnMondayFlag>
                            <CourseSessionInstructor>
                                <LightweightPerson>
                                    <Name>
                                        <LastName>Instructor</LastName>
                                        <FirstName>Some</FirstName>
                                    </Name>
                                    <InstitutionalId>987654321</InstitutionalId>
                                </LightweightPerson>
                                <EmailAddress>noreply@uis.edu.xxxyyyzzz</EmailAddress>
                            </CourseSessionInstructor>
                            <StartTime>1730</StartTime>
                            <EndTime>2100</EndTime>
                            <ValidCourseScheduleType>
                                <Code>LCD</Code>
                                <Description>Lecture-Discussion</Description>
                            </ValidCourseScheduleType>
                            <StartDate>
                                <Month>1</Month>
                                <Day>17</Day>
                                <Year>2017</Year>
                            </StartDate>
                            <EndDate>
                                <Month>5</Month>
                                <Day>6</Day>
                                <Year>2017</Year>
                            </EndDate>
                        </CourseSectionSession>
                        <CreditHours>4.0</CreditHours>
                        <ValidPartTerm>
                            <Code>1</Code>
                            <Description>Full Term</Description>
                        </ValidPartTerm>
                        <StartDate>
                            <Month>1</Month>
                            <Day>17</Day>
                            <Year>2017</Year>
                        </StartDate>
                        <EndDate>
                            <Month>5</Month>
                            <Day>6</Day>
                            <Year>2017</Year>
                        </EndDate>
                    </CourseSection>
                </CourseRegistration>
            </StudentEnrollment>
        </QueryRequestResult>
    </soapenv:Body>
</soapenv:Envelope>

Data Model:

Functional Area: Student

Name: StudentEnrollmnet

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 StudentEnrollment children.
StudentEnrollment.LightweightPerson	Object/Array	LightweightPerson	Exactly One
StudentEnrollment.LightweightPerson.Name	Object/Array	Name	Zero or One
StudentEnrollment.LightweightPerson.Name.LastName	Element	LastName	Exactly One	Student's Last Name	SPRIDEN_LAST_NAME
StudentEnrollment.LightweightPerson.Name.FirstName	Element	FirstName	Exactly One	Student's First Name	SPBPERS_PREF_FIRST_NAME then SPRIDEN_FIRST_NAME
StudentEnrollment.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
StudentEnrollment.ValidEnrollmentStatus	Object/Array	ValidEnrollmentStatus	Exactly One
StudentEnrollment.ValidEnrollmentStatus.Code	Element	Code	Exactly One	Student's Enrollment Status Code Ex. EL (Eligible to Register)"	STVESTS_CODE
StudentEnrollment.ValidEnrollmentStatus.Description	Element	Description	Exactly One	Student's Enrollment Status Description Ex. Eligible to Register"	STVESTS_DESC
StudentEnrollment.ValidTerm	Object/Array	ValidTerm	Exactly One
StudentEnrollment.ValidTerm.Code	Element	Code	Exactly One	Student's Enrollment Term Code Ex. 120082 (Spr 2008-Global Campus Urbana)"	STVTERM_CODE
StudentEnrollment.ValidTerm.Description	Element	Description	Exactly One	Student's Enrollment Term Description Ex. Spr 2008-Global Campus Urbana"	STVTERM_DESC
StudentEnrollment.CourseRegistration	Object/Array	CourseRegistration	Zero or Many
StudentEnrollment.CourseRegistration.ValidRegistrationStatus	Object/Array	ValidRegistrationStatus	Exactly One
StudentEnrollment.CourseRegistration.ValidRegistrationStatus.Code	Element	Code	Exactly One	Student's Course Registration Status Code Ex. RW (Web Registered)"	STVRSTS_CODE
StudentEnrollment.CourseRegistration.ValidRegistrationStatus.Description	Element	Description	Exactly One	Student's Course Registration Status Description Ex. Web Registered"	STVRSTS_DESC
StudentEnrollment.CourseRegistration.ValidGradingMode	Object/Array	ValidGradingMode	Exactly One
StudentEnrollment.CourseRegistration.ValidGradingMode.Code	Element	Code	Exactly One	Student's Course Grading Mode Cod Ex. X (Cr/No Cr-UIS closure courses)"	STVGMOD_CODE
StudentEnrollment.CourseRegistration.ValidGradingMode.Description	Element	Description	Exactly One	Student's Course Grading Mode Description Ex. Cr/No Cr-UIS closure courses"	STVGMOD_DESC
StudentEnrollment.CourseRegistration.CourseSection	Object/Array	CourseSection	Exactly One
StudentEnrollment.CourseRegistration.CourseSection.CourseReferenceNumber	Element	CourseReferenceNumber	Exactly One	Course Reference Number (CRN)	SSBSECT_CRN
StudentEnrollment.CourseRegistration.CourseSection.ValidTerm	Object/Array	ValidTerm	Exactly One
StudentEnrollment.CourseRegistration.CourseSection.ValidTerm.Code	Element	Code	Exactly One	Student's Course Enrollment Term Code Ex. 220081 (Spring 2008 - Chicago)"	STVTERM_CODE
StudentEnrollment.CourseRegistration.CourseSection.ValidTerm.Description	Element	Description	Exactly One	Student's Course Enrollment Term Description Ex. Spring 2008 - Chicago"	STVTERM_DESC
StudentEnrollment.CourseRegistration.CourseSection.Course	Object/Array	Course	Exactly One
StudentEnrollment.CourseRegistration.CourseSection.Course.CourseSubjectAbbreviation	Element	CourseSubjectAbbreviation	Exactly One	Student's Course Subject Abbreviation Ex. ACCY (Accountancy)"	SSBSECT_SUBJ_CODE
StudentEnrollment.CourseRegistration.CourseSection.Course.CourseNumber	Element	CourseNumber	Exactly One	Student's Course Number Ex. 101"	SSBSECT_CRSE_NUMB
StudentEnrollment.CourseRegistration.CourseSection.Course.ValidCampus	Object/Array	ValidCampus	Exactly One
StudentEnrollment.CourseRegistration.CourseSection.Course.ValidCampus.Code	Element	Code	Exactly One	Student's Course Campus Code Ex. 270 (Global Campus Chicago)"	STVCAMP_CODE
StudentEnrollment.CourseRegistration.CourseSection.Course.ValidCampus.Description	Element	Description	Exactly One	Student's Course Campus Description Ex. Global Campus Chicago"	STVCAMP_DESC
StudentEnrollment.CourseRegistration.CourseSection.Course.CourseTitle	Element	CourseTitle	Exactly One	Student's Course Title	SSBSECT_CRSE_TITLE or, if NULL, SCBCRSE_TITLE
StudentEnrollment.CourseRegistration.CourseSection.Course.ValidCollege	Object/Array	ValidCollege	Zero or One
StudentEnrollment.CourseRegistration.CourseSection.Course.ValidCollege.Code	Element	Code	Exactly One	Student's Course College Code Ex. PH (Liberal Arts & Sciences)"	STVCOLL_CODE
StudentEnrollment.CourseRegistration.CourseSection.Course.ValidCollege.Description	Element	Description	Exactly One	Student's Course College Description Ex. Liberal Arts & Sciences"	STVCOLL_DESC
StudentEnrollment.CourseRegistration.CourseSection.Course.ValidDepartment	Object/Array	ValidDepartment	Zero or One
StudentEnrollment.CourseRegistration.CourseSection.Course.ValidDepartment.Code	Element	Code	Exactly One	Student's Course Department Code Ex. 1204 (Manufacturing Engineering)"	STVDEPT_CODE
StudentEnrollment.CourseRegistration.CourseSection.Course.ValidDepartment.Description	Element	Description	Exactly One	Student's Course Department Description Ex. Manufacturing Engineering"	STVDEPT_DESC
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession	Object/Array	CourseSectionSession	Zero or Many
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.CourseSectionSessionID	Element	CourseSectionSessionID	Zero or One	Student's Course Section Session ID	SSRMEET_CATAGORY
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.MeetsOnSundayFlag	Element	MeetsOnSundayFlag	Zero or One	Student's Course Section Session Meeting Day Indicators	SSRMEET_SUN_DAY
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.MeetsOnMondayFlag	Element	MeetsOnMondayFlag	Zero or One	Student's Course Section Session Meeting Day Indicators	SSRMEET_MON_DAY
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.MeetsOnTuesdayFlag	Element	MeetsOnTuesdayFlag	Zero or One	Student's Course Section Session Meeting Day Indicators	SSRMEET_TUE_DAY
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.MeetsOnWednesdayFlag	Element	MeetsOnWednesdayFlag	Zero or One	Student's Course Section Session Meeting Day Indicators	SSRMEET_WED_DAY
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.MeetsOnThursdayFlag	Element	MeetsOnThursdayFlag	Zero or One	Student's Course Section Session Meeting Day Indicators	SSRMEET_THU_DAY
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.MeetsOnFridayFlag	Element	MeetsOnFridayFlag	Zero or One	Student's Course Section Session Meeting Day Indicators	SSRMEET_FRI_DAY
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.MeetsOnSaturdayFlag	Element	MeetsOnSaturdayFlag	Zero or One	Student's Course Section Session Meeting Day Indicators	SSRMEET_SAT_DAY
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.CourseSessionInstructor	Object/Array	CourseSessionInstructor	Zero or Many
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.CourseSessionInstructor.LightweightPerson	Object/Array	LightweightPerson	Exactly One
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.CourseSessionInstructor.LightweightPerson.Name	Object/Array	Name	Zero or One
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.CourseSessionInstructor.LightweightPerson.Name.LastName	Element	LastName	Exactly One	Instructor's Last Name	SPRIDEN_LAST_NAME
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.CourseSessionInstructor.LightweightPerson.Name.FirstName	Element	FirstName	Exactly One	Instructor's First Name	SPRIDEN_FIRST_NAME
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.CourseSessionInstructor.LightweightPerson.InstitutionalId	Element	InstitutionalId	Exactly One	Instructor'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
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.CourseSessionInstructor.EmailAddress	Element	EmailAddress	Zero or One	Instructor's Email Address	GOREMAL_EMAIL_ADDRESS
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.StartTime	Element	StartTime	Zero or One	Student's Course Section Session Starting Time	SSRMEET_BEGIN_TIME
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.EndTime	Element	EndTime	Zero or One	Student's Course Section Session Ending Time	SSRMEET_END_TIME
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.ValidBuilding	Object/Array	ValidBuilding	Zero or One
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.ValidBuilding.Code	Element	Code	Exactly One	Student's Course Section Session Building Code Ex. 4CBM (College of Bus. & Mgt.)"	STVBLDG_CODE
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.ValidBuilding.Description	Element	Description	Exactly One	Student's Course Section Session Building Description Ex. College of Bus. & Mgt."	STVBLDG_DESC
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.Room	Element	Room	Zero or One	Student's Course Section Session Room	SSRMEET_ROOM_CODE
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.ValidCourseScheduleType	Object/Array	ValidCourseScheduleType	Zero or One
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.ValidCourseScheduleType.Code	Element	Code	Exactly One	Student's Course Section Session Schedule Type Code Ex. LEC (Lecture)"	STVSCHD_CODE
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.ValidCourseScheduleType.Description	Element	Description	Exactly One	Student's Course Section Session Schedule Type Description Ex. Lecture"	STVSCHD_DESC
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.StartDate	Element	StartDate	Zero or One	Student's Course Section Session Starting Date	SSRMEET_START_DATE or, if NULL, SSBSECT_PTRM_START_DATE
StudentEnrollment.CourseRegistration.CourseSection.CourseSectionSession.EndDate	Element	EndDate	Zero or One	Student's Course Section Session Ending Date	SSRMEET_END_DATE or, if NULL, SSBSECT_PTRM_END_DATE
StudentEnrollment.CourseRegistration.CourseSection.CreditHours	Element	CreditHours	Zero or One	Student's Course Section Credit Hours	SFRSTCR_CREDIT_HR
StudentEnrollment.CourseRegistration.CourseSection.ValidPartTerm	Object/Array	ValidPartTerm	Zero or One
StudentEnrollment.CourseRegistration.CourseSection.ValidPartTerm.Code	Element	Code	Exactly One	Student's Course Section Part of Term Code Ex. A (First Half)"	STVPTRM_CODE
StudentEnrollment.CourseRegistration.CourseSection.ValidPartTerm.Description	Element	Description	Exactly One	Student's Course Section Part of Term Description Ex. First Half"	STVPTRM_DESC
StudentEnrollment.CourseRegistration.CourseSection.StartDate	Element	StartDate	Zero or One	Student's Course Section Starting Date	SSRMEET_START_DATE or, if NULL, SSBSECT_PTRM_START_DATE
StudentEnrollment.CourseRegistration.CourseSection.EndDate	Element	EndDate	Zero or One	Student's Course Section Ending Date	SSRMEET_END_DATE or, if NULL, SSBSECT_PTRM_END_DATE