Question

How do Aeries API student-related endpoints behave when a StudentID is provided, specifically regarding the required SchoolCode parameter?

Answer

The behavior of the SchoolCode parameter differs depending on the endpoint being used.

Student Information Endpoint

GET /api/v5/schools/{SchoolCode}/contacts/{StudentID}
  • The SchoolCode parameter is required and is used to scope the request.
  • When a StudentID is provided, the endpoint returns student information only for the specified SchoolCode.
  • If the student does not have a record at the specified school, the response is empty.
  • There is no single endpoint that returns student information across all schools for a given StudentID. If the student’s school is unknown, each school must be queried individually.

Contacts Endpoint

GET /api/v5/schools/{SchoolCode}/contacts/{StudentID}
  • The SchoolCode parameter is required in the URL but does not restrict the results when a valid StudentID is provided.
  • When StudentID is included, the endpoint returns all contact records associated with that student, regardless of school affiliation.
  • A static or placeholder SchoolCode value (for example, 000) may be safely used when retrieving contacts for a known StudentID.
  • If StudentID is not provided, the endpoint returns all contacts associated with the specified SchoolCode.

Documentation for these endpoints has been updated to clarify how SchoolCode is applied when StudentID is included.