School District API - User Documentation
This document provides instructions on how to use the API to retrieve school district information for a specific location.
Important Note: This API requires an access token for authorization. You will need to obtain an access token before proceeding.
Obtaining Access Token
To obtain an access token, you will need to call the login endpoint:
URL: https://api.aletheiasystems.com/login
Method: GET
Authentication: Basic Authentication
Headers:
- Authorization: Basic (base64 encoded username + ":" + password)
Request Body: (Optional) No request body is required.
Response
Upon successful login, the API will return a JSON response containing the access token and refresh token. These tokens will be used to access the School District information endpoint.
Example
Request:
curl -X GET -u "your_username:your_password" https://api.aletheiasystems.com/login
Response:
{ "AccessToken": "ACCESS_TOKEN", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "REFRESH_TOKEN", "IdToken": "ID_TOKEN" }
Please note: Replace your_username and your_password with your actual credentials.
Security Note: It is highly recommended to store your access token securely and avoid sharing it with anyone.
Retrieving School District Information
Once you have a valid access token, you can use it to retrieve school district information for a specific location.
URL: https://api.aletheiasystems.com/schooldistrict
Method: GET
Headers:
- Authorization: Bearer <access_token> (Replace <access_token> with your actual access token)
- Content-Type: application/json
Query Parameters:
- latitude: (Required) The latitude coordinate of the location.
- longitude: (Required) The longitude coordinate of the location.
Response
Upon successful execution, the API will return a JSON object containing detailed information about the school district at the specified location.
Example
Request:
curl -H "Content-Type: application/json" -H "Authorization: Bearer ACCESS_TOKEN" -X GET 'https://api.aletheiasystems.com/schooldistrict?latitude=26.0876769&longitude=-80.2003838'
Response:
{ "ELSDLEA": "", "FUNCSTAT": "E", "GEOID": "1200180", "GEO_YEAR": "2023", "HIGRADE": "12", "LOGRADE": "PK", "LSAD": "00", "MTFCC": "G5420", "NAME": "Broward County School District", "SCHOOLYEAR": "2022-2023", "SCSDLEA": "", "SDADMLEA": "", "SDTYP": "", "STATEFP": "12", "UNSDLEA": "00180" }
Description of Response Fields
Refer to the API documentation provided by Aletheia Systems for detailed information on each field within the response.
Notes
Click here if you need to contact us for further assistance or clarification regarding the API functionalities and the data returned.
This documentation provides a basic overview of how to use the API to retrieve school district information. Remember to replace placeholders with your actual credentials and consult the official API documentation for any specific requirements or limitations.
School District Response
The following section contains information related to the response from this API.
Key | Summary | Description |
---|---|---|
STATEFP | Current state Federal Information Processing Series (FIPS) code | National Standard Codes, Federal Information Processing Series |
ELSDLEA | Current elementary school district local education agency code | |
SCSDLEA | Current secondary school district local education agency code | |
UNSDLEA | Current unified school district local education agency code | |
SDADMLEA | Current administrative school district local education agency code (Vermont only) | |
GEOID | School district identifier; a concatenation of the current state Federal Information Processing Series (FIPS) code and school district local education agency code. | The GEOID attribute is a concatenation of the state FIPS code followed by either the secondary, elementary, or unified school district local education agency code. No spaces are allowed between the two codes. The State FIPS code is taken from "National Standard Codes (ANSI INCITS 38-2009), Federal Information Processing Series (FIPS) - States". The school district local education agency code is taken from the "SCSDLEA" attribute, the "ELSDLEA" attribute, the "UNSDLEA" attribute or "SDADMLEA" attribute. |
NAME | Current school district name | Values for this attribute are composed of a set of school district names. As such, they do not exist in a known, predefined set. |
LSAD | Current legal/statistical area description code for school district | |
LOGRADE | Current lowest grade covered by school district |
|
HIGRADE | Current highest grade covered by school district |
|
MTFCC | MAF/TIGER feature class code |
|
SDTYP | Current school district type |
|
FUNCSTAT | Current functional status |
|
ALAND | Current land area (square meters) | |
AWATER | Current water area (square meters) | |
INTPTLAT | Current latitude of the internal point | |
INTPTLON | Current longitude of the internal point | |
GEO_YEAR | Current TIGER/Line vintage | |
SCHOOLYEAR | Current academic year |