This API can be used to get/set mappings of student and school identifiers between external systems and NWEA business identifiers (Bids)
STUDENT EXTERNAL ID MAPPING
This endpoint returns the mappings for NWEA student business identifiers to another roster provider’s student identifier.
Example cURL command and response:
curl --location --request GET 'https://api.nwea.org/external-id-mappings/v1/students?perspective-bid={{perspective-bid}}' \
--header 'apikey: SAOPGBqDqz9WM5wzlXOiek2fxn0IbmIg' \
--header 'Authorization: Bearer BPDr1wxtzjEAP7xExsxdCJxP3AMT'
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 |
| type | The external ID type to lookup | Optional |
|
external-id
|
The external identifier of the student you wish to retrieve. If provided, type needs to also be provided | Optional |
|
modified-since
|
Will filter the results to student external id mappings 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 mapping data that once existed but has since been removed will be included in the response. | 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
{
"externalIdMappings": [
{
"studentBid": "796e27bc-98fc-4fca-ae7a-fc5283123112",
"perspectiveBid": "977c9f9f-c378-4ae8-b0ce-4516deb831e5",
"externalId": "ST027.4",
"modifiedDateTime": "2021-02-01T23:48:00.726Z",
"type": "district-id"
}
],
"pagination": {
"hasNextPage": true,
"nextPage": "YTQ4OWU4N2YxZmFkNTAwNjowOTZiZmY5M2Q2YjAyN2FkOGQ4NmZTkyNGQ="
}
}
SCHOOL EXTERNAL ID MAPPING
This endpoint returns the mappings for NWEA school business identifiers to another roster provider’s school identifier.
Example cURL command and response:
curl --location --request GET 'https://api.nwea.org/external-id-mappings/v1/schools?perspective-bid=977c9f9f-c378-4ae8-b0ce-4516deb831e5' \
--header 'apikey: SAOPGBqDqz9WM5wzlXOiek2fxn0IbmIg' \
--header 'Authorization: Bearer lMYQEcaEtEJr5lLJmcksOGjLCS4D'
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 |
| type | The external ID type to lookup | Optional |
| external-id | The external identifier of the student you wish to retrieve. If provided, type needs to also be provided | Optional |
| modified-since | Will filter the results to student external id mappings 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 mapping data that once existed but has since been removed will be included in the response. | 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
{
"externalIdMappings": [
{
"perspectiveBid": "977c9f9f-c378-4ae8-b0ce-4516deb831e5",
"externalId": "5f28870f4f261019c0789986",
"schoolBid": "a98d4bd5-4446-42e2-9125-61b06c5f7ad2",
"modifiedDateTime": "2020-08-08T02:28:36.427Z",
"type": "clever"
},
],
"pagination": {
"hasNextPage": false
}
}