This API can be used to obtain enrollment data such as teachers, student school associations, and school classes
- academic years
- student school associations
- educator school associations
- school classes
All endpoint requests referenced below are require to have the following in the header and query parameters:
- Content-Type (This would be 'application/json')
- apikey (The unique Consumer Key for the App)
- Authorization (The OAuth2 bearer access token obtained from /auth/v1/token)
- To get {{perspective-bid}} hit api GET request https://api.nwea.org/organizations/v1/districts/, response districtBid = perspective-bid
- To get {{school-bid}} hit api GET request https://api.nwea.org/organizations/v1/districts/{{districtbid}}/schools
- To get {{student-bid}} and {{state-student-id}} hit api GET request https://api.nwea.org/organizations/v1/schools/{{schoolbid}}/students, response studentId = state-student-id
- To get student details hit api GET request https://api.nwea.org/students/v2/{studentBid}
ACADEMIC YEARS
This operation returns academic years (with their enrollment sessions) based on the search criteria specified via query parameters.
Example cURL command and response:
curl --location --request GET 'https://api.nwea.org/enrollments/v1/academic-years?perspective-bid={{perspective-bid}}&academic-year-bid={{academic-year-bid}}&received-before-date=2020-08-01&received-after-date=2021-07-31&school-bid={{school-bid}}' \
--header 'apikey: y5nkmrxJLnWH6oOmMRNO3yejFm
kYl9Yl' \
--header 'Authorization: Bearer NumW40X5FQ7QUfwOVabBmH79etmt'
Query Param
| perspective-bid | The enrollment perspective whose data you wish to retrieve. Perspectives allow for different stakeholders (states, districts, etc) to see different sets of data that can contain the same entities (schools, students, educators). | Required |
| school-bid | The identifier of the school whose academic years you wish to retrieve. | Required |
| effective-date | Will filter the results to academic years that encompass the date provided by this query parameter. There will either be one or zero academic year records in the response if this query parameter is used. | Optional |
| modified-since | Will filter the results to academic years that were modified on or after the specified date. When using this query parameter to retrieve deltas from a point in time that you’re keeping track of NWEA recommends subtracting 10 minutes from the date time you last invoked the API and using that value as the value for this query parameter. | Optional |
| include-removed | If the value of this query parameter is true enrollment data that once existed but has since been removed will be included in the response. This query parameter exists primarily for data integrations with 3rd parties. | Optional |
| next-page | This query parameter is used when you wish to obtain the next page of results for a previous invocation of this endpoint. The value of this query parameter must match the value of pagination.nextPage found in the response to the previous endpoint invocation. | Optional |
Response
{
"academicYears": [
{
"academicYearBid": "5d524b8b-8a3a-46ac-9162-c68431dad9a1",
"perspectiveBid": "38382b3f-a4ad-4aa5-8cad-3cf86694640d",
"schoolBid": "92d916ef-175d-4c3e-92cc-9d666ad12b9a",
"endDate": "2021-07-31",
"beginDate": "2020-08-01",
"description": "2020-2021",
"enrollmentSessions": [
{
"beginDate": "2020-12-01",
"description": "Winter 2020-2021",
"endDate": "2021-03-06",
"enrollmentSessionBid": "0bc5fb80-5aa9-4325-8e5f-97daa2e5b7b9"
}
],
"modifiedDateTime": "2021-02-02T16:13:56.319Z"
}
],
"pagination": {
"hasNextPage": false
}
}
STUDENT SCHOOL ASSOCIATIONS
To get list of student school association
Example cURL command and response:
Must provide one of [perspectiveBid, schoolBid] [perspectiveBid, studentBid] [perspectiveBid, districtStudentId] [perspectiveBid, stateStudentId] [perspectiveBid, studentSchoolAssociationBid] [perspectiveBid, nextPage]
curl --location --request GET 'https://api.nwea.org/enrollments/v1/student-school-associations?perspective-bid={{perspective-bid}}&student-bid={{student-bid}}' \
--header 'apikey: SAOPGBqDqz9WM5wzlXOiek2fxn0IbmIg' \
--header 'Authorization: Bearer oU5aW8R8Jk5A7MoEbHWzR5ydAzV5'
Query Param
| perspective-bid | The enrollment perspective whose data you wish to retrieve. Perspectives allow for different stakeholders (states, districts, etc) to see different sets of data that can contain the same entities (schools, students, educators). | Required |
| school-bid | The identifier of the school whose student-school-associations you wish to retrieve | Required |
| student-bid | The identifier of the student whose student-school-associations you wish to retrieve | Optional |
| state-student-id | The state student identifier of the student whose student-school-associations you wish to retrieve | Optional |
| district-student-id | The district student identifier of the student whose student-school-associations you wish to retrieve | Optional |
| effective-date | Will filter the results to students-school-associations that were active on the specified date. Defaults to the current UTC date. | Optional |
| modified-since | Will filter the results to student school associations that were modified on or after the specified date. When using this query parameter to retrieve deltas from a point in time that you’re keeping track of NWEA recommends subtracting 10 minutes from the date time you last invoked the API and using that value as the value for this query parameter.", | Optional |
| include-removed | If the value of this query parameter is true enrollment data that once existed but has since been removed will be included in the response. This query parameter exists primarily for data integrations with 3rd parties. | Optional |
| next-page | This query parameter is used when you wish to obtain the next page of results for a previous invocation of this endpoint. The value of this query parameter must match the value of pagination.nextPage found in the response to the previous endpoint invocation. | Optional |
Response
{
--header 'apikey: SAOPGBqDqz9WM5wzlXOiek2fxn0IbmIg' \
--header 'Authorization: Bearer MFTExRq4ZwBtwmmzeZ90pXUqesqg'
| perspective-bid | The enrollment perspective whose data you wish to retrieve. Perspectives allow for different stakeholders (states, districts, etc) to see different sets of data that can contain the same entities (schools, students, educators). | Required |
SCHOOL CLASSES
| perspective-bid |
The enrollment perspective whose data you wish to retrieve. Perspectives allow for different stakeholders (states, districts, etc) to see different sets of data that can contain the same entities (schools, students, educators). |
Required |
|
school-bid |
The identifier of the school whose classes you wish to retrieve |
Required |
|
effective-date |
Will filter the results to school classes that were active on the specified date. Defaults to the current UTC date. |
Optional |
|
modified-since |
Will filter the results to school classes that were modified on or after the specified date. When using this query parameter to retrieve deltas from a point in time that you’re keeping track of NWEA recommends subtracting 10 minutes from the date time you last invoked the API and using that value as the value for this query parameter.", |
Optional |
|
include-removed |
If the value of this query parameter is true enrollment data that once existed but has since been removed will be included in the response. This query parameter exists primarily for data integrations with 3rd parties. |
Optional |
|
next-page |
This query parameter is used when you wish to obtain the next page of results for a previous invocation of this endpoint. The value of this query parameter must match the value of pagination.nextPage found in the response to the previous endpoint invocation. |
Optional |
"schoolClasses": [
{
"className": "English1 - Jubran -",
"perspectiveBid": "977c9f9f-c378-4ae8-b0ce-4516deb831e5",
"schoolBid": "a98d4bd5-4446-42e2-9125-61b06c5f7ad2",
"endDate": "2021-02-28",
"classSubject": "english/language arts",
"beginDate": "2020-12-01",
"schoolClassBid": "ddd5a129-db31-431f-b76d-03f6ca2ef274",
"educators": [
{
"educatorBid": "5a432bea-d9b2-4783-adc7-712191719c11",
"firstName": "Mekia",
"lastName": "Jubran",
"middleName": "A"
}
],
"modifiedDateTime": "2020-12-02T03:01:06.747Z",
"students": []
}
],
"pagination": {
"hasNextPage": false
}
}
This operation returns the details for a single school class business event.
Example cURL command and response:
curl --location --request GET 'https://api.nwea.org/enrollments/v1/school-classes/{{schoolClassBid}}?perspective-bid={{perspective-bid}}' \
--header 'apikey: SAOPGBqDqz9WM5wzlXOiek2fxn0IbmIg' \
--header 'Authorization: Bearer MFTExRq4ZwBtwmmzeZ90pXUqesqg'
Query Param
| perspective-bid | The enrollment perspective whose data you wish to retrieve. Perspectives allow for different stakeholders (states, districts, etc) to see different sets of data that can contain the same entities (schools, students, educators). | Required |
Response
This operation can be used to retrieve the classes that a student belongs to.
Example cURL command and response:
curl --location --request GET 'https://api.nwea.org/enrollments/v1/student-school-classes?perspective-bid={{perspective-bid}}&student-bid={{student-bid}}&school-bid={{school-bid}}' \
--header 'apikey: SAOPGBqDqz9WM5wzlXOiek2fxn0IbmIg' \
--header 'Authorization: Bearer MFTExRq4ZwBtwmmzeZ90pXUqesqg'
Query Param
|
perspective-bid
|
The enrollment perspective whose data you wish to retrieve. Perspectives allow for different stakeholders (states, districts, etc) to see different sets of data that can contain the same entities (schools, students, educators). | Required |
|
student-bid
|
The identifier of the student whose classes you wish to retrieve | Required |
|
school-bid
|
The identifier of the school whose classes you wish to retrieve | Optional |
|
effective-date
|
Will filter the results to school classes that were active on the specified date. Defaults to the current UTC date. | Optional |
|
modified-since
|
Will filter the results to school classes that were modified on or after the specified date. When using this query parameter to retrieve deltas from a point in time that you’re keeping track of NWEA recommends subtracting 10 minutes from the date time you last invoked the API and using that value as the value for this query parameter.", | Optional |
|
include-removed
|
If the value of this query parameter is true enrollment data that once existed but has since been removed will be included in the response. This query parameter exists primarily for data integrations with 3rd parties. | Optional |
| next-page | This query parameter is used when you wish to obtain the next page of results for a previous invocation of this endpoint. The value of this query parameter must match the value of pagination.nextPage found in the response to the previous endpoint invocation. | Optional |
Response
This operation can be used to retrieve the classes that an educator belongs to.
Example cURL command and response:
curl --location --request GET 'https://api.nwea.org/enrollments/v1/educator-school-classes?perspective-bid={{perspective-bid}}&educator-bid={{educator-bid}}&school-bid={{school-bid}}' \
--header 'apikey: SAOPGBqDqz9WM5wzlXOiek2fxn0IbmIg' \
--header 'Authorization: Bearer MFTExRq4ZwBtwmmzeZ90pXUqesqg'
Query Param
|
perspective-bid
|
The enrollment perspective whose data you wish to retrieve. Perspectives allow for different stakeholders (states, districts, etc) to see different sets of data that can contain the same entities (schools, students, educators). | Required |
|
educator-bid
|
The identifier of the educator whose classes you wish to retrieve | Required |
|
school-bid
|
The identifier of the school whose classes you wish to retrieve | Optional |
|
effective-date
|
Will filter the results to educator school classes that were active on the specified date. Defaults to the current UTC date. | Optional |
|
modified-since
|
Will filter the results to educator school classes that were modified on or after the specified date. When using this query parameter to retrieve deltas from a point in time that you’re keeping track of NWEA recommends subtracting 10 minutes from the date time you last invoked the API and using that value as the value for this query parameter.", | Optional |
|
include-removed
|
If the value of this query parameter is true enrollment data that once existed but has since been removed will be included in the response. This query parameter exists primarily for data integrations with 3rd parties. |
Optional |
|
next-page
|
This query parameter is used when you wish to obtain the next page of results for a previous invocation of this endpoint. The value of this query parameter must match the value of pagination.nextPage found in the response to the previous endpoint invocation. | Optional |
Response
EDUCATOR SCHOOL ASSOCIATIONS
This operation can be used to retrieve a list of educator school association.
Example cURL command and response:
curl --location --request GET 'https://api.nwea.org/enrollments/v1/educator-school-associations?perspective-bid={{perspective-bid}}&school-bid={{school-bid}}' \
--header 'apikey: SAOPGBqDqz9WM5wzlXOiek2fxn0IbmIg' \
--header 'Authorization: Bearer W00eh5o9nJiLt0UPZ82EquQCgc9g'
Query Param
|
perspective-bid
|
The enrollment perspective whose data you wish to retrieve. Perspectives allow for different stakeholders (states, districts, etc) to see different sets of data that can contain the same entities (schools, students, educators). | Required |
|
school-bid
|
The identifier of the school whose educator associations you wish to retrieve | Required |
|
educator-bid
|
The identifier of the educator whose school associations you wish to retrieve | Optional |
| effective-date | Will filter the results to educator school associations that were active on the specified date. Defaults to the current UTC date. | Optional |
|
modified-since
|
Will filter the results to educator school associations that were modified on or after the specified date. When using this query parameter to retrieve deltas from a point in time that you’re keeping track of NWEA recommends subtracting 10 minutes from the date time you last invoked the API and using that value as the value for this query parameter.", | Optional |
|
include-removed
|
If the value of this query parameter is true enrollment data that once existed but has since been removed will be included in the response. This query parameter exists primarily for data integrations with 3rd parties. | Optional |
|
next-page
|
This query parameter is used when you wish to obtain the next page of results for a previous invocation of this endpoint. The value of this query parameter must match the value of pagination.nextPage found in the response to the previous endpoint invocation. | Optional |
Response
This operation can be used to retrieve a single educator school association.
Example cURL command and response:
curl --location --request GET 'https://api.nwea.org/enrollments/v1/educator-school-associations/{{educatorSchoolAssociationBid}}?perspective-bid={{perspective-bid}}' \
--header 'apikey: SAOPGBqDqz9WM5wzlXOiek2fxn0IbmIg' \
--header 'Authorization: Bearer W00eh5o9nJiLt0UPZ82EquQCgc9g'
Query Param
| perspective-bid | The enrollment perspective whose data you wish to retrieve. Perspectives allow for different stakeholders (states, districts, etc) to see different sets of data that can contain the same entities (schools, students, educators). | Required |
Response
Some common response status code
-
Status Code Description Action Required 200 OK The request has succeeded. NA 401 Unauthorized The request authentication token expired or not valid Check url /auth/v1/token 403 Forbidden User is not authorized to access this resource with an explicit denyCheck ICP app access 500 Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.