Back to menu
v4.0.0
LiveBy Schools API offers detailed information about schools in a geographical area.
There are 3 kinds of school data that can be provided:
- Assigned schools are schools that someone at the residence, or lives inside the provided LiveBy boundary could attend. Usually, these are the schools that a public bus would service.
- Non-assigned public schools are free public schools that someone could attend if they could get transportation for the student to use. These are also often called open enroll schools.
- Private schools are schools a student must pay for in order to attend. Because private schools do not have attendance boundaries, LiveBy returns private schools within a distance to the provided geometry. If that geometry is a coordinate, you may control this distance. If the geometry is a LiveBy boundary, the distance is controlled by LiveBy.
API Responses
The responses documented here assume a successful response. In the case of an error, a HTTP status code will be provided that best matches the type of error. Common HTTP error status codes are:
- 400 Bad Request: The server could not understand the request due to invalid syntax.
- 401 Unauthorized: The client must authenticate itself to get the requested response.
- 403 Forbidden: The client does not have access rights to the content.
- 404 Not Found: The server can not find the requested resource.
- 500 Internal Server Error: The server has encountered a situation it doesn't know how to handle.
- 504 Gateway Timeout: The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.
An unsuccessful response will also contain JSON data detailing the error. This response follows this model:
{
"success": false,
"error": "text detail of the error"
}
Schools Endpoint
Get schools based on search criteria.