Get reflectCheckInResponse

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

Read the properties and relationships of a reflectCheckInResponse object. This method gets the responses to a Microsoft Reflect check-in.

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) Not supported. Not supported.
Delegated (personal Microsoft account) Not supported. Not supported.
Application EduReports-Reflect.Read.All EduReports-Reflect.ReadAnonymous.All

HTTP request

GET /education/reports/reflectCheckInResponses

Optional query parameters

This method supports the $top, $filter, $orderby, and $select OData query parameters to help customize the response. For general information, see OData query parameters.

The $filter and $orderby query parameters are supported for all properties.

Request headers

Name Description
Authorization 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 a reflectCheckInResponse object in the response body.

Examples

Example 1: Get the Reflect check-in responses from the last 24 hours

The following example shows how to get the Reflect check-in responses from the last 24 hours.

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/education/reports/reflectCheckInResponses

Response

The following example shows the default response that includes Reflect check-in responses from the last 24 hours.

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/reports/reflectCheckInResponses",
  "value": [
    {
      "creatorId": "0f1503b6-15fb-ea4a-ba6e-21b31e8a9b5c",
      "classId": "f2df94da-9a47-4c65-958c-8289ae30243b",
      "checkInId": "b8fc7306-068e-4380-93d4-ee72019a50fe",
      "checkInTitle": "How are you feeling today?",
      "isClosed": false,
      "createdDateTime": "2023-09-19T11:44:16.0821219Z",
      "responderId": "f2df94da-9a47-4c65-958c-8289ae30243b",
      "responseFeedback": "pleasant",
      "responseEmotion": "motivated",
      "submitDateTime": "2023-09-19T11:46:16.2813907Z"
    },
    {
      "creatorId": "0f1503b6-15fb-ea4a-ba6e-21b31e8a9b5c",
      "classId": null,
      "checkInId": "b8fc7306-068e-4380-93d4-ee72019a50fe",
      "checkInTitle": "How are you feeling today?",
      "isClosed": false,
      "createdDateTime": "2023-09-19T11:44:16.0821219Z",
      "responderId": "958c7306-9a47-15fb-958c-8289ae30243b",
      "responseFeedback": "unpleasant",
      "responseEmotion": "bored",
      "submitDateTime": "2023-09-19T11:55:16.2813907Z"
    }
  ]
}

Example 2: Get the Reflect check-in responses for a specific date using $filter

The following example shows how to get the Reflect check-in responses for a specific date using the $filter query parameter.

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/education/reports/reflectCheckInResponses?$filter=submitDateTime gt 2023-10-10T00:00:00.000Z

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/reports/reflectCheckInResponses",
  "value": [
    {
      "creatorId": "0f1503b6-15fb-ea4a-ba6e-21b31e8a9b5c",
      "classId": "f2df94da-9a47-4c65-958c-8289ae30243b",
      "checkInId": "b8fc7306-068e-4380-93d4-ee72019a50fe",
      "checkInTitle": "How are you feeling today?",
      "isClosed": false,
      "createdDateTime": "2023-10-19T11:44:16.0821219Z",
      "responderId": "f2df94da-9a47-4c65-958c-8289ae30243b",
      "responseFeedback": "pleasant",
      "responseEmotion": "motivated",
      "submitDateTime": "2023-10-19T11:46:16.2813907Z"
    },
    {
      "creatorId": "0f1503b6-15fb-ea4a-ba6e-21b31e8a9b5c",
      "classId": null,
      "checkInId": "b8fc7306-068e-4380-93d4-ee72019a50fe",
      "checkInTitle": "How are you feeling today?",
      "isClosed": false,
      "createdDateTime": "2023-10-19T11:44:16.0821219Z",
      "responderId": "958c7306-9a47-15fb-958c-8289ae30243b",
      "responseFeedback": "unpleasant",
      "responseEmotion": "bored",
      "submitDateTime": "2023-11-19T11:55:16.2813907Z"
    }
  ]
}