Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Page Contents:

Site Contents:


Introduction

This section provides a technical overview of the Scholar Snapp School Info API with a link to a formal OpenAPI specification.

API Overview

The Scholar Snapp School Info API is fairly simple and generally adheres to RESTful API design principles. Those developing systems that connect to the Snapp Central API will find many similarities, and, generally speaking, system development and interaction will look familiar to most API developers.

Example API Calls

To get a general sense of the usage, it's helpful to look at a few example calls:

Calling:

  • GET  https://{{base url}}/api/schools

   ...will return all schools from the system. By default, the system limits the results to the first 25 sorted by school name. This endpoint provides school records that contain all fields in the system.

Calling:

  • GET https://{{base url}}/api/schools?state=TX&order=city&limit=100

   ...will return all schools in Texas limited to the first 100. The list will be sorted by city.

Calling:

  • GET https://{{base url}}/api/schools?name=Austin&state=TX&order=name

   ...will return all schools in Texas with "Austin" in the name. The list will be sorted by school name, and will be limited to the first 25 records.

Calling:

  • GET https://{{base url}}/api/schools?name=Austin&state=TX&order=name&page=2

   ...will return the second page of results from the query above (i.e., records 26–50).

The examples above all called the primary /api/schools endpoint, which returns a lot of data for each school. If you only need identifying data points such as a name and location, you can use a different endpoint built for high performance. Calling:

  • GET https://{{base url}}/api/schoolDirectoryEntries?name=Austin&state=TX&order=name&limit=100

   ...will return summary information (name, city, state, id). 

Endpoints

The School Info API provides two endpoints:

  • /api/schools. Provides detailed school information.
  • /api/schoolDirectoryEntries. Provides summary school information.

Methods

The School Info API provides read-only data. Not surprisingly, the only method supported is GET. 

Parameters



Error Responses



API Specification

The Scholar Snapp School Info API has an interactive OpenAPI specification browsable in a Swagger UI here.


  • No labels