Skip to navigation
API ReferenceBeacons

BatchCreateBeaconInstitutions

BatchCreateBeaconInstitutions adds institutions to a beacon by NCES id or Edulead id. An all-digit NCES id that lost its leading zeros still matches when only one id fits. Ids that match no institution come back in unmatched_ids and are not added; one already in the beacon is kept as it is.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Path parameters

beacon_idstringRequiredformat: "uuid"1-36 characters
The beacon.

Headers

Edulead-TeamstringRequired

Request

BatchCreateBeaconInstitutionsRequest names the institutions to add: ids are NCES ids or Edulead institution ids, in any case; blanks are skipped and repeats ignored.

idslist of stringsOptional

Identifiers of the resources the call names. A batch read leaves missing ones out of items; a batch write says in its description what it does with them.

Response

Success
itemslist of objectsOptional
The page of results, in the requested order.
unmatched_idslist of stringsOptional
The ids, as given, that match no institution.