Documentation for Teachade's API - V1
Access
To use the Teachade API you will need:
- To be a registered user of Teachade
- To register you application with Teachade
Registering an application with Teachade will provide you with a Developer Key - a unique identifying string - that is required for calls to the Teachade API.
Developer Key
Each application registered with Teachade will be identified by a Developer Key. A user on Teachade can have multiple applications registered, each with its own Developer Key. Developer Keys identify registered applications, not developers specifically.
Developer Keys are generated by Teachade for each application, and are assigned when an application is registered.
Applications can have their Developer Key regenerated if the developers associated with the application (and who have permissions to do so) deem it necessary. If you believe that your Developer Key is no longer secure, please regenerate them. Once a Developer Key is regenerated, the old one will no longer work when making requests to the Teachade API.
Connection and Requests
To connect to the Teachade API, send an HTTP request to the appropriate end point for your request type. This HTTP request should include your Developer Key.
The end points for the Teachade API start with http://www.teachade.com/api/v1/. The next part of the end point url will be the type of data you are working with - see the references below for specific end point information.
Response
Teachade uses conventional HTTP response codes to indicate success or failure of an API request.
- 200 OK
- A 200 response code means everything worked just fine
- 400 Bad Request
- A 400 response code means the request could not be completed, or that no data was found for the options used
- 401 Unauthorized
- A 401 response code means that the developer key was either not being accepted, or the resource requested is not available to this developer key
- 404 Not Found
- A 404 response code means that either the request was not supported, or the developer key is no longer valid
The response from the Teachade API will always be in JSON (javascript object notation).
API Reference
Below are the options and resources available through the Teachade API. All options can be sent as request parameters (get or post) to the end points listed. Remember to include your developer key as a request parameter as well.
Options that accept arrays should be coded as "parameter[]=1¶meter[]=2".
Resources
End Point: http://www.teachade.com/api/v1/resources/
A resource in Teachade is a piece of educational content created or posted by a user in the Teachade system. A resource can be a many types of content, such as a multimedia file, a link to a website, a lesson plan or more. See the section below on Resource Types for more information.
Options
| Parameter name | Accepted Value Types | Response |
|---|---|---|
| [none] | [empty] | Sending no parameters (other than the developer key) will return a list of all available records. |
| id | integer | This returns a single record that matches the id sent |
| page | integer | If the request results in a list, 10 results are returned at a time. The 'page' parameter can be used to offset the pages of results - i.e. page=1 returns results 1-10, page=2 returns results 11-20. |
| search | characters | This will perform a simple word search to filter the return data. Phrases are search as is, and in order - i.e. search="Great Teacher" will NOT return results for "Teacher Great" or "Great Super Teacher". |
| resource_types | integer / array of integers | This option will only return results that match the resource type ids submitted to it. See below for more about resource types |
| grades | integer / array of integers | This option will only return results tagged with the grade ids sent to it. See below for more about grades. |
| subjects | integer / array of integers | This option will only return results tagged with the subject ids sent to it. See below for more about subjects. |
Resource Types
End Point: http://www.teachade.com/api/v1/resources/types/
Teachade resources can be many types of content. The Resource Types are the definitions of these content types.
| Parameter name | Accepted Value Types | Response |
|---|---|---|
| [none] | [empty] | Sending no parameters (other than the developer key) will return a list of all available records. |
| id | integer | This returns a single record that matches the id sent |
Groups
End Point: http://www.teachade.com/api/v1/groups/
Groups are where users of the Teachade platform can collect to share resources and talk about issues. Not all groups are publicly available, so not all groups will be returned through the API.
| Parameter name | Accepted Value Types | Response |
|---|---|---|
| [none] | [empty] | Sending no parameters (other than the developer key) will return a list of all available records. |
| id | integer | This returns a single record that matches the id sent |
| page | integer | If the request results in a list, 10 results are returned at a time. The 'page' parameter can be used to offset the pages of results - i.e. page=1 returns results 1-10, page=2 returns results 11-20. |
| search | characters | This will perform a simple word search to filter the return data. Phrases are search as is, and in order - i.e. search="Great Teacher" will NOT return results for "Teacher Great" or "Great Super Teacher". |
Users
End Point: http://www.teachade.com/api/v1/users/
| Parameter name | Accepted Value Types | Response |
|---|---|---|
| [none] | [empty] | Sending no parameters (other than the developer key) will return a list of all available records. |
| id | integer | This returns a single record that matches the id sent |
| page | integer | If the request results in a list, 10 results are returned at a time. The 'page' parameter can be used to offset the pages of results - i.e. page=1 returns results 1-10, page=2 returns results 11-20. |
| search | characters | This will perform a simple word search to filter the return data. Phrases are search as is, and in order - i.e. search="Great Teacher" will NOT return results for "Teacher Great" or "Great Super Teacher". |
| roles | integer / array of integers | This option will only return results tagged with the role ids sent to it. See below for more about roles. |
| grades | integer / array of integers | This option will only return results tagged with the grade ids sent to it. See below for more about grades. |
| subjects | integer / array of integers | This option will only return results tagged with the subject ids sent to it. See below for more about subjects. |
Roles
End Point: http://www.teachade.com/api/v1/users/roles/
Roles are types of users, as identified by the user. Roles identify how users relate to education by interest or profression.
| Parameter name | Accepted Value Types | Response |
|---|---|---|
| [none] | [empty] | Sending no parameters (other than the developer key) will return a list of all available records. |
| id | integer | This returns a single record that matches the id sent |
Grades
End Point: http://www.teachade.com/api/v1/grades/
Grades refer to the traditional K-12+ grade level system. User can be tagged with grades to show interest in that grade level. Resources can be tagged with grades to show appropriateness of content.
Grades can also refer to other non-traditional levels of education level, such as "Staff Development" or "Retired".
| Parameter name | Accepted Value Types | Response |
|---|---|---|
| [none] | [empty] | Sending no parameters (other than the developer key) will return a list of all available records. |
| id | integer | This returns a single record that matches the id sent |
Subjects
End Point: http://www.teachade.com/api/v1/subjects/
Subjects are classification of knowledge, such as "Science" or "Math". User can be tagged with subjects to show interest, and resources can be tagged with subjects to show appropriateness of content.
| Parameter name | Accepted Value Types | Response |
|---|---|---|
| [none] | [empty] | Sending no parameters (other than the developer key) will return a list of all available records. |
| id | integer | This returns a single record that matches the id sent |
Strands
End Point: http://www.teachade.com/api/v1/subjects/strands/
Strands are sub-classification of subjects, i.e. "Algebra" and "Geometry" are strands of the "Math" subject.
| Parameter name | Accepted Value Types | Response |
|---|---|---|
| [none] | [empty] | Sending no parameters (other than the developer key) will return a list of all available records. |
| id | integer | This returns a single record that matches the id sent |
| subject_id | integer | This returns a list of records that belong to the subject_id sent |
Countries
End Point: http://www.teachade.com/api/v1/countries/
This end point returns the countries (nations) available in the Teachade system.
| Parameter name | Accepted Value Types | Response |
|---|---|---|
| [none] | [empty] | Sending no parameters (other than the developer key) will return a list of all available records. |
| id | integer | This returns a single record that matches the id sent |
States (Territories)
End Point: http://www.teachade.com/api/v1/countries/states/
Apologies for the American centric terminology, but states represent the administrative divisions (states, province, territory, region) of countries in the Teachade system. Not all countries have states in the Teachade system.
| Parameter name | Accepted Value Types | Response |
|---|---|---|
| [none] | [empty] | Sending no parameters (other than the developer key) will return a list of all available records. |
| id | integer | This returns a single record that matches the id sent |
| country_code | 2 letter characters | This returns a list of records that belong to the country_code sent |
Districts
End Point: http://www.teachade.com/api/v1/districts/
This end point will return records for US school districts. Currently Teachade only has data for the US.
| Parameter name | Accepted Value Types | Response |
|---|---|---|
| [none] | [empty] | Sending no parameters (other than the developer key) will return a list of all available records. |
| id | integer | This returns a single record that matches the id sent |
| page | integer | If the request results in a list, 10 results are returned at a time. The 'page' parameter can be used to offset the pages of results - i.e. page=1 returns results 1-10, page=2 returns results 11-20. |
| state_id | integer / array of integers | This returns a list of records that belong to the state_id(s) sent |
| search | characters | This will perform a simple word search to filter the return data. Phrases are search as is, and in order - i.e. search="Great Teacher" will NOT return results for "Teacher Great" or "Great Super Teacher". |
Institutions
End Point: http://www.teachade.com/api/v1/institutions/
An institution is a school, university, district office or other educational establishment.
| Parameter name | Accepted Value Types | Response |
|---|---|---|
| [none] | [empty] | Sending no parameters (other than the developer key) will return a list of all available records. |
| id | integer | This returns a single record that matches the id sent |
| page | integer | If the request results in a list, 10 results are returned at a time. The 'page' parameter can be used to offset the pages of results - i.e. page=1 returns results 1-10, page=2 returns results 11-20. |
| state_id | integer / array of integers | This returns a list of records that belong to the state_id(s) sent |
| country_code | 2 letter characters / array of 2 letter characters | This returns a list of records that belong to the country_code(s) sent |
| district_id | integer / array of integers | This returns a list of records that belong to the district_id(s) sent |
| search | characters | This will perform a simple word search to filter the return data. Phrases are search as is, and in order - i.e. search="Great Teacher" will NOT return results for "Teacher Great" or "Great Super Teacher". |
23.01.21.03.10.52 © 2024 Pearce, LLC