Understanding of how to get termBid from enrollment API. The academic-year enrollment API response contains the term data.
Knowing what enrollment session and term means:
There are four season_name summers, winter, fall, and spring in a session. So the enrollment session has details for all seasons with a beginning date and end date also the enrollmentSessionBid which is nothing but term data. With the term data(enrollmentSessionBid) we can get particular test result information. These enrollment session time spans are defined at a District level and vary from District to District. Schools are associated with a selected term. If you choose a different term, the list of available schools may change.
| Academic Year | The Partner defined period of time for their academic year. Academic Years usually begin in the Fall and end in the Summer. |
| Enrollment Session | A period of time that is a subset of an Academic Year. An Academic Year usually has 4 Enrollment Sessions, broken up by seasons. |
All endpoint requests referenced below are required 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
Example cURL command and response:
curl --location --request GET 'https://api.nwea.org/enrollments/v1/academic-years?perspective-bid={{perspective-bid}}&school-bid={{school-bid}}' \
--header 'apikey: SAOPGBqDqz9WM5wzlXOiek2fxn0IbmIg' \
--header 'Authorization: Bearer be8lY8VTJmd2lFS1Zt83jncwWrrG'
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 |
Response
{
"academicYears": [
{
"academicYearBid": "6e9ce5de-073c-4462-847b-772c09bac23a",
"perspectiveBid": "977c9f9f-c378-4ae8-b0ce-4516deb831e5",
"schoolBid": "a897459f-72b2-41b5-8bb6-43bacc309ac1",
"endDate": "2021-08-31",
"beginDate": "2020-09-01",
"description": "2020-2021",
"enrollmentSessions": [
{
"beginDate": "2021-08-31",
"description": "Summer 2020-2021",
"endDate": "2021-08-31",
"enrollmentSessionBid": "0e7e1298-3453-4868-be1d-4ec84f3d0e9a"
},
{
"beginDate": "2020-09-01",
"description": "Fall 2020-2021",
"endDate": "2020-11-30",
"enrollmentSessionBid": "40ddb54b-1672-4510-9849-833bad94fab2"
},
{
"beginDate": "2020-12-01",
"description": "Winter 2020-2021",
"endDate": "2021-02-28",
"enrollmentSessionBid": "c6e04bce-19e4-4c19-859d-f676e25d7dbf"
},
{
"beginDate": "2021-03-01",
"description": "Spring 2020-2021",
"endDate": "2021-08-30",
"enrollmentSessionBid": "cda69a69-7b7f-487f-a684-3ce8c07b556b"
}
],
"modifiedDateTime": "2020-07-07T13:23:04.646Z"
}
],
"pagination": {
"hasNextPage": false
}
}
BULK TEST RESULT
curl --location --request GET 'https://api.nwea.org/test-results/v1/growth?school-bid={{school-bid}}' \
--header 'apiKey: SAOPGBqDqz9WM5wzlXOiek2fxn0IbmIg' \
--header 'Authorization: Bearer be8lY8VTJmd2lFS1Zt83jncwWrrG'
{
"testResults": [
{
"testResultBid": "46b5ed24-2611-11eb-8e0a-00505693f64a",
"studentBid": "0fae38fe-0ae3-4532-a020-be1488568959",
"schoolBid": "a897459f-72b2-41b5-8bb6-43bacc309ac1",
"termBid": "c6e04bce-19e4-4c19-859d-f676e25d7dbf",
"subjectArea": "Reading",
"grade": "8",
"testName": "Demo Growth: Reading 6+",
"testKey": "MAP2-3108",
"testType": "S/G",
"growthEventYn": true,
"duration": 3600000,
"status": "COMPLETED",
"rit": 225,
"standardError": 3.7,
"ritScoreHigh": 229,
"ritScoreLow": 221,
"items": {
"shown": 20,
"correct": 17,
"total": 20
},
"lexile": {
"score": "1170L",
"min": "1070L",
"max": "1220L",
"range": "1070L-1220L"
},
"responseDisengagedPercentage": 0.0,
"impactOfDisengagement": 0.0,
"administrationStartDateTime": "2020-12-05T00:00:00Z",
"administrationEndDateTime": "2020-12-05T17:00:00Z",
"norms": [
{
"percentile": 61,
"reference": "2020",
"type": "achievement"
}
],
"modifiedDateTime": "2020-11-19T00:35:02.158Z",
"instructionalAreas": [
{
"instructionalAreaBid": "106893",
"instructionalAreaName": "Informational Text",
"score": 235.0,
"standardError": 4.6,
"scoreLow": 230.4,
"scoreHigh": 239.6
},
{
"instructionalAreaBid": "106894",
"instructionalAreaName": "Vocabulary Acquisition and Use",
"score": 232.0,
"standardError": 4.4,
"scoreLow": 227.6,
"scoreHigh": 236.4
},
{
"instructionalAreaBid": "106892",
"instructionalAreaName": "Literature",
"score": 222.0,
"standardError": 4.3,
"scoreLow": 217.7,
"scoreHigh": 226.3
}
]
}
],
"pagination": {
"hasNextPage": true,
"nextPage": "46b5030a-2611-11eb-8e0a-00505693f64a"
}
}
what to know more on enrollment api