Alexa.Education.Profile.Student Interface
Implement the Alexa.Education.Profile.Student interface in your Alexa education skill to provide a list of student profiles that are associated with the linked user account. All education skills must support this interface.
The student profiles returned must contain the name and a unique identifier for each student profile. You can use the identifier to query for grades, assignments or announcements when you use the other Alexa.Education interfaces.
For the list of locales that are supported for the Profile.Student interface, see List of Capability Interfaces and Supported Locales.
Utterances
There are no utterances associated with this interface.
Request
The Get request queries a list of student profiles associated with the linked user account.
The payload of the Get request contains the following fields.
| Field | Description | Type |
|---|---|---|
|
|
Pagination information |
|
|
|
Locale that identifies the user's language |
|
The following is an example of a Get request.
{
"request": {
"header": {
"namespace": "Alexa.Education.Profile.Student",
"name": "Get",
"messageId": "ExampleMessageID",
"interfaceVersion": "1.0"
},
"authorization": {
"type": "BearerToken",
"token": "ExampleBearerToken"
},
"payload": {
"paginationContext": {
"maxResults": 5,
"nextToken": "ExampleNextToken"
},
"locale": "en-US"
}
}
}
Response
If you handle a Get request successfully, respond with a GetResponse object.
The payload of a GetResponse object contains the following fields.
| Field | Description | Type | Required |
|---|---|---|---|
|
|
Pagination information |
|
No |
|
|
The results of the query |
Array of |
Yes |
The following is an example of GetResponse.
{
"response": {
"header": {
"namespace": "Alexa.Education.Profile.Student",
"name": "GetResponse",
"messageId": "ExampleMessageID",
"interfaceVersion": "1.0"
},
"payload": {
"paginationContext": {
"totalCount": 2
},
"studentProfiles": [
{
"id": "student_001",
"accountRelationType": "GUARDIAN",
"name": {
"full": "John Doe",
"given": "John",
"family": "Doe",
"nicknames": [
"Johnny"
]
}
},
{
"id": "student_002",
"accountRelationType": "GUARDIAN",
"name": {
"full": "Jane Doe",
"given": "Jane",
"family": "Doe"
}
}
]
}
}
}
