Skip to navigation
API ReferenceBeacons

BatchDeleteBeaconInstitutions

BatchDeleteBeaconInstitutions removes institutions from a beacon, named as for BatchCreateBeaconInstitutions. Ids that name no institution of the beacon come back in unmatched_ids.

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

BatchDeleteBeaconInstitutionsRequest names the institutions to remove, by NCES id or Edulead id as for BatchCreateBeaconInstitutions.
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
unmatched_idslist of stringsOptional
The ids, as given, that name no institution of the beacon.