REST Resource: invitations
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Ресурс: Приглашение
Приглашение присоединиться к курсу.
| JSON-представление |
|---|
{
"id": string,
"userId": string,
"courseId": string,
"role": enum (CourseRole)
} |
| Поля |
|---|
id | string Идентификатор, назначенный Классом. Только для чтения. |
userId | string Идентификатор приглашенного пользователя. Если этот идентификатор указан в качестве параметра запроса, ему может быть присвоено одно из следующих значений: - числовой идентификатор пользователя
- адрес электронной почты пользователя
- строковый литерал
"me" , указывающий запрашивающего пользователя
|
courseId | string Идентификатор курса, на который можно пригласить пользователя. |
role | enum ( CourseRole ) Роль, которую можно пригласить пользователя. Не должно быть COURSE_ROLE_UNSPECIFIED . |
КурсРоль
Возможные роли, на которые может быть приглашен пользователь.
| Перечисления |
|---|
COURSE_ROLE_UNSPECIFIED | Никакой конечной роли. |
STUDENT | Студентка на курсе. |
TEACHER | Преподаватель курса. |
OWNER | Владелец курса. |
Методы |
|---|
| Принимает приглашение, удаляя его и добавляя приглашенного пользователя в число преподавателей или студентов (в зависимости от обстоятельств) указанного курса. |
| Создает приглашение. |
| Удаляет приглашение. |
| Возвращает приглашение. |
| Возвращает список приглашений, которые запрашивающему пользователю разрешено просматривать, ограниченный теми, которые соответствуют запросу списка. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 2025-07-25 UTC."],[],[],null,["# REST Resource: invitations\n\n- [Resource: Invitation](#Invitation)\n - [JSON representation](#Invitation.SCHEMA_REPRESENTATION)\n- [CourseRole](#CourseRole)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Invitation\n--------------------\n\nAn invitation to join a course.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"userId\": string, \"courseId\": string, \"role\": enum (/workspace/classroom/reference/rest/v1/invitations#CourseRole) } ``` |\n\n| Fields ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier assigned by Classroom. Read-only. |\n| `userId` | `string` Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n| `courseId` | `string` Identifier of the course to invite the user to. |\n| `role` | `enum (`[CourseRole](/workspace/classroom/reference/rest/v1/invitations#CourseRole)`)` Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. |\n\nCourseRole\n----------\n\nPossible roles a user may be invite to have.\n\n| Enums ||\n|---------------------------|------------------------|\n| `COURSE_ROLE_UNSPECIFIED` | No course role. |\n| `STUDENT` | Student in the course. |\n| `TEACHER` | Teacher of the course. |\n| `OWNER` | Owner of the course. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| ### [accept](/workspace/classroom/reference/rest/v1/invitations/accept) | Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. |\n| ### [create](/workspace/classroom/reference/rest/v1/invitations/create) | Creates an invitation. |\n| ### [delete](/workspace/classroom/reference/rest/v1/invitations/delete) | Deletes an invitation. |\n| ### [get](/workspace/classroom/reference/rest/v1/invitations/get) | Returns an invitation. |\n| ### [list](/workspace/classroom/reference/rest/v1/invitations/list) | Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. |"]]
