StudentAdvisors
Service Information:
Version: 1.0
Availability: Production
Release Date: February 2019
Framework: AITS RESTful Data API
Description: Retrieve listing of student advisors for a given student and term.
Source System: Banner
Operations:
GET https://webservices.admin.uillinois.edu/studentWS/data/{senderAppId}/StudentAdvisors/1_0/{queryUIN}/{queryTermCode}?format={format}
| Parameter | Description | Type | Required |
|---|---|---|---|
| senderAppId | Authorized sender application ID. | String | Yes |
| queryUIN | University Id Number (UIN) of student. | String | Yes |
| queryTermCode | Academic term for which student-advisor relationships should be retrieved. | String | Yes |
| format | Desired response format. Supports either "json" (default) or "xml". | String | No |
Sample Request
GET /studentWS/data/mySenderAppId/StudentAdvisors/1_0/123456789/420188 HTTP/1.1
Host: https://webservices-dev.admin.uillinois.edu
Data Object Detail:
Functional Area: Student
Name:StudentAdvisors
Version:1.0
Element Map:
| Path | Type | Name | Occurrence | Description |
|---|---|---|---|---|
| object | Element | object | Exactly One | Identifies the name of the object retrieved. |
| version | Element | version | Exactly One | Identifies the version of the object retrieved. |
| list | Object/Array | list | Zero or One | Parent object containing a listing of student-advisor relationships |
| list.queryUIN | Element | queryUIN | Exactly One | The client-provided query parameter for a student's UIN |
| list.queryTermCode | Element | queryTermCode | Exactly One | The client-provided query parameter for term code |
| list.person | Object/Array | person | Exactly One | Object containing information about the student person |
| list.person.guid | Element | guid | Exactly One | Banner unique integration identifier for a person record |
| list.person.pidm | Element | pidm | Exactly One | Banner unique database identifier for a person record |
| list.person.uin | Element | uin | Exactly One | University ID Number (UIN) |
| list.advisors | Object/Array | advisors | Zero or One | Object containing an array of advisors associated to a student |
| list.advisors.person | Object/Array | person | Exactly One | Objecting containing information about an advisor person |
| list.advisors.person.guid | Element | guid | Exactly One | Banner unique integration identifier for a person record |
| list.advisors.person.pidm | Element | pidm | Exactly One | Banner unique database identifier for a person record |
| list.advisors.person.uin | Element | uin | Exactly One | University ID Number (UIN) |
| list.advisors.advisorTerm | Element | advisorTerm | Exactly One | Object containing details about the academic term associated with the advisor appointment |
| list.advisors.advisorTerm.code | Element | code | Exactly One | Term code |
| list.advisors.advisorTerm.description | Object/Array | description | Exactly One | Term code description |
| list.advisors.primaryAdvisorInd | Element | primaryAdvisorInd | Exactly One | Indicates whether this advisor serves as primary, for this student, for the academic term |
| list.advisors.advisorType | Element | advisorType | Zero or One | Object containing details about the type of advisor appointment |
| list.advisors.advisorType.code | Element | code | Exactly One | Advisor type code |
| list.advisors.advisorType.description | Object/Array | description | Exactly One | Advisor type code description |