June 16, 2016: Integration Announcement
Hello Campus Application Developers,
Here is the SIS Integrations team weekly summary of items of interest to our integration partners.
Go Live 5.6
Our next major release is Go Live 5.6 which has been rescheduled to Sunday, 6/26. This release will include enhancements and bug fixes to the Student, Class and Terms APIs.
We will also introduce 2 new APIs: Descriptors and Person.
The Descriptors API provides lists of code values and their translations for coded fields returned as part of SIS EDOs. Descriptors is a standalone API meant to replace the Descriptors endpoints associated with individual APIs already released.
The SIS-Person API provides access to core bio-demo data for all persons in the SIS database including instructors and advisors, as well as students. Currently, the Student API allows access to non-Students using UID or EmplID. However, in the future, the Student API will be enhanced to return only Students and the SIS-Person API will have to be used to retrieve bio-demo data for non-Students.
Both of these APIs are now in API Central, and their UAT versions are available to become familiar with using the “Try It Out!” button. They will be released to production on 6/26 at Go Live 5.6.
API Usage Notes/FAQs
As API adoption has spread through campus, we have received very useful feedback from campus developers using SIS APIs including bug reports which we are addressing as quickly as possible. Please continue to give us your feedback so that we can improve the quality of our API portfolio. The best way to do this is to send an email to firstname.lastname@example.org.
How do I check the registration status of a student?
A common requirement for campus applications is to be able to check the registration status of a student when deciding whether to allow access to campus services or facilities. Previously, various methods were used including query of the Bearfacts database or the legacy Registration Status Check API.
Registration Status is not directly supported as a discrete field by Campus Solutions, but the various states that had been described by the legacy registration status code can be found using SIS Student API endpoints. For example, for basic registered/not status, the “/registrations” endpoint returns a “registered” boolean element for any specified term. That endpoint also returns an “eligibleToRegister” boolean, which will be set to true for all students allowed to enroll (and pay fees) regardless of whether they have registered yet. For the various other statuses, see the SIS Data Changes page on the SIS Project website.
Release Notes - GL 5.5
The next release notes will appear on Thursday, 6/30 after GL 5.6 on Sunday, 6/26
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: 113695594.
We welcome your feedback. If you have questions or comments, please contact us at email@example.com.
SIS Integration Team