Retrieving students that are currently enrolled at the school
To retrieve students who are currently enrolled concerning school and district, we need to use the below API.
Example cURL command and response:
Must provide one of [perspectiveBid, schoolBid] [perspectiveBid, studentBid] [perspectiveBid, districtStudentId]
[perspectiveBid, stateStudentId] [perspectiveBid, studentSchoolAssociationBid] [perspectiveBid, nextPage]
/enrollments/v1/student-school-associations?perspective-bid={districtBid}&school-bid={schoolBid}
curl --location --request GET 'https://api.nwea.org/enrollments/v1/student-school-associations?perspective-bid={{perspective-bid}}&school-bid={{school-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 |
Response
{
"studentSchoolAssociations": [
{
"grade": "8",
"studentSchoolAssociationBid": "9e1115d5-ab6b-5694-a601-baf05b3d2075",
"endDate": "2021-02-28",
"lastName": "Clark",
"modifiedDateTime": "2020-10-06T22:22:42.101Z",
"firstName": "Brittney",
"districtStudentId": "SF07002376",
"perspectiveBid": "977c9f9f-c378-4ae8-b0ce-4516deb831e5",
"schoolBid": "a897459f-72b2-41b5-8bb6-43bacc309ac1",
"beginDate": "2020-12-01",
"studentBid": "1c2cbb3f-6720-4c96-bb73-0b0908332a69",
"dateOfBirth": "2004-11-08",
"middleName": "N"
}
],
"pagination": {
"hasNextPage": false
}
}