educationSynchronizationCustomizations resource type (deprecated)

  • Article

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).

Contains the list of entities to sync and their customizations, if any.

Note

Customization of properties to sync does not apply to the Student Enrollments or Teacher Rosters.

This resource is member of the following data providers:

Properties

Property Type Description
school educationSynchronizationCustomization Customizations for School entities.
section educationSynchronizationCustomization Customizations for Section entities.
student educationSynchronizationCustomization Customizations for Student entities.
teacher educationSynchronizationCustomization Customizations for Teacher entities.
studentEnrollment educationSynchronizationCustomization Customizations for Student Enrollments.
teacherRoster educationSynchronizationCustomization Customizations for Teacher Rosters.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "school": {
    "@odata.type": "microsoft.graph.educationSynchronizationCustomization",
    "optionalPropertiesToSync": ["String"],
    "isSyncDeferred": "Boolean",
    "allowDisplayNameUpdate": "Boolean"
  },
  "section": {
    "@odata.type": "microsoft.graph.educationSynchronizationCustomization",
    "optionalPropertiesToSync": ["String"],
    "isSyncDeferred": "Boolean",
    "allowDisplayNameUpdate": "Boolean"
  },
  "student": {
    "@odata.type": "microsoft.graph.educationSynchronizationCustomization",
    "optionalPropertiesToSync": ["String"],
    "isSyncDeferred": "Boolean",
    "allowDisplayNameUpdate": "Boolean"
  },
  "teacher": {
    "@odata.type": "microsoft.graph.educationSynchronizationCustomization",
    "optionalPropertiesToSync": ["String"],
    "isSyncDeferred": "Boolean",
    "allowDisplayNameUpdate": "Boolean"
  },
  "studentEnrollment": {
    "@odata.type": "microsoft.graph.educationSynchronizationCustomization",
    "synchronizationStartDate": "DateTimeOffset",
    "isSyncDeferred": "Boolean",
    "allowDisplayNameUpdate": "Boolean"
  },
  "teacherRoster": {
    "@odata.type": "microsoft.graph.educationSynchronizationCustomization",
    "isSyncDeferred": "Boolean",
    "allowDisplayNameUpdate": "Boolean"
  }
}