Alexa Education Skill Component Reference
This topic describes objects that Alexa.Education
requests and responses can contain.
- StudentProfile
- StudentName
- Course
- Coursework
- CourseGrade
- CourseworkGrade
- Grade
- OverallGrade
- StandardGrade
- GradeScore
- SchoolCommunication
- Content
- PaginationContext object for requests
- PaginationContext object for responses
- Related topics
StudentProfile
The StudentProfile
object contains the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
Unique identifier for the student. |
|
Yes |
|
Student name details. |
|
Yes |
|
How the linked account is related to the student profile. Possible values:
|
|
Yes |
StudentName
The StudentName
object contains the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
Given name of the student. Alexa uses this field in utterances. |
|
Yes |
|
Full name of the student. |
|
No |
|
Family name of the student. |
|
No |
|
Nicknames for the student. Nicknames are typically configured by the student. |
Array of |
No |
Course
The Course
object contains the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
Unique identifier for the course. |
|
Yes |
|
Name of the course. |
|
Yes |
|
List of nicknames, configured by the student or provider, for the course. |
array of |
No |
|
Description of the course. |
|
No |
|
Date-time that the course starts. |
Date-time in the RFC 3339 variant of ISO 8601. |
No |
|
Date-time that the course ends. |
Date-time in the RFC 3339 variant of ISO 8601. |
No |
Coursework
The Coursework
object contains the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
Unique identifier for the coursework. |
|
Yes |
|
Description of the coursework. |
|
No |
|
Title of the coursework. |
|
Yes |
|
Unique identifier for the course that the coursework relates to. |
|
Yes |
|
Name of the course that the coursework relates to. |
|
Yes |
|
Type of coursework. Possible values:
|
|
Yes |
|
Submission state for the coursework. Possible values:
|
|
No |
|
Time that the coursework submission is due. |
Date-time in the RFC 3339 variant of ISO 8601. |
Yes |
|
Time that the coursework was published. |
Date-time in the RFC 3339 variant of ISO 8601. |
No |
CourseGrade
The CourseGrade
object contains the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
Unique identifier for the course. |
|
Yes |
|
Name of the course that the grade relates to. |
|
Yes |
|
Unique identifier for the student. |
|
Yes |
|
Current or final grade for the course. |
|
Yes |
|
Last time that the grade was updated. |
Date-time in the RFC 3339 variant of ISO 8601. |
Yes |
CourseworkGrade
The CourseworkGrade
object contains the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
Unique identifier for the coursework. |
|
Yes |
|
Unique identifier for the course that the coursework relates to. |
|
Yes |
|
Name of the course that the coursework relates to. |
|
Yes |
|
Type of coursework. Possible values:
|
|
Yes |
|
Unique identifier for the student. |
|
Yes |
|
Title of the coursework. |
|
Yes |
|
Grade for the coursework. |
|
Yes |
|
Last time that the grade was updated. |
Date-time in the RFC 3339 variant of ISO 8601. |
Yes |
Grade
The Grade
object contains the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
Overall grade for the course or coursework. |
|
This field or |
|
A list of Standards-Based Grades (SBG) for the course or coursework. |
Array of |
This field or |
OverallGrade
The OverallGrade
object contains the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
The grade. Based on the grade type, the score can have different fields. Possible values:
|
|
Yes |
StandardGrade
The StandardGrade
object contains the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
Full standard name for the grade. |
|
Yes |
|
The grade. Based on the grade type, the score can have different fields. Possible values:
|
|
Yes |
GradeScore
The fields that the GradeScore
object contains depends on the grade type.
POINTS
The POINTS
grade type has the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
The type of grade. Set to |
|
Yes |
|
Scored points. |
|
Yes |
|
Maximum possible points. |
|
Yes |
PERCENTAGE
The PERCENTAGE
grade type has the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
The type of grade. Set to |
|
Yes |
|
Scored percentage, which typically ranges from 0 to 100. |
|
Yes |
LETTER
The LETTER
grade type has the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
The type of grade. Set to |
|
Yes |
|
Scored letter grade. This can be a single letter grade with plusses or minuses. Examples: "A", "B+", and "C-". |
|
Yes |
RUBRIC
The RUBRIC
grade type has the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
The type of grade. Set to |
|
Yes |
|
A free-form string that contains a grade. Examples: "Excellent", "Satisfactory", "Needs Improvement" and "Unsatisfactory". |
|
Yes |
GPA
The GPA
grade type has the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
The type of grade. Set to |
|
Yes |
|
Scored grade point average (GPA). |
|
Yes |
|
Measured GPA scale. Examples: 4.0 and 10.0. |
|
Yes |
PASS_FAIL
The PASS_FAIL
grade type has the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
The type of grade. Set to |
|
Yes |
|
A pass or fail score. Possible values:
|
|
Yes |
SchoolCommunication
The SchoolCommunication
object contains the following common fields. Additional fields depend on the communication type, as shown in subsequent tables.
Field | Description | Type | Required |
---|---|---|---|
|
Unique identifier for the school communication. |
|
Yes |
|
Communication type. Possible values:
|
|
Yes |
|
Content of the update. |
|
Yes |
|
The time the update was published. |
Date-time in the RFC 3339 variant of ISO 8601. |
Yes |
The BEHAVIORAL_UPDATE
communication type has the following additional fields.
Field | Description | Type | Required |
---|---|---|---|
|
Name of the sender. |
|
Yes |
|
Name of the student to use in the response prompt. We recommend that you provide only the first or given name instead of the full name. |
|
Yes |
|
Unique identifier for the student. |
|
Yes |
The COURSE_DISCUSSION
communication type has the following additional fields.
Field | Description | Type | Required |
---|---|---|---|
|
Name of the sender. |
|
Yes |
|
Name of the course. |
|
Yes |
The GENERIC_FROM
communication type has the following additional fields.
Field | Description | Type | Required |
---|---|---|---|
|
The kind of update. Possible values:
|
|
Yes |
|
Name of the "from" target. |
|
Yes |
The GENERIC_FOR
communication type has the following additional fields.
Field | Description | Type | Required |
---|---|---|---|
|
The kind of update. Possible values:
|
|
Yes |
|
Name of the "for" target. |
|
Yes |
The PRIVATE_MESSAGE
communication type has the following additional fields.
Field | Description | Type | Required |
---|---|---|---|
|
Name of the sender. |
|
Yes |
The REMINDER
communication type has the following additional fields.
Field | Description | Type | Required |
---|---|---|---|
|
Name of the sender. |
|
Yes |
|
Date-time for the reminder. |
Date-time in the RFC 3339 variant of ISO 8601. |
Yes |
Content
The Content
object contains the following common fields. Additional fields depend on the content type, as shown in subsequent tables.
Field | Description | Type | Required |
---|---|---|---|
|
Content type. Possible values:
|
|
Yes |
The PLAIN_TEXT
content type has the following additional fields.
Field | Description | Type | Required |
---|---|---|---|
|
School communication text for Alexa to speak. |
|
Yes |
PaginationContext object for requests
The PaginationContext
object for requests contains the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
Maximum number of results to return in the response body. Must be greater than zero. |
|
Yes |
|
Token to retrieve a specific page of the paginated results. If this token is not present, return the first page of results. |
|
No |
PaginationContext object for responses
The PaginationContext
object for responses contains the following fields.
Field | Description | Type | Required |
---|---|---|---|
|
Total number of records that match the request query. |
|
No |
|
A token to retrieve additional results. If not present, then there are no more results. |
|
No |