Anthology API Endpoints
The Anthology integration requires a defined set of API permissions to allow Element451 to exchange data with the SIS.
Element451 uses multiple Anthology API endpoints to:
- Send data to the SIS
- Retrieve data from the SIS
The specific endpoints required may vary by partner depending on the scope of the integration.
Permission Requirements#
- Each endpoint must have the appropriate read and/or write access enabled
- Permissions are typically configured based on Element451’s standard integration best practices
- Some implementations may require additional endpoints based on custom configurations
It is important to confirm that all required permissions are correctly configured before beginning the integration build.
Verifying Permissions#
Partners can validate access using the Anthology API Key Checker (opens in a new tab). This tool verifies that the configured API key has access to the required endpoints.
Note: Depending on the volume of data in the SIS, the check may take several minutes to complete
| Name | Access |
|---|---|
| /api/commands/Admissions/Applicant/create | Read |
| /api/commands/Admissions/Applicant/get | Read |
| /api/commands/Admissions/Applicant/getApplicationStatusChange | Read |
| /api/commands/Admissions/Applicant/save | Write |
| /api/commands/Admissions/Applicant/saveNew | Write |
| /api/commands/Admissions/EntranceTestScore/AddEntranceTestScores | Write |
| /api/commands/Admissions/EntranceTestScore/CreateEntranceTestScoreFromTemplate | Read |
| /api/commands/Admissions/EntranceTestScore/DeleteEntranceTestScores | Delete |
| /api/commands/Admissions/EntranceTestScore/get | Read |
| /api/commands/Admissions/EntranceTestScore/save | Write |
| /api/commands/Admissions/EntranceTestScore/SaveEntranceTestScores | Write |
| /api/commands/Admissions/StudentPreviousEducation/create | Read |
| /api/commands/Admissions/StudentPreviousEducation/get | Read |
| /api/commands/Admissions/StudentPreviousEducation/save | Write |
| /api/commands/Admissions/StudentPreviousEducation/saveNew | Write |
| /api/commands/Common/Student/create | Read |
| /api/commands/Common/Student/get | Read |
| /api/commands/Common/Student/save | Write |
| /api/commands/Common/Student/saveNew | Write |
| /api/commands/Common/StudentRelationshipAddress/create | Read |
| /api/commands/Common/StudentRelationshipAddress/get | Read |
| /api/commands/Common/StudentRelationshipAddress/save | Write |
| /api/commands/Common/StudentRelationshipAddress/saveNew | Write |
| /api/commands/crm/Document/SaveNew | Write |
| /api/commands/PostFileUpload/Common/PersonPicture/UploadStudentPicture | Write |
| /api/commands/PostFileUpload/Crm/Document/UploadStudentDocument | Write |
| /api/commands/StudentServicers/StudentVeteranDetail/create | Read |
| /api/commands/StudentServicers/StudentVeteranDetail/get | Read |
| /api/commands/StudentServicers/StudentVeteranDetail/save | Write |
| /api/commands/StudentServicers/StudentVeteranDetail/saveNew | Write |
| /ds/campusnexus/AdmissionsReps | Read |
| /ds/campusnexus/Applicants | Read |
| /ds/campusnexus/ApplicantTypes | Read |
| /ds/campusnexus/BillingMethods | Read |
| /ds/campusnexus/Campuses | Read |
| /ds/campusnexus/CatalogYears | Read |
| /ds/campusnexus/Citizens | Read |
| /ds/campusnexus/Colleges | Read |
| /ds/campusnexus/Counties | Read |
| /ds/campusnexus/Countries | Read |
| /ds/campusnexus/Degrees | Read |
| /ds/campusnexus/DocumentTypes | Read |
| /ds/campusnexus/Enrollments | Read |
| /ds/campusnexus/EnrollmentStatuses | Read |
| /ds/campusnexus/EntranceTests | Read |
| /ds/campusnexus/EntranceTestScores | Read |
| /ds/campusnexus/Ethnicities | Read |
| /ds/campusnexus/Genders | Read |
| /ds/campusnexus/GradeLevels | Read |
| /ds/campusnexus/GradeScales | Read |
| /ds/campusnexus/HighSchools | Read |
| /ds/campusnexus/LeadSources | Read |
| /ds/campusnexus/Programs | Read |
| /ds/campusnexus/ProgramVersions | Read |
| /ds/campusnexus/SchoolStartDates | Read |
| /ds/campusnexus/SchoolStatuses | Read |
| /ds/campusnexus/Shifts | Read |
| /ds/campusnexus/StudentEnrollmentPeriods | Read |
| /ds/campusnexus/StudentPreviousEducation | Read |
| /ds/campusnexus/StudentRelationshipAddresses | Read |
| /ds/campusnexus/Students | Read |
| /ds/campusnexus/Students/CampusNexus.GetStudentSummaryInfo | Read |
| /ds/campusnexus/StudentVeteranDetails | Read |
| /ds/campusnexus/Suffixes | Read |
| /ds/campusnexus/Terms | Read |
| /ds/campusnexus/Titles | Read |
| /ds/campusnexus/VeteranAffairsBenefits | Read |
| /ds/campusnexus/VeteranAffairsCodes | Read |
Was this page helpful?