Gathering Student Data

Introduction to Students

NWEA receives student roster data directly from schools and districts. All students rostered with MAP receive a unique identifier, studentBid. When integrating with or matching against student information systems, the studentId or districtStudentId will be more useful to you. Check out the below tips for retrieving student data.

All endpoint requests referenced below are require to have the following in the header 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)

Retrieving Students by District

Assuming the App has a desired districtBid available, the students for a district can be retrieved by making a GET call to the following endpoint:

https://api.nwea.org/organizations/v1/districts/{districtBid}/students

 

Example cURL command and response:

curl -X GET --header "grant_type: client_credentials" --header "apikey: xNM70DRInasXls8lc8vWViHE6bCYyAAw" --header "Authorization: Bearer CtAmOTflfA9t9aEnR2jFwv2nj8Pu" "https://api.nwea.org/organizations/v1/districts/fdcb5f6a-51c1-4368-82e6-d177da98791f/students"

HTTP/1.1 200 OK

Connection:
keep-alive
Content-Length:
162718
Content-Type:
application/json; charset=utf-8
Date:
Tue, 25 Jul 2017 23:18:11 GMT
ETag:
W/"27b9e-/KmfKKc68HNggNYYhOiPWLnWB3A"
Server:
Apigee Router
X-Powered-By:
Express
[
  {
    "studentId": "F08000002",
    "schoolBid": "deda443f-f59a-4822-bea5-e782521bbc49",
    "lastName": "Koolstra",
    "firstName": "Jeffrey"
  },
  {
    "studentId": "F08000003",
    "studentBid": "f1012908-3073-4323-beb8-a1a4db5c6f73",
    "lastName": "Cornick",
    "firstName": "Isaiah"
  }
...
]

 

Data limits

🛈 Note:  Maximum allowed size of response payload is 6 MB, if district have more data school API can be used to retrieve data.

Retrieving Students by School

Assuming the App has a desired schoolBid available, the list of students in a school can be retrieved by making a GET call to the following endpoint:

https://api.nwea.org/organizations/v1/schools/{schoolBid}/students

 

Example cURL command and response:

curl -X GET --header "grant_type: client_credentials" --header "apikey: xNM70DRInasXls8lc8vWViHE6bCYyAAw" --header "Authorization: Bearer CtAmOTflfA9t9aEnR2jFwv2nj8Pu" "https://api.nwea.org/organizations/v1/schools/deda443f-f59a-4822-bea5-e782521bbc49/students"

HTTP/1.1 200 OK

Connection:
keep-alive
Content-Length:
103913
Content-Type:
application/json; charset=utf-8
Date:
Tue, 25 Jul 2017 23:20:57 GMT
ETag:
W/"195e9-X0iTAbUlY0SUKWYnGdrjv1qgehE"
Server:
Apigee Router
X-Powered-By:
Express
[
  {
    "studentId": "F08000002",
    "studentBid": "3509a176-aa50-44ef-81fe-c714d9d67844",
    "lastName": "Koolstra",
    "firstName": "Jeffrey"
  },
  {
    "studentId": "F08000003",
    "studentBid": "f1012908-3073-4323-beb8-a1a4db5c6f73",
    "lastName": "Cornick",
    "firstName": "Isaiah"
  }
...
]

Retrieving a Student Directly

If the App only needs information for a specific student, this can be achieved by making a GET call to the following endpoint:

https://api.nwea.org/students/v2/{studentBid}

 

Example cURL command and response:

curl -X GET --header "grant_type: client_credentials" --header "apikey: xNM70DRInasXls8lc8vWViHE6bCYyAAw" --header "Authorization: Bearer CtAmOTflfA9t9aEnR2jFwv2nj8Pu" "https://api.nwea.org/students/v2/3509a176-aa50-44ef-81fe-c714d9d67844"

HTTP/1.1 200 OK

Connection:
keep-alive
Content-Length:
315
Content-Type:
application/json; charset=utf-8
Date:
Tue, 25 Jul 2017 23:21:48 GMT
ETag:
W/"13b-1UYLpJuSKmiI56kzQb60uLFCjjE"
Server:
Apigee Router
X-Powered-By:
Express
{
  "studentId": "F08000002",
  "studentBid": "3509a176-aa50-44ef-81fe-c714d9d67844",
  "districtBid": "fdcb5f6a-51c1-4368-82e6-d177da98791f",
  "schoolBid": "deda443f-f59a-4822-bea5-e782521bbc49",
  "lastName": "Koolstra",
  "firstName": "Jeffrey",
  "middleName": "R",
  "dateOfBirth": "11/29/2004",
  "ethnicity": "Hispanic or Latino",
  "gender": "M"
}

Up next: Pulling Student Test Results