添加课程参与方

POST

http://127.0.0.1/topapi/edu/course/participant/add

服务端API/新教育/在线课堂/排课

最后修改时间：2022-08-30 09:19:24

责任人：未设置

说明

调用本接口添加课程参与方。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考权限申请。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	是	开发者后台申请	调试
第三方个人应用	否	—	—

请求参数

Query 参数

access_token

string

必需

调用服务端接口的授权凭证。企业内部应用可通过调用access_token接口获得。第三方企业应用可通过调用get_corp_token接口获得。

示例值:

bE3xxxx

Body 参数application/json

op_userid

string

必需

当前操作者的userid。

participant_corpid

string

必需

参与方的组织cropid。必须和当前组织相同或者存在关联关系。

course_code

string

课程编码。

必需

participant_type

number

必需

参与方类型：1：用户，可添加的人数上限为1000。2：部门，可添加的部门数上限为100，对应家校通讯录中的班级、年级。详情请参考家校通讯录2.0。3：组织，可添加的组织数上限为5。

participant_id

string

必需

参与方ID：participant_type=1时，participant_id为用户的useridparticipant_type=2时，participant_id为部门IDparticipant_type=3时，participant_id为组织的corpid

role

string

必需

参与方角色：student：学生guardian: 监护人teacher：老师授课老师只支持通过课程创建和修改接口进行添加和修改。

示例

{
  "participant_type": 1,
  "role": "student",
  "course_code": "GJKI49001",
  "participant_corpid": "ding4220d8e5128d0edd",
  "participant_id": "user01",
  "op_userid": "manager1"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/topapi/edu/course/participant/add?access_token=bE3xxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "participant_type": 1,
    "role": "student",
    "course_code": "GJKI49001",
    "participant_corpid": "ding4220d8e5128d0edd",
    "participant_id": "user01",
    "op_userid": "manager1"
}'

返回响应

🟢200成功

application/json

Body

request_id

string

请求ID。

可选

result

boolean

添加是否成功。

可选

success

boolean

请求是否成功。

可选

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

示例

{
  "request_id": "string",
  "result": true,
  "success": true,
  "errcode": 0,
  "errmsg": "string"
}

修改于 2022-08-30 09:19:24

获取课程列表

获取课程参与方列表

添加课程参与方

说明#

权限#

请求参数

示例代码

返回响应

说明

权限