Contents

Read a location

Returns a specific location in an Apple School Manager organization.

URL

GET https://api-school.apple.com/rosterapi/v1/locations/{locationId}

Path Parameters

NameTypeDescription
locationId Requiredstring

The identifier from the class. Use the id field from the Location object.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
Location

The request was successful.

401Unauthorized

The access token was invalid.

403Forbidden

You don’t have permission to access the requested location.

404Not Found

The server didn’t find a location with the given locationId in the organization.

429

The client made too many requests. The response includes an X-Retry-After header that indicates the number of seconds to wait before making another request.

500Internal Server Error

The server encountered an internal error.

Discussion

Access to the locations resource requires authorization to either the edu.users.read or edu.classes.read scope.

Example

See Also

Information about locations