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