iSAMS API

1. Log in to your iSAMS account.

2. Go to Control Panel Home > External Web Services > API Services Manager.

3. Select 'Request Batch API Key'.

4. Enter the following details:

• Integrator Name: Schoolbox Pty Ltd
• Product Name: Schoolbox

If the details are accurate, you should receive a support email from iSAMS via Zendesk.

6. Follow the link in the email.

7. Request your API key. Provide iSAMS with the following list of nodes required:

• Estate Manager Datasets
  • All Buildings & Rooms
• HR Manager Datasets
  • Current Staff
  • Current Staff - Photos
• Pupil Manager Datasets
  • Current Students
  • Current Students - Health
  • Contacts
  • Current Students - Photos
• School Manager Datasets
  • Academic Houses
  • School Divisions
  • School Forms
• SEN Manager Datasets
  • SEN Register
  • SEN Types
• Teaching Manager Datasets
  • Teaching Sets
  • Teaching Set Lists
• Timetable Manager Datasets
  • Published Timetable Schedule
  • Timetable Week Allocations
  • Weeks, Days & Periods

You can manage the iSAMS API Connector. 

To do this, as a Superuser:

1. Go to Administration > School Data Import > Home.
   This opens the School Data Import page for you.
    
2. In Data Source, select iSAMS from the drop-down list.
    
3. In School Data Endpoint Host, enter your School Data Endpoint Host.
   Note: The format for this address usually is '{your_school}.isams.cloud/api/batch/1.0', without 'https://', as this will cause the importer to fail.
    
4. In Import Frequency, choose your import frequency.
   Note: This should match the cache timeout in iSAMS. By default, it’s set to 24 hours when iSAMS creates the API. The iSAMS API will keep sending old data to Schoolbox until the cache expires. 
   
   It's recommended to perform an import after midnight to make sure that SUDS is updated with the correct timetable day and to collect the most current profile data, including information for new starters. This import should be completed before the scheduled run of the User Provisioning System. 
   You can perform an additional import before the school day starts to update any changes made to the timetable, such as cover lessons and room changes, in the SIS. A final import after working hours can be used to update any changes made by the SIS administrators throughout the day.
    
5. In Import Timeout, enter your import timeout.
    
6. Next, in iSAMS Configuration, enter the: 
   1. Batch XML Key
   2. Day Number Offset
      Note: If the iSAMS calendar is showing the incorrect day number at the start of the week, use this to correct the alignment. Set it to zero if no adjustment is needed.

   3. Parent
      Note: Enter the contact types, separated by commas (not case-sensitive), to choose which ones will be marked as parents of students. If you leave it blank, all contact types will be treated as parents by default.

      
      
       

7. When done, select Save.
   
   You've now managed the iSAMS API Connector.

Schoolbox gives you more control over how you import data using School User Data Store (SUDS) from an API connector into Schoolbox. You can now import specific groups of data - like user profile data, timetable data - separately, instead of all at once.

This will help you when you want to make small updates or test new data without affecting everything in your system.

To perform an update of your SUDS data from an API connector:

1. First, ensure you have enabled school data import for your school. See Managing the School User Data Store (SUDS). 
    
2. Next, go to Administration > School Data Import > Home.
   This opens the school data import home page for you. 
    
3. Then, select the 3-dot menu iconand select one of the following:
   • Update user data and timetables
   • Update user data only
   • Update timetable only
4. For each, select Save to proceed with the import.
    
5. Next, in Daily Org Import Time, enter the specific time of day when you want your school’s timetable data to be automatically imported into Schoolbox from your external system.
   Note: This runs every day of the week.
   This scheduled import ensures that any timetable updates made in your source system are reflected in Schoolbox each day.
   Timetable data updates are not immediate. They typically take around 15–20 minutes to appear in Schoolbox, though in some cases, it may take longer.
   Note: This field only affects the import of timetable data.
    
6. To view your current endpoint status and the status of previous imports, scroll beyond the API configuration:
    
7. Select 'current endpoint status' for a detailed view of the status of each endpoint and node as required.
   Note: The 'Previous Imports' section will vary based on the SIS and API configuration used.