Get the status of an educationSynchronizationProfile (deprecated)
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Caution
The Education Synchronization Profile API is deprecated and will stop returning data on December 31, 2024. For information about how to migrate to the new Industry Data API, see Transition from School Data Sync (Classic).
Get the status of a specific school data synchronization profile in the tenant. The response will indicate the status of the sync.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | EduAdministration.Read | EduAdministration.ReadWrite |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | EduAdministration.Read.All | EduAdministration.ReadWrite.All |
HTTP request
GET /education/synchronizationProfiles/{id}/profileStatus
Request headers
Name | Type | Description |
---|---|---|
Authorization | string | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and an educationsynchronizationprofilestatus object in the response body.
Example
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/education/synchronizationProfiles/{id}/profileStatus
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#education/synchronizationProfiles/{id}/profileStatus/$entity",
"id": "86904b1e-c7d0-4ead-b13a-98f11fc400ee",
"status": "inProgress",
"lastSynchronizationDateTime": "2021-07-13T20:55:17.6475128Z",
"lastActivityDateTime": "2021-07-13T20:55:17.6475128Z",
"errorCount": 0,
"statusMessage": "Processed 0 in the last hour.\r\nUpdated 0 in the last hour."
}