Exams Assist Logo Exams Assist

Help

iSAMS Batch API

We can now integrate with iSAMS via the Batch API. this needs to be configured in iSAMS.

Only schools that have an active API Services Manager subscription have the option to Create Batch API Keys

Create a Batch API Key

To set up Batch API Keys, follow the steps below

In the iSAMS Control Panel module, select the API Services Manager applet.

Select Manage Batch API Keys from the right hand menu.

The Manage Batch API Keys screen is displayed.

Click Create Batch API Key (or edit the SchoolworkSpace one if already created).

A popup window is displayed.

Give the API key a meaningful name e.g. SchoolWorkSpace Exams Assist and reduce the cache period down from 24 hours to 1 or 2 hours. We only fetch the data once a day or when you request a data sync so you won't want a long cache duration.

In the Batch Methods tab select Dataset Nodes

Estate

  • Buildings

Exams Manager

  • Exam Arrangements

  • Exam Flexible Arrangements

  • Exam Centres

  • Exam Cycles

  • Exam Entries

HR Manager

  • Current Staff

  • Photos (optional)

Pupil Manager

  • Contacts

  • Current Pupils

  • Photos

Registration Manager

  • Dates And Times

  • Out Of School Pupils

  • Present Codes

  • Registration Codes

  • Registration Periods

  • Registration Status

School Manager

  • Academic Houses

  • Boarding Houses

  • Pastoral Tutors

  • Forms

  • Divisions

  • Terms

  • Year Groups

Teaching Manager

  • Departments

  • Teaching Sets

  • Teaching Set Lists

In SchoolWorkSpace

Go to School Settings then Data and click on iSAMS settings.

Enter the API key and iSAMS host