Alexa.Education.Coursework Interface

Implement the Alexa.Education.Coursework interface in your Alexa education skill to provide a list of coursework for a given student or course. For more information about education skills, see About Alexa Education Skills.

For the list of languages that the Coursework interface supports, see List of Alexa Interfaces and Supported Languages.

• Utterances
• Integration with Alexa reminders
• Request
• Response
• Related topics

Utterances

When you use the Alexa.Education.Coursework interface, the voice interaction model is already built for you. The following examples show some user utterances:

• English (All)

Integration with Alexa reminders

The Coursework interface integrates with Alexa reminders automatically. After you implement the Coursework interface in your skill, whenever you return an assignment with a due date to the user, Alexa automatically asks the user if they want to set a reminder for the assignment. For more information, see Integration with Alexa reminders.

If the user requests a reminder from Alexa, Alexa doesn't send information about the reminder back to your skill.

Request

The Get request queries a list of coursework for a given student or course. This request has query parameters to filter for studentId (required), dueTime (required), courseworkType (optional), and courseId (optional). The dueTime parameter indicates when the coursework is due. The courseId filter provides specific course-related coursework that is due for that student.

If there's more than one student associated with the account and the user doesn't specify the student, Alexa asks the user for clarification, and then includes the appropriate studentId in the request to your skill. In other words, your skill doesn't need to discern whether there's more than one student associated with the account, it just needs to return the results for the specified studentId.

The payload of the Get request contains the following fields.

The following is an example of a Get request.

{
  "request": {
    "header": {
      "namespace": "Alexa.Education.Coursework",
      "name": "Get",
      "messageId": "ExampleMessageID",
      "interfaceVersion": "1.0"
    },
    "authorization": {
      "type": "BearerToken",
      "token": "ExampleBearerToken"
    },
    "payload": {
      "paginationContext": {
        "maxResults": 5,
        "nextToken": "ExampleNextToken"
      },
      "query": {
        "matchAll": {
          "studentId": "1184",
          "courseId": "course_001",
          "courseworkType": "ASSIGNMENT",
          "dueTime": {
            "start": "2019-04-02T00:00:000Z",
            "end": "2019-04-05T00:00:000Z"
          }
        }
      },
      "locale": "en-US"
    }
  }
}

Requests to return coursework always have a dueTime filter in the query parameters. The response must include the coursework that has a dueTime within the start and end range (inclusive).

The following are example utterances that show how the dueTime filter of the request is based on the user's time zone.

"dueTime": {
  "start": "2019-10-17T07:00:00Z",
  "end": "2019-10-18T06:59:59Z"
}

"dueTime": {
  "start": "2019-10-17T04:00:00Z",
  "end": "2019-10-18T03:59:59Z"
}

"dueTime": {
  "start": "2019-10-18T07:00:00Z",
  "end": "2019-10-19T06:59:59Z"
}

"dueTime": {
  "start": "2019-10-18T04:00:00Z",
  "end": "2019-10-19T03:59:59Z"
}

"dueTime": {
  "start": "2019-10-17T07:00:00Z",
  "end": "2019-10-24T06:59:59Z"
}

"dueTime": {
  "start": "2019-10-17T04:00:00Z",
  "end": "2019-10-24T03:59:59Z"
}

Response

If you handle a Get request successfully, respond with a GetResponse object.

The payload of a GetResponse object contains the following fields.

The following is an example of GetResponse.

{
  "response": {
    "header": {
      "namespace": "Alexa.Education.Coursework",
      "name": "GetResponse",
      "messageId": "ExampleMessageID",
      "interfaceVersion": "1.0"
    },
    "payload": {
      "paginationContext": {
        "totalCount": 1
      },
      "coursework": [
        {
          "id": "coursework_001",
          "courseId": "course_001",
          "courseName": "UFO 101",
          "title": "Homework 1",
          "description": "Homework 1 is now available. It's due by the 30th of April.",
          "type": "ASSIGNMENT",
          "submissionState": "MISSING",
          "dueTime": "2019-04-12T00:00:00Z",
          "publishedTime": "2019-04-12T00:00:00Z"
        },
        {
          "id": "quiz_001",
          "courseId": "course_001",
          "courseName": "UFO 101",
          "title": "Quiz 1",
          "description": "",
          "type": "ASSESSMENT",
          "submissionState": "NOT_SUBMITTED",
          "dueTime": "2019-04-12T00:00:00Z",
          "publishedTime": "2019-04-12T00:00:00Z"
        }
      ]
    }
  }
}

Related topics

• About Alexa Education Skills
• Alexa Education Skill Component Reference
• Paginating Query Results in Alexa Education Skills