Skip to Main Content
Status In Discovery
Categories REST API
Created by Guest
Created on Jun 17, 2024

Enable more fields in REST API

Currently it is frustrating to use the REST API, only to find that the field we are looking to review / update is not an available end point. Can you look into making it consistent which fields are available in the same screen. For example, in the Pupil Contacts & Networks tab in Pupil Manager, we can find the email address, home email address and mobile number, but we cannot find the Pupil username in the API. This lack of consistency is hindering our development on iSAMS.

  • Attach files
  • Guest
    Aug 18, 2026

    The most useful capabilities to expose would be:

    • Create a new contact/person record.

    • Update an existing contact/person record.

    • Create and update contact addresses, email addresses and telephone numbers.

    • Associate an existing or newly created contact with a student or applicant.

    • Define the relationship to the student, e.g. Mother, Father, Guardian, Grandparent.

    • Set parental responsibility.

    • Set contact priority/order.

    • Set correspondence, emergency, billing and other relevant contact flags.

    • Manage whether the contact lives with the student.

    • Remove or amend an existing student-contact relationship without deleting the underlying person.

    • Search/match existing contacts before creation, ideally using personId / personGuid, email, name/address or other suitable identifiers.

  • Guest
    Feb 6, 2025

    Please, add the "Entry Type" value in the students endpoint