Troubleshooting Issues

You can find solutions to common iSAMS integration issues below.

Validation Fails: Methods Not Allocated

• Issue: Source validation fails with an error indicating methods are not allocated to the API key (often MethodsNotAllocatedToKeyException).
• Potential Resolutions:
  • In iSAMS API Services Manager, open the Batch API client used for Edlink and allocate every required rostering method.
  • Re-run Validate Configuration in Edlink. Validation posts methods individually so you can see which method is missing.
  • Confirm you created a Batch client (not only a REST client) and granted the apiv1 scope.

Missing Departments, Courses, Classes, or Enrollments

• Issue: People sync, but curriculum data (departments, subjects, courses, classes, enrollments) is missing.
• Potential Resolutions:
  • Allocate Curriculum Batch methods (Curriculum_GetDepartments, Curriculum_GetSubjects, Curriculum_GetCourses, Curriculum_GetClasses, Curriculum_GetClassStudents, Curriculum_GetTypes, Curriculum_GetCycles).

Missing Guardians or Parent Relationships

• Issue: Students and staff appear, but guardians / agents do not.
• Potential Resolutions:
  • Allocate ContactAdvanced_GetContacts on the Batch API client.

Classes Missing Period Links

• Issue: Classes sync, but periods are empty or classes are not linked to periods.
• Potential Resolutions:
  • Allocate Timetable_GetTimetableStructure (periods) and Curriculum_GetBlocks (class→period linkage).
  • These methods are treated as optional for sync continuity; without them, rostering still runs but schedule linkage is incomplete.

Missing Students or Staff

• Issue: Some students or staff members are missing from the sync.
• Potential Resolutions:
  • Confirm Pupil_GetCurrentPupils and HumanResources_GetCurrentStaff are allocated.
  • Verify the individuals are current/active in iSAMS. The sync uses “current” pupil and staff methods, not former/historical rosters by default.

Validation Warning: No Data Received

• Issue: Validation reports a warning that a Batch method returned no data.
• Potential Resolutions:
  • Confirm the school actually has records for that entity in iSAMS.
  • Confirm the method is allocated and any required filters are satisfied.
  • A warning does not always block onboarding; required methods that error (403 / XML <Message>) will still fail validation.

OAuth or API Connection Errors

• Issue: Sync or validation fails while requesting a token or calling Batch.
• Potential Resolutions:
  • Confirm url, Client ID, and Client Secret match the iSAMS tenant and Batch client.
  • Confirm the host is reachable and the URL points at the iSAMS cloud/host (full xml.ashx URLs are also accepted).
  • Check for iSAMS throttle responses (ServiceThrottled) and retry later if you have exceeded request limits.
  • Invalid or revoked clients typically surface as InvalidApiKey or OAuth HTTP errors from /auth/connect/token.

Duplicate Records

• Issue: Duplicate people or classes appear after syncing.
• Potential Resolutions:
  • Edlink keys iSAMS records primarily on iSAMS internal IDs (and related identifiers such as person / school IDs where present). Check for duplicate source records in iSAMS.

Enrollment Status Discrepancies

• Issue: Enrollment state in Edlink does not match expectations in iSAMS.
• Potential Resolutions:
  • Student enrollments are currently all treated as Active in Edlink. Status IDs from iSAMS class–student records are not documented and thus not fully mapped yet.
  • Re-run sync after confirming class membership is correct in iSAMS.