Alexa Education Skill Component Reference

This topic describes objects that Alexa.Education requests and responses can contain.

StudentProfile

The StudentProfile object contains the following fields.

Field Description Type Required

id

Unique identifier for the student.

string

Yes

name

Student name details.

StudentName object

Yes

accountRelationType

How the linked account is related to the student profile. Possible values:

  • SELF: The student is the linked account owner.
  • GUARDIAN: The linked account that is associated with the student profile is that of a guardian or parent.

string enum

Yes

StudentName

The StudentName object contains the following fields.

Field Description Type Required

given

Given name of the student. Alexa uses this field in utterances.

string

Yes

full

Full name of the student.

string

No

family

Family name of the student.

string

No

nicknames

Nicknames for the student. Nicknames are typically configured by the student.

Array of string

No

Course

The Course object contains the following fields.

Field Description Type Required

id

Unique identifier for the course.

string

Yes

name

Name of the course.

string

Yes

aliases

List of nicknames, configured by the student or provider, for the course.

array of string

No

description

Description of the course.

string

No

startTime

Date-time that the course starts.

Date-time in the RFC 3339 variant of ISO 8601.

No

endTime

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

id

Unique identifier for the coursework.

string

Yes

description

Description of the coursework.

string

No

title

Title of the coursework.

string

Yes

courseId

Unique identifier for the course that the coursework relates to.

string

Yes

courseName

Name of the course that the coursework relates to.

string

Yes

type

Type of coursework. Possible values:

  • ASSIGNMENT
  • ASSESSMENT

string enum

Yes

submissionState

Submission state for the coursework. Possible values:

  • NOT_SUBMITTED
  • SUBMITTED
  • COLLECTED
  • GRADED
  • LATE
  • MISSING

string enum

No

dueTime

Time that the coursework submission is due.

Date-time in the RFC 3339 variant of ISO 8601.

Yes

publishedTime

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

courseId

Unique identifier for the course.

string

Yes

courseName

Name of the course that the grade relates to.

string

Yes

studentId

Unique identifier for the student.

string

Yes

grade

Current or final grade for the course.

Grade object

Yes

lastGradedTime

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

courseworkId

Unique identifier for the coursework.

string

Yes

courseId

Unique identifier for the course that the coursework relates to.

string

Yes

courseName

Name of the course that the coursework relates to.

string

Yes

courseworkType

Type of coursework. Possible values:

  • ASSIGNMENT
  • ASSESSMENT

string enum

Yes

studentId

Unique identifier for the student.

string

Yes

courseworkTitle

Title of the coursework.

string

Yes

grade

Grade for the coursework.

Grade object

Yes

lastGradedTime

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

overallGrade

Overall grade for the course or coursework.

OverallGrade object

This field or standardGrades must be present.

standardGrades

A list of Standards-Based Grades (SBG) for the course or coursework.

Array of StandardGrade objects

This field or overallGrade must be present.

OverallGrade

The OverallGrade object contains the following fields.

Field Description Type Required

gradeScore

The grade. Based on the grade type, the score can have different fields. Possible values:

  • POINTS
  • PERCENTAGE
  • LETTER
  • RUBRIC
  • GPA
  • PASS_FAIL

GradeScore object

Yes

StandardGrade

The StandardGrade object contains the following fields.

Field Description Type Required

name

Full standard name for the grade.

string

Yes

gradeScore

The grade. Based on the grade type, the score can have different fields. Possible values:

  • POINTS
  • PERCENTAGE
  • LETTER
  • RUBRIC
  • GPA
  • PASS_FAIL

GradeScore object

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

type

The type of grade. Set to POINTS.

string enum

Yes

score

Scored points.

number (float)

Yes

maxPoints

Maximum possible points.

number

Yes

PERCENTAGE

The PERCENTAGE grade type has the following fields.

Field Description Type Required

type

The type of grade. Set to PERCENTAGE.

string enum

Yes

score

Scored percentage, which typically ranges from 0 to 100.

number

Yes

LETTER

The LETTER grade type has the following fields.

Field Description Type Required

type

The type of grade. Set to LETTER.

string enum

Yes

score

Scored letter grade. This can be a single letter grade with plusses or minuses. Examples: "A", "B+", and "C-".

string

Yes

RUBRIC

The RUBRIC grade type has the following fields.

Field Description Type Required

type

The type of grade. Set to RUBRIC.

string enum

Yes

score

A free-form string that contains a grade. Examples: "Excellent", "Satisfactory", "Needs Improvement" and "Unsatisfactory".

string

Yes

GPA

The GPA grade type has the following fields.

Field Description Type Required

type

The type of grade. Set to GPA.

string enum

Yes

score

Scored grade point average (GPA).

number (float)

Yes

gpaScale

Measured GPA scale. Examples: 4.0 and 10.0.

number (float)

Yes

PASS_FAIL

The PASS_FAIL grade type has the following fields.

Field Description Type Required

type

The type of grade. Set to PASS_FAIL.

string enum

Yes

score

A pass or fail score. Possible values:

  • PASS
  • FAIL

string enum

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

id

Unique identifier for the school communication.

string

Yes

type

Communication type. Possible values:

  • BEHAVIORAL_UPDATE
  • COURSE_DISCUSSION
  • GENERIC_FROM
  • GENERIC_FOR
  • PRIVATE_MESSAGE
  • REMINDER

string enum

Yes

content

Content of the update.

Content object

Yes

publishedTime

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

author

Name of the sender.

string

Yes

studentName

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.

string

Yes

studentId

Unique identifier for the student.

string

Yes

The COURSE_DISCUSSION communication type has the following additional fields.

Field Description Type Required

author

Name of the sender.

string

Yes

courseName

Name of the course.

string

Yes

The GENERIC_FROM communication type has the following additional fields.

Field Description Type Required

kind

The kind of update. Possible values:

  • ANNOUNCEMENT
  • POST
  • GROUP_POST
  • SCHOOL_POST
  • DISTRICT_POST
  • DISCUSSION_GROUP
  • NOTICE
  • ALERT
  • UPDATE

string (enum)

Yes

from

Name of the "from" target.

string

Yes

The GENERIC_FOR communication type has the following additional fields.

Field Description Type Required

kind

The kind of update. Possible values:

  • ANNOUNCEMENT
  • POST
  • GROUP_POST
  • SCHOOL_POST
  • DISTRICT_POST
  • DISCUSSION_GROUP
  • NOTICE
  • ALERT
  • UPDATE

string (enum)

Yes

for

Name of the "for" target.

string

Yes

The PRIVATE_MESSAGE communication type has the following additional fields.

Field Description Type Required

author

Name of the sender.

string

Yes

The REMINDER communication type has the following additional fields.

Field Description Type Required

author

Name of the sender.

string

Yes

remindTime

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

type

Content type. Possible values:

  • PLAIN_TEXT

string (enum)

Yes

The PLAIN_TEXT content type has the following additional fields.

Field Description Type Required

text

School communication text for Alexa to speak.

string

Yes

PaginationContext object for requests

The PaginationContext object for requests contains the following fields.

Field Description Type Required

maxResults

Maximum number of results to return in the response body. Must be greater than zero.

number (integer)

Yes

nextToken

Token to retrieve a specific page of the paginated results. If this token is not present, return the first page of results.

string

No

PaginationContext object for responses

The PaginationContext object for responses contains the following fields.

Field Description Type Required

totalCount

Total number of records that match the request query.

number (integer)

No

nextToken

A token to retrieve additional results. If not present, then there are no more results.

string

No