Get Status
Fetch the status of an operation that you initiated earlier.
URL
GET https://classkit-catalog.apple.com/v1/status/{statusId}Path Parameters
| Name | Type | Description |
|---|---|---|
statusId Required | string | The identifier of the operation for which you want to retrieve the status. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | Status | The request succeeded. |
| 400 | Bad Request | The request contained an error. | |
| 403 | Forbidden | The request wasn’t authorized. |
Discussion
If the system can’t immediately complete a request, the ClassKit Catalog API may acknowledge that it received the request and respond with a HTTP response containing the status code 202 ACCEPTED. In this case, the response contains a header with the name “Location”. The corresponding value is a URL that points to the Get Status endpoint, including a statusId as the last path parameter. The header item might look like this:
Location: classkit-catalog.apple.com/v1/status/KGW7S5VLDDOQSYSE7DKGYBGXUUUse this statusID to ask the server for a status update at a later time.