SIS - Anthology Student
Table of Contents
Provide the following information to your Technical Consultant
Provide the following information to your Technical Consultant by emailing integrations@readyeducation.com to create a ticket.
For the Anthology Student REST API integration, Ready Education requires the following:
Anthology Rest API Root URL
API user - username and password (which can be sent securely via privnote.com) (OPTIONAL)
API key
SIS Identifier: Primary user identifier coming from SIS (may be email, username, or a sysID specific to the SIS)(Note: This ID is provided via your User Provisioning method)
Test user credentials as listed here: Test User and Test Data Requirements
List of Required APIs
Required APIs for Courses
/ds/odata/Students
/ds/odata/StudentCourses
/ds/odata/ClassSectionMeetingSchedules
Note: The APIs related to the modules listed below (Finaid, Bursar, and Holds) are not currently available in CampusGroups / Ready Campus. These permissions should only be granted when implementing the “Financial Integrations” add-on module, which will be available for purchase soon!
Required APIs for Finaid Summary
/ds/odata/StudentAwards
/ds/odata/ScheduledDisbursements
/ds/odata/AwardYears
Required APIs for Bursar Summary
/ds/odata/StudentAccountTransactions
Required APIs for Hold Summary
/ds/odata/HoldStudentGroups
/ds/odata/StudentGroupMembers
API Details
1. /ds/odata/Students
Odata Query Params:
$filter=StudentNumber+eq+'460900'
$expand=Person
curl --location 'https://sisclientweb-tst-300947.campusnexus.cloud/ds/odata/Students?%24filter=StudentNumber%2Beq%2B%27460900%27&%24expand=Person' \
--header 'Authorization: ApplicationKey <key>'
2. /ds/odata/StudentCourses
Odata Query Params:
$filter=Student/Person/Id+eq+51132
$expand=Course,Term,Enrollment,ClassSection($expand=Campus,Instructor)
curl --location 'https://sisclientweb-tst-300947.campusnexus.cloud/ds/odata/StudentCourses?%24filter=Student%2FPerson%2FId%2Beq%2B51132&%24expand=Course%2CTerm%2CEnrollment%2CClassSection%28%24expand%3DCampus%2CInstructor%29' \
--header 'Authorization: ApplicationKey <key>'
3. /ds/odata/ClassSectionMeetingSchedules
Odata Query Params:
$filter=ClassSectionId+eq+10267+or+ClassSectionId+eq+42404
$expand=ClassSectionMeetingPattern($expand=MeetingPattern),Room($expand=Building)
curl --location 'https://sisclientweb-tst-300947.campusnexus.cloud/ds/odata/ClassSectionMeetingSchedules?%24filter=ClassSectionId%2Beq%2B10267%2Bor%2BClassSectionId%2Beq%2B42404%2Bor%2BClassSectionId%2Beq%2B43597%2Bor%2BClassSectionId%2Beq%2B55350%2Bor%2BClassSectionId%2Beq%2B55371%2Bor%2BClassSectionId%2Beq%2B61840%2Bor%2BClassSectionId%2Beq%2B10405%2Bor%2BClassSectionId%2Beq%2B2841%2Bor%2BClassSectionId%2Beq%2B3689%2Bor%2BClassSectionId%2Beq%2B4533%2Bor%2BClassSectionId%2Beq%2B7811%2Bor%2BClassSectionId%2Beq%2B7867%2Bor%2BClassSectionId%2Beq%2B9689%2Bor%2BClassSectionId%2Beq%2B16278%2Bor%2BClassSectionId%2Beq%2B21920%2Bor%2BClassSectionId%2Beq%2B24870%2Bor%2BClassSectionId%2Beq%2B24953%2Bor%2BClassSectionId%2Beq%2B29159%2Bor%2BClassSectionId%2Beq%2B33154%2Bor%2BClassSectionId%2Beq%2B33169%2Bor%2BClassSectionId%2Beq%2B42433%2Bor%2BClassSectionId%2Beq%2B53351%2Bor%2BClassSectionId%2Beq%2B53354%2Bor%2BClassSectionId%2Beq%2B56661%2Bor%2BClassSectionId%2Beq%2B10131%2Bor%2BClassSectionId%2Beq%2B50015%2Bor%2BClassSectionId%2Beq%2B10231%2Bor%2BClassSectionId%2Beq%2B55336%2Bor%2BClassSectionId%2Beq%2B61865%2Bor%2BClassSectionId%2Beq%2B10435&%24expand=ClassSectionMeetingPattern%28%24expand%3DMeetingPattern%29%2CRoom%28%24expand%3DBuilding%29' \
--header 'Authorization: ApplicationKey <key>'
4. /ds/odata/StudentAwards
Odata Query Params:
$filter=Student/Person/Id+eq+51132
$expand=FundSource
curl --location 'https://sisclientweb-tst-300947.campusnexus.cloud/ds/odata/StudentAwards?%24filter=Student%2FPerson%2FId%2Beq%2B51132&%24expand=FundSource' \
--header 'Authorization: ApplicationKey <key>'
5. /ds/odata/ScheduledDisbursements
Odata Query Params:
$filter=StudentAwardId+eq+64154
$expand=Term
curl --location 'https://sisclientweb-tst-300947.campusnexus.cloud/ds/odata/ScheduledDisbursements?%24filter=StudentAwardId%2Beq%2B64154&%24expand=Term' \
--header 'Authorization: ApplicationKey <key>'
6. /ds/odata/AwardYears
Odata Query Params:
None
curl --location 'https://sisclientweb-tst-300947.campusnexus.cloud/ds/odata/AwardYears' \
--header 'Authorization: ApplicationKey <key>'
7. /ds/odata/StudentAccountTransactions
Odata Query Params:
$filter=Student/Person/Id+eq+51132
$expand=Term
curl --location 'https://sisclientweb-tst-300947.campusnexus.cloud/ds/odata/StudentAccountTransactions?%24filter=Student%2FPerson%2FId%2Beq%2B51132&%24expand=Term' \
--header 'Authorization: ApplicationKey <key>'
8. /ds/odata/HoldStudentGroups
Odata Query Params:
$expand=StudentGroup
curl --location 'https://sisclientweb-tst-300947.campusnexus.cloud/ds/odata/HoldStudentGroups?%24expand=StudentGroup' \
--header 'Authorization: ApplicationKey <key>'
9. /ds/odata/StudentGroupMembers
Odata Query Params:
$filter=Student/Person/Id+eq+51132+and+(StudentGroup/Id+eq+18+or+StudentGroup/Id+eq+24
$expand=StudentGroup
curl --location 'https://sisclientweb-tst-300947.campusnexus.cloud/ds/odata/StudentGroupMembers?%24filter=Student%2FPerson%2FId%2Beq%2B51132%2Band%2B%28StudentGroup%2FId%2Beq%2B18%2Bor%2BStudentGroup%2FId%2Beq%2B24%2Bor%2BStudentGroup%2FId%2Beq%2B22%2Bor%2BStudentGroup%2FId%2Beq%2B25%2Bor%2BStudentGroup%2FId%2Beq%2B26%2Bor%2BStudentGroup%2FId%2Beq%2B27%2Bor%2BStudentGroup%2FId%2Beq%2B28%2Bor%2BStudentGroup%2FId%2Beq%2B19%2Bor%2BStudentGroup%2FId%2Beq%2B29%2Bor%2BStudentGroup%2FId%2Beq%2B6%2Bor%2BStudentGroup%2FId%2Beq%2B30%2Bor%2BStudentGroup%2FId%2Beq%2B31%2Bor%2BStudentGroup%2FId%2Beq%2B32%2Bor%2BStudentGroup%2FId%2Beq%2B33%2Bor%2BStudentGroup%2FId%2Beq%2B39%2Bor%2BStudentGroup%2FId%2Beq%2B57%2Bor%2BStudentGroup%2FId%2Beq%2B57%2Bor%2BStudentGroup%2FId%2Beq%2B57%2Bor%2BStudentGroup%2FId%2Beq%2B57%2Bor%2BStudentGroup%2FId%2Beq%2B57%2Bor%2BStudentGroup%2FId%2Beq%2B57%2Bor%2BStudentGroup%2FId%2Beq%2B57%2Bor%2BStudentGroup%2FId%2Beq%2B57%2Bor%2BStudentGroup%2FId%2Beq%2B57%2Bor%2BStudentGroup%2FId%2Beq%2B67%2Bor%2BStudentGroup%2FId%2Beq%2B66%2Bor%2BStudentGroup%2FId%2Beq%2B6%2Bor%2BStudentGroup%2FId%2Beq%2B8%2Bor%2BStudentGroup%2FId%2Beq%2B13%2Bor%2BStudentGroup%2FId%2Beq%2B16%2Bor%2BStudentGroup%2FId%2Beq%2B19%2Bor%2BStudentGroup%2FId%2Beq%2B22%2Bor%2BStudentGroup%2FId%2Beq%2B24%2Bor%2BStudentGroup%2FId%2Beq%2B25%2Bor%2BStudentGroup%2FId%2Beq%2B26%2Bor%2BStudentGroup%2FId%2Beq%2B27%2Bor%2BStudentGroup%2FId%2Beq%2B28%2Bor%2BStudentGroup%2FId%2Beq%2B29%2Bor%2BStudentGroup%2FId%2Beq%2B30%2Bor%2BStudentGroup%2FId%2Beq%2B31%2Bor%2BStudentGroup%2FId%2Beq%2B32%2Bor%2BStudentGroup%2FId%2Beq%2B33%2Bor%2BStudentGroup%2FId%2Beq%2B54%2Bor%2BStudentGroup%2FId%2Beq%2B55%2Bor%2BStudentGroup%2FId%2Beq%2B53%2Bor%2BStudentGroup%2FId%2Beq%2B52%2Bor%2BStudentGroup%2FId%2Beq%2B75%2Bor%2BStudentGroup%2FId%2Beq%2B39%2Bor%2BStudentGroup%2FId%2Beq%2B57%2Bor%2BStudentGroup%2FId%2Beq%2B6%2Bor%2BStudentGroup%2FId%2Beq%2B27%2Bor%2BStudentGroup%2FId%2Beq%2B28%2Bor%2BStudentGroup%2FId%2Beq%2B122%2Bor%2BStudentGroup%2FId%2Beq%2B130%2Bor%2BStudentGroup%2FId%2Beq%2B130%2Bor%2BStudentGroup%2FId%2Beq%2B130%2Bor%2BStudentGroup%2FId%2Beq%2B130%2Bor%2BStudentGroup%2FId%2Beq%2B130%2Bor%2BStudentGroup%2FId%2Beq%2B130%2Bor%2BStudentGroup%2FId%2Beq%2B130%2Bor%2BStudentGroup%2FId%2Beq%2B130%2Bor%2BStudentGroup%2FId%2Beq%2B130%2Bor%2BStudentGroup%2FId%2Beq%2B130%2Bor%2BStudentGroup%2FId%2Beq%2B130%29&%24expand=StudentGroup' \
--header 'Authorization: ApplicationKey <key>'
Required Permissions
The staff member associated with the integration key must have the following permission.
Name | Needed For | Type | Description |
|---|---|---|---|
Academics.ClassSection.Get | Academic | Operation | Anthology Student Built-In Operation |
Academics.ClassSection.Query | Academic | Operation | Anthology Student Built-In Operation |
Academics.MeetingPattern.Get | Academic | Operation | Anthology Student Built-In Operation |
Academics.MeetingPattern.Query | Academic | Operation | Anthology Student Built-In Operation |
Academics.ClassSectionMeetingPattern.Get | Academic | Operation | Anthology Student Built-In Operation |
Academics.ClassSectionMeetingPattern.Query | Academic | Operation | Anthology Student Built-In Operation |
Academics.ClassSectionMeetingSchedule.Get | Academic | Operation | Anthology Student Built-In Operation |
Academics.ClassSectionMeetingSchedule.Query | Academic | Operation | Anthology Student Built-In Operation |
Academics.Course.Get | Academic | Operation | Anthology Student Built-In Operation |
Academics.Course.Query | Academic | Operation | Anthology Student Built-In Operation |
Academics.Instructor.Get | Academic | Operation | Anthology Student Built-In Operation |
Academics.Instructor.Query | Academic | Operation | Anthology Student Built-In Operation |
Academics.StudentCourse.Get | Academic | Operation | Anthology Student Built-In Operation |
Academics.StudentCourse.Query | Academic | Operation | Anthology Student Built-In Operation |
Academics.StudentEnrollmentPeriod.Query |
| Operation | Anthology Student Built-In Operation |
Academics.Term.Get | Academic, FinAid | Operation | Anthology Student Built-In Operation |
Academics.Term.Query | Academic, FinAid | Operation | Anthology Student Built-In Operation |
Common.Building.Get | Academic | Operation | Anthology Student Built-In Operation |
Common.Building.Query | Academic | Operation | Anthology Student Built-In Operation |
Common.Campus.Get | Academic | Operation | Anthology Student Built-In Operation |
Common.Campus.Query | Academic | Operation | Anthology Student Built-In Operation |
Common.Person.Get | Academic | Operation | Anthology Student Built-In Operation |
Common.Person.Query | Academic | Operation | Anthology Student Built-In Operation |
Common.Room.Get | Academic | Operation | Anthology Student Built-In Operation |
Common.Room.Query | Academic | Operation | Anthology Student Built-In Operation |
Common.StaffGroupMember.Query |
| Operation | Anthology Student Built-In Operation |
Common.Student.Get | Academic | Operation | Anthology Student Built-In Operation |
Common.Student.Query | Academic | Operation | Anthology Student Built-In Operation |
Common.StudentGroupMember.Get | FinAid | Operation | Anthology Student Built-In Operation |
Common.StudentGroupMember.Query | FinAid | Operation | Anthology Student Built-In Operation |
FinancialAid.AwardYear.Get | FinAid | Operation | Anthology Student Built-In Operation |
FinancialAid.AwardYear.Query | FinAid | Operation | Anthology Student Built-In Operation |
FinancialAid.ScheduledDisbursement.Get | FinAid | Operation | Anthology Student Built-In Operation |
FinancialAid.ScheduledDisbursement.Query | FinAid | Operation | Anthology Student Built-In Operation |
FinancialAid.StudentAward.Get | FinAid | Operation | Anthology Student Built-In Operation |
FinancialAid.StudentAward.Query | FinAid | Operation | Anthology Student Built-In Operation |
FinancialAid.FundSource.Get | FinAid | Operation | Anthology Student Built-In Operation |
FinancialAid.FundSource.Query | FinAid | Operation | Anthology Student Built-In Operation |
Common.HoldStudentGroup.Get | FinAid | Operation | Anthology Student Built-In Operation |
Common.HoldStudentGroup.Query | FinAid | Operation | Anthology Student Built-In Operation |
StudentAccounts.StudentAccountTransaction.Get | FinAid | Operation | Anthology Student Built-In Operation |
StudentAccounts.StudentAccountTransaction.Query | FinAid | Operation | Anthology Student Built-In Operation |
Academic Records - All Reports | Academic | Task | Anthology Student Built-In Task |
Academics - Additional GPA - Edit | Academic | Task | Anthology Student Built-In Task |
Academics - Class Scheduling - View | Academic | Task | Anthology Student Built-In Task |
Academics - Student Course - View | Academic | Task | Anthology Student Built-In Task |
Common - Student - View | Academic | Task | Anthology Student Built-In Task |
Common - Student Group - View | Academic | Task | Anthology Student Built-In Task |
Financial Aid - Student Award - View | FinAid | Task | Anthology Student Built-In Task |
Student Accounts - Student Account Transaction - View | FinAid | Task | Anthology Student Built-In Task |
How to Generate Application API Keys
Click the New button on the toolbar.
Review, change or specify the following values.
Application Key Indicates the key required for API integration. This field is disabled. Each system generated application key is associated with a system-generated staff member (for example, StudentApiUser@anthology.local).
Calling Application Name Indicates the name of application that uses the CampusLink API for the integrations. This field is limited to 200 characters and cannot contain any space. Special characters and numbers are allowed. This field has to be unique. At the time of key generation, record the application key’s value for use in your client application code. This value is never displayed again after you leave this page.
Expiration Date Indicates the date when the API Key is no longer valid. This date is posted when the integrations with given API key do not work. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date. This field cannot be set to more than 2 years from the current date.Click Save to save the changes. Anthology Student displays the Copy Application Key dialog box.
Click the Copy Application Key button. Anthology Student saves the record and recommends that the existing application integrations must be modified to use the new key.
Copy the key into a text file since this Application Key will never be available to copy once you leave this page. You must secure this key to prevent unauthorized access and share it securely with authorized personnel or third-party vendors who will integrate with CampusLink.