February 25, 2016: Integration Announcement
Hello Campus Application Developers,
Recent Changes to the Student API now in Production
On 2/9/16, we added the academic status and registration resources to the Student API to provide access to the appropriate EDOs as documented on bMeta. bMeta is where you will find a description of the structure and data you can expect to consume in the API.
- the academic-status resource will provide access to current registration in addition to other data documented in the mapping table linked below
- the registration resource will provide access to current or past registrations, by term
To help developers identify which resources in the API serve which EDO, we have created this table under the What's Changing section of the website.
Upcoming Changes to the Student API
We will be releasing 3 enhancements to the Student API when Go Live 5 goes into production on 3/22/16. We plan to offer this new version in our pre-release UAT environment in advance of production and will announce this when it is available.
- All Resource: will include Academic Status under the /All resource, in addition to other data documented in the mapping table
These 2 enhancements may require you to rework your client code but will provide more useful data, better error handling and improve our ability to troubleshoot problems.
An API response wrapper will be added to standardize error message responses from the API. This will improve your access and understanding of error messages returned by the API. See bMeta under API Response for details.
The Affiliation component in the Student EDO will be changed to more accurately identify the status of a student by adding a “detail” element. As an example, instead of just type: Applicant, you’ll see type: Applicant, detail: Admitted, or type: Applicant, detail: SIR Complete.
For answers to recent questions about data changes see the Integration FAQ page.
Each Friday, the SIS Integrations team holds Virtual Office Hours from 1-3 pm to answer questions and discuss issues you may be having. To join us, call 1-888-240-2560 - meeting ID: 204807572.
We will use this email list to provide you with SIS Integrations information. While it is intended primarily for a technical audience, anyone can subscribe at bConnected Manage My Lists by entering the email list name at the bottom of the page. We want to spread the word, so please send this to anyone you think would be interested in this information.
We welcome your feedback. If you have questions or comments, please contact us at email@example.com.
SIS Integration Team