Skilljar API端点引用

此页面记录Skilljar平台支持的API端点。它是从我们的源代码自动生成的，因此在添加其他操作时保持最新。要了解Skilljar API并了解对象在课程平台中的结构，最好从以下文章开始：

域

收到 /v1/域

列出域。返回域的分页响应（每页100个结果）。响应示例：{“计数”：1，“下一个”：null，“上一个”：null，“结果”：[{“id”：“abcdefg123456”，“名称”：“Example.com”，“catalog\u title”：“

所有课程

，“访问”：“公共”，“访问代码\u消息”：“，”营销信息“：”}]}

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
收到 / v1 /域/ {domain_name}

获取域详细信息。示例响应：{“id”：“abcdefg123456”，“name”：“Example.com”，“catalog\u title”：“

所有课程

”，“private”：true，“access”：“PUBLIC”，“access\u code\u message\u html”：“marketing\u message”：“}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
放 / v1 /域/ {domain_name}

更新域细节。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
catalog_title 显示在目录页面顶部的HTML内容 一串
访问 域访问设置 枚举
access_code_message_html 一串
marketing_message 私有域营销选择加入消息，在注册页面上显示复选框 一串
补丁 / v1 /域/ {domain_name}

更新域细节。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
catalog_title 显示在目录页面顶部的HTML内容 一串
访问 域访问设置 枚举
access_code_message_html 一串
marketing_message 私有域营销选择加入消息，在注册页面上显示复选框 一串
收到 /v1/domains/{domain_name}/访问代码池

列出域的访问代码池。返回访问代码池的分页列表（每页100个结果）。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
名称 按名称筛选返回的访问代码池 一串
帖子 /v1/domains/{domain_name}/访问代码池

创建一个空的域访问码池。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
名称必修的 访问代码池的名称。这可能是在仪表板中创建单个代码时自动生成的。 一串
忙碌的 布尔值
开始日期 一串
end_date 一串
expire_linked_to_domain_membership 当此值为true并设置了end_date时，使用此池中的代码注册的用户将失去对end_date域的访问权。 布尔值
收到 / v1 /域/ {domain_name} / access-code-pools / {access_code_pool_id}

检索访问代码池详细信息。响应示例:{"id": "abcde1234"， "name": " Example -pool"， "active": true， "start_date": 2016-01-29T00:22:00.590250Z， "end_date": null， "expire_linked_to_domain_membership": false， "channel": "api"， "code_count": 1}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
访问\u代码\u池\u id必修的 一串
放 / v1 /域/ {domain_name} / access-code-pools / {access_code_pool_id}

更新访问码池。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
访问\u代码\u池\u id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
名称 访问代码池的名称。这可能是在仪表板中创建单个代码时自动生成的。 一串
忙碌的 布尔值
开始日期 一串
end_date 一串
expire_linked_to_domain_membership 当此值为true并设置了end_date时，使用此池中的代码注册的用户将失去对end_date域的访问权。 布尔值
补丁 / v1 /域/ {domain_name} / access-code-pools / {access_code_pool_id}

更新访问码池。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
访问\u代码\u池\u id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
名称 访问代码池的名称。这可能是在仪表板中创建单个代码时自动生成的。 一串
忙碌的 布尔值
开始日期 一串
end_date 一串
expire_linked_to_domain_membership 当此值为true并设置了end_date时，使用此池中的代码注册的用户将失去对end_date域的访问权。 布尔值
删除 / v1 /域/ {domain_name} / access-code-pools / {access_code_pool_id}

删除访问代码池。这将删除池中的所有访问代码。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
访问\u代码\u池\u id必修的 一串
收到 /v1/domains/{domain_name}/access code pool/{access_code_pool_id}/access code

列出池中的访问代码。返回访问代码的分页列表（每页1000个结果）。响应示例：{“count”：1，“next”：null，“previous”：null，“results”：[{“id”：“abcde12345”，“code”：“examplecode”，“active”：true，“max_uses”：3，“use_count”：2，“duration”：null，“duration_unit”：“MONTHS”}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
访问\u代码\u池\u id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
帖子 /v1/domains/{domain_name}/access code pool/{access_code_pool_id}/access code

向池中添加访问码。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
访问\u代码\u池\u id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
代码 一串
忙碌的 布尔值
max_uses 整数
持续时间 整数
duration_unit 枚举
收到 /v1/domains/{domain_name}/access代码池/{access_code_pool_id}/access code/{access_code_id}

检索访问代码细节。响应示例:{"code": "examplecode"， "active": true， "max_uses": 3， "use_count": 2， "duration": null， "duration_unit": "Months" "users": [{"id": "abcdef12345"， "email": "janedoe@example.com"， "first_name": "Jane"， "last_name": "Doe"}， {"id": "bcdeg23456"， "email": "jamesdoe@example.com"， "first_name": "James"， "last_name": "Doe"}，]}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
访问\u代码\u池\u id必修的 一串
访问\u代码\u id必修的 一串
放 /v1/domains/{domain_name}/access代码池/{access_code_pool_id}/access code/{access_code_id}

更新访问代码。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
访问\u代码\u池\u id必修的 一串
访问\u代码\u id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
代码 一串
忙碌的 布尔值
max_uses 整数
持续时间 整数
duration_unit 枚举
补丁 /v1/domains/{domain_name}/access代码池/{access_code_pool_id}/access code/{access_code_id}

更新访问代码。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
访问\u代码\u池\u id必修的 一串
访问\u代码\u id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
代码 一串
忙碌的 布尔值
max_uses 整数
持续时间 整数
duration_unit 枚举
删除 /v1/domains/{domain_name}/access代码池/{access_code_pool_id}/access code/{access_code_id}

删除访问代码。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
访问\u代码\u池\u id必修的 一串
访问\u代码\u id必修的 一串
收到 / v1 /域/ {domain_name} /课程系列

列出域上的课程系列。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
收到 /v1/domains/{domain\u name}/course series/{course\u series\u id}

检索课程系列详细信息。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
course_series_id必修的 一串
收到 / v1 /域/ {domain_name} /课程系列/ {course_series_id} / published-courses

列出系列课程中已发表的课程

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
course_series_id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
收到 /v1/domains/{domain_name}/已发布课程

列出发布到某个领域的课程。返回已发表课程的分页列表(每页100个结果)。响应示例:{"count": 1， "next": null， "previous": null， "results": [{"id": "abcdefg123456"， "course": {"id": "cdefghi345678"， "title": "Example title"}， "slug": "Example -course"， "course_url": "http://learn.example.com/example-course"， "hidden": false， "registration_required": true， "registration_starts_at":"2017-11-28T08:00:00Z"， "registration_ends_at": "2018-09-30T06:00:00Z"， "timezone": "US/Pacific"， "offer": {"id": "bcdefgh234567"， "registration_open": true， "registration_url": "http://learn.example.com/checkout/bcdefgh234567"， "price": {"amount": "100.00"， "currency_code": "USD"}}}]}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
include_searchable_content 如果设置为True，响应还包括以下字段('lesson_list'， 'tags'， 'short_description'， 'long_description_html'， 'search_keywords') 一串
搜索 URL编码的字符串，返回结果和顺序，就像目录搜索一样 一串
收到 / v1 /域/ {domain_name} / published-courses / {published_course_id}

检索过程的细节。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
published_course_id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
include_searchable_content 如果设置为True，响应还包括以下字段('lesson_list'， 'tags'， 'short_description'， 'long_description_html'， 'search_keywords') 一串
收到 /v1/domains/{domain_name}/已发布课程/{published_course_id}/注册

列出已发表课程的注册人数。一个用户可以有多个注册，如果至少有一个注册是活跃的并且没有过期，那么他就可以访问课程。如果注册是与购买关联创建的，或者是通过课程平台UI注册的，那么购买细节将包含在响应中。返回注册的分页列表(每页1000个结果)。示例响应:{“计数”:1、“下一个”:空,“之前”:空,“结果”:[{" id ":“abcdefg123456”,“用户”:{" id ":“bcdefga123456”、“电子邮件”:“jane@doe.com”、“first_name”:“简”、“last_name”:“母鹿”,},“enrolled_at”:“2015 - 01 - 29 t00:22:00.590250z”、“expires_at”:空,“活动”:真的,"购买":{“order_id”:“”,“offer_price”:{“金额”:"100.00"， "currency_code": "USD"}， "purchase_price": {"amount": "50.00"， "currency_code": "USD"}， "quantity": 1， "purchase_state": "SUCCESS"， "payment_processor": "STRIPE"}}]}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
published_course_id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
帖子 /v1/domains/{domain_name}/已发布课程/{published_course_id}/注册

在已发布课程中注册用户。此操作在user.id和注册的\u的组合上是幂等的。多次发布到此终结点不会为现有用户创建新的注册。在组合中，id&Registered\u。但是，如果user.id或registered_at参数与现有注册不匹配，则每次调用都将创建新注册。采购状态='CREATED'、'PENDING'、'SUCCESS'、'FAILED'、'returned'、'CANCELLED'或'FLAGGED'示例帖子正文（如果发布JSON而不是表单编码参数）：{“user”：{“id”：“abcde12345”，}，“登记于”：“2018-03-12T10:12:45Z”，“到期日期”：“2018-05-12T10:12:45Z”，“active”：true，“采购”：“采购状态”：“SUCCESS”，“购买价格”：{“金额”：“5.00”，“货币代码”：“USD”}，“购买地点”：“2018-02-12T10:12:45Z”，“税费价格”：100}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
published_course_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
用户必修的 对象
enrolled_at 一串
过期于 一串
忙碌的 布尔值
购买 对象
收到 /v1/domains/{domain_name}/已发布课程/{published_课程_id}/注册/{registration_id}

获取注册详细信息。如果注册是与购买或通过课程平台UI注册相关联创建的，则购买详细信息将包含在响应中。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
published_course_id必修的 一串
enrollment_id必修的 一串
放 /v1/domains/{domain_name}/已发布课程/{published_课程_id}/注册/{registration_id}

更新注册详细信息。PUT和修补程序完全相同-都进行部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
published_course_id必修的 一串
enrollment_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
过期于 一串
忙碌的 布尔值
补丁 /v1/domains/{domain_name}/已发布课程/{published_课程_id}/注册/{registration_id}

更新注册详细信息。PUT和修补程序完全相同-都进行部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
published_course_id必修的 一串
enrollment_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
过期于 一串
忙碌的 布尔值
收到 / / {domain_name} / published-paths v1 /域

返回发布到域的路径列表。返回已发布路径的分页列表(每页100个结果)。示例响应:{“计数”:1、“下一个”:空,“之前”:空,“结果”:[{“id”:“abcdefg123456”、“路径”:{" id ":“cdefghi345678”,“标题”:“示例路径名称”,“path_item_count”:0},“path_url”:“http://learn.example.com/path/example-path-title”,“提供”:{" id ":“bcdefgh234567”、“registration_open”:真的,“registration_url”:"http://learn.example.com/checkout/bcdefgh234567"， "price": {"amount": "20.00"， "currency_code": "USD"}}}]}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
收到 / v1 /域/ {domain_name} / published-paths / {id}

检索发布路径详细信息。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
id必修的 一串
收到 / / {domain_name} / signup-fields v1 /域

列出一个域的注册域。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
收到 / v1 /域/ {domain_name} /用户

列出域的用户。返回域用户详细信息的分页列表(每页1000个结果)。示例响应:{“计数”:2,“下一个”:空,“之前”:空,“结果”:[{"用户":{" id ":“opqrstu345678”、“电子邮件”:“joe@example.com”、“first_name”:“乔”,“last_name”:“用户”},“活动”:真的,“marketing_optin”:空,“enrolled_at”:“2015 - 01 - 29 t00:22:00.590250z”、“expires_at”:空,“access_code”:零},{"用户":{" id ":“cdefghi567890”、“电子邮件”:“jane@example.com”、“first_name”:“简”、“last_name”:“母鹿”},“活动”:假的,“marketing_optin”:空,“enrolled_at”:“2015 - 02 - 15 t00:43:10.123456z”、“expires_at”:空,“access_code”:{" id ":“defghij678901”、“代码”:“opensesame”,“池”:{" id ":“efghijk789012”、“名称”:“精灵代码 " } } } ] }

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
user__email 通过电子邮件地址过滤域用户 一串
用户名 过滤域用户的名字-区分大小写 一串
user__last_name 按姓氏区分大小写过滤域用户 一串
忙碌的 按活动筛选域用户（正确或错误） 一串
access_code__code 根据使用的访问代码过滤域用户-区分大小写 一串
access_code__id 根据使用的访问代码的id过滤域用户-不区分大小写 一串
access_code__pool__id 根据使用的访问码池id过滤域用户-不区分大小写 一串
access_code 使用“null”值可查看访问域但没有访问代码的域用户。此查询不接受其他值。 一串
帖子 / v1 /域/ {domain_name} /用户

将用户添加到域。用户必须具有唯一的电子邮件地址。您可以将现有用户（现有电子邮件地址）发布到域中，呼叫仍将成功返回，并显示现有用户详细信息。如果您向域发布新用户电子邮件，则该呼叫将在系统中创建新用户。示例帖子正文（如果发布JSON而不是表单编码参数）：{“用户”：{“电子邮件”：”bob@example.com“，”姓“：”鲍勃“，”姓“：”用户“}}}示例响应：{”用户“：{”id“：”qrstuvw321098“，”电子邮件“：”bob@example.com“，”名字“：”鲍勃“，”姓氏“：”用户“}，“活动”：真，“营销选项”：空，“注册地点”：“2015-01-29T00:22:00.590250Z”，“过期时间”：null，“访问代码”：null，“登录令牌”：“qrstuvw321098-3xn-a1b23cd456dfg7890hijk”}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
用户必修的 用户详细信息 对象
忙碌的 只有活动用户可以访问私有域 布尔值
marketing_optin 表示用户已接受或拒绝营销选项消息。Null表示未向用户显示任何营销选项消息 布尔值
过期于 ISO 8601格式化的datetime字符串，指示对域的访问将在何时到期——在公共域上忽略 一串
收到 / v1 /域/ {domain_name} /用户/ {user_id}

获取域上用户的详细信息。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
user_id必修的 一串
放 / v1 /域/ {domain_name} /用户/ {user_id}

更新域用户。只有active和expires_at可以更新。也可以通过将整个access_code设置为null来删除访问代码。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
user_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
忙碌的 布尔值
过期于 一串
access_code 关于用户输入的访问代码的信息，如果他们使用该代码加入私有域 对象
补丁 / v1 /域/ {domain_name} /用户/ {user_id}

更新域用户。只有active和expires_at可以更新。也可以通过将整个access_code设置为null来删除访问代码。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
user_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
忙碌的 布尔值
过期于 一串
access_code 关于用户输入的访问代码的信息，如果他们使用该代码加入私有域 对象
收到 / v1 /域/ {domain_name} /用户/ {user_id} /邀请

列出此域上用户的所有邀请

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
user_id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
帖子 / v1 /域/ {domain_name} /用户/ {user_id} /邀请

创建域用户邀请。这将通过电子邮件向用户发送邀请，除非send_email设置为False。用户必须已经添加到域。---

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
user_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
send_email 是否向用户发送电子邮件邀请他们到域。默认值为True 布尔值
收到 / v1 /域/ {domain_name} /用户/ {user_id} /邀请/ {domain_user_invite_id}

获取域用户邀请详细信息

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
user_id必修的 一串
domain_user_invite_id必修的 一串
收到 / v1 /域/ {domain_name} / {user_id} / signup-fields /用户

列出用户的注册字段。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
user_id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
帖子 / v1 /域/ {domain_name} / {user_id} / signup-fields /用户

创建或更新用户的注册字段值。如果用户没有分配给post注册字段的当前值，则此端点将为用户创建一个新的注册字段值。如果用户已经拥有与注册字段相关联的值，那么它将被更新为post值。示例POST主体(如果是POST JSON而不是form-encoded parameters): {"signup_field": {"id": "abcd1234"}， "value": "My Signupfield value"}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
user_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
注册字段必修的 对象
价值必修的 一串
收到 /v1/domains/{domain\u name}/users/{user\u id}/signup fields/{signup\u field\u id}

查看用户的注册字段值。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
域名必修的 一串
user_id必修的 一串
signup_field_id必修的 一串

组

收到 /v1/组

组列表。返回分组的分页列表(每页1000个结果)。Name——根据组名的精确匹配过滤组

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
名称 根据组名的精确匹配过滤组 一串
帖子 /v1/组

创建一个组。

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
名称必修的 组的唯一名称 一串
收到 / v1 /团体/ {group_id}

得到组织的细节。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
group_id必修的 一串
放 / v1 /团体/ {group_id}

更新组细节。目前您只能更改组的名称。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
group_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
名称必修的 组的唯一名称 一串
补丁 / v1 /团体/ {group_id}

更新组细节。目前您只能更改组的名称。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
group_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
名称 组的唯一名称 一串
删除 / v1 /团体/ {group_id}

删除组。完全删除组和所有GroupUsers。将保留用户和域用户。此操作无法撤消。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
group_id必修的 一串
收到 /v1/groups/{group_id}/access代码池

列出组的访问代码池。返回访问代码池详细信息的分页列表(每页1000个结果)。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
group_id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
帖子 /v1/groups/{group_id}/access代码池

向组中添加接入码池。示例POST body(如果POST JSON而不是form-encoded parameters): {"access_code_pool": {"id": "abcde12345"，}}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
group_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
访问\u代码\u池必修的 对象
收到 / v1 /团体/ {group_id} / access-code-pools / {access_code_pool_id}

获取组中访问码池的详细信息。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
group_id必修的 一串
访问\u代码\u池\u id必修的 一串
删除 / v1 /团体/ {group_id} / access-code-pools / {access_code_pool_id}

从组中删除访问码池。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
group_id必修的 一串
访问\u代码\u池\u id必修的 一串
收到 / v1 /组/ {group_id} /用户

列出组内用户。返回组用户详细信息的分页列表(每页1000个结果)。Response: {"count": 2， "next": null， "previous": null， "results": [{"user": {"id": "opqrstu345678"， "email": "joe@example.com"， "first_name": "Joe"， "last_name": "user"}， "created_at": "2015-02-19T19:20:24.671362Z"}， {"user": {"id": "cdefghi567890"， "email": "jane@example.com"， "first_name": "Jane"， "last_name":“母鹿”},“created_at”:“2015 - 02 - 18 t10:37:48.543927z”}]}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
group_id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
帖子 / v1 /组/ {group_id} /用户

将用户添加到组。示例发布正文（如果发布JSON而不是表单编码参数）：{“用户”：{“id”：“abcde12345”，}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
group_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
用户必修的 用户详细信息 对象
收到 /v1/groups/{group_id}/users/{user_id}

获取组中用户的详细信息。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
group_id必修的 一串
user_id必修的 一串
删除 /v1/groups/{group_id}/users/{user_id}

从组中移除用户。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
group_id必修的 一串
user_id必修的 一串

课程进展

收到 / v1 / lesson-progress / {lesson_progress_id}

了解课程进展细节。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
课程\进度\ id必修的 一串
放 / v1 / lesson-progress / {lesson_progress_id}

更新课程进度。PUT和PATCH是相同的-都进行部分更新。将finished_设置为表示学生已完成内容。这也将标记课程完成，除非课程需要验证，例如检查程序。要取消完成课程，请将completed_at设置为null。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
课程\进度\ id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
完成于 ISO 8601格式化的datetime字符串，表示用户完成课程内容的时间。设置此字段也将标记课程完成，除非课程需要验证，例如审查监考。 一串
completed_at ISO 8601格式化的日期时间字符串，指示用户完成课程的时间。如果为空，则表示用户尚未完成课程。 一串
成功与地位 'PASSED'， 'FAILED'或null 枚举
分数 得分 整数
max_score 最大可能的得分 整数
custom_data 一串
validation_status 'PASSED'， 'FAILED'或null 枚举
validation_data JSON格式化。如果课程不需要验证，则忽略。 对象
补丁 / v1 / lesson-progress / {lesson_progress_id}

课程进度的部分更新。PUT和PATCH是相同的-都进行部分更新。将finished_设置为表示学生已完成内容。这也将标记课程完成，除非课程需要验证，例如检查程序。要取消完成课程，请将completed_at设置为null。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
课程\进度\ id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
完成于 ISO 8601格式化的datetime字符串，表示用户完成课程内容的时间。设置此字段也将标记课程完成，除非课程需要验证，例如审查监考。 一串
completed_at ISO 8601格式化的日期时间字符串，指示用户完成课程的时间。如果为空，则表示用户尚未完成课程。 一串
成功与地位 'PASSED'， 'FAILED'或null 枚举
分数 得分 整数
max_score 最大可能的得分 整数
custom_data 一串
validation_status 'PASSED'， 'FAILED'或null 枚举
validation_data JSON格式化。如果课程不需要验证，则忽略。 对象

提供

收到 / v1 /提供

提供列表。根据提供的过滤器返回一个分页列表(每页1000个结果)。

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
收到 /v1/offers/{offer_id}

获取报价详情

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
offer_id必修的 一串

路径

收到 / v1 /路径

路径列表。根据提供的过滤器返回一个分页列表(每页100个结果)。响应示例:{"count": 1， "next": null， "previous": null， "results": ["path": {"id": "cdefghi345678"， "title": "示例路径标题"，"path_item_count": 0}]}

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
收到 /v1/path/{id}

获取路径详细信息。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
id必修的 一串
收到 /v1/path/{path_id}/path项

返回路径项对象的列表示例响应：{“count”：1，“next”：null，“previous”：null，“results”：[{“id”：“qwerty1234”，“slug”：“test-Path-1”，“course”：{“id”：“abcdefg1234”，“title”：“test-Path-course 1”，“lessure\u count”：3，“required\u-lessment\u-lessure\u-count”：3}}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
path_id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
收到 / v1 /路径/ {path_id} /路径项目/ {id}

返回单个路径项对象及其详细信息

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
path_id必修的 一串
id必修的 一串

平

收到 / v1 /平

Ping API端点。HTTP 2xx响应表明与Skilljar API端点的身份验证成功。

progresstokens

放 / v1 / progresstokens / {progress_token_id}

根据给定的进度标记更新进度。可以为用户更新相应的课程进度，如果此操作完成课程，则更新课程状态。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
progress_token_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
completed_at ISO 8601格式化的datetime字符串，表示用户完成任务的时间 一串
成功与地位 枚举
分数 得分 整数
max_score 最大可能的得分 整数
补丁 / v1 / progresstokens / {progress_token_id}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
progress_token_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
completed_at ISO 8601格式化的datetime字符串，表示用户完成任务的时间 一串
成功与地位 枚举
分数 得分 整数
max_score 最大可能的得分 整数

promo-code-pools

收到 /v1/promo代码池

PromoCodePools列表。根据提供的过滤器返回一个分页列表(每页1000个结果)。

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
offer_id 通过报价的id过滤结果 一串
名称 按PromoCodePool名称筛选结果 一串
帖子 /v1/promo代码池

创建一个PromoCodePool例子后的身体(如果发布JSON而不是表单编码的参数):{“名称”:“promo-code-pool-name-1”,“活动”:真的,“discount_type”:“PERCENT_OFF”、“PERCENT_OFF”:100年,“single_use_per_user”:假的,“starts_at”:“2018 - 03 - 16 t16:45:55.946094z”、“expires_at”:“2018 - 10 - 16 t16:45:55.946094z}或{“名称”:" promoc -code-pool-name-1"， "active": true， "discount_type": "PRICE_OVERRIDE"， "price_cents": 5000， "single_use_per_user": false， "starts_at": "2018-03-16 t16:45:55 946094z "， "expires_at": "2018-10-16 t16:45:55 946094z "，}

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
名称必修的 一串
忙碌的 布尔值
starts_at必修的 ISO 8601格式化的日期时间字符串，表示促销代码池的开始 一串
过期于 ISO 8601格式化的日期时间字符串，表示促销代码池的过期 一串
折扣类型必修的 枚举
price_cents 整数
折成 整数
单个用户使用每个用户 布尔值
收到 /v1/promo代码池/{promo\u代码池\u id}

得到PromoCodePool细节

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
促销代码池id必修的 一串
放 /v1/promo代码池/{promo\u代码池\u id}

promo-code-pools更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
促销代码池id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
名称必修的 一串
忙碌的 布尔值
starts_at必修的 一串
过期于 ISO 8601格式化的日期时间字符串，表示促销代码池的过期 一串
补丁 /v1/promo代码池/{promo\u代码池\u id}

promo-code-pools更新。PUT和PATCH是相同的——两者都做部分更新

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
促销代码池id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
名称 一串
忙碌的 布尔值
starts_at 一串
过期于 ISO 8601格式化的日期时间字符串，表示促销代码池的过期 一串
删除 /v1/promo代码池/{promo\u代码池\u id}

删除一个PromoCodePool记录。因此，关联的PromoCode也将被删除。任何使用先前关联的PromoCode的购买现在都将更新为code_used的空值。这一行动无法挽回。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
促销代码池id必修的 一串
收到 / v1 / promo-code-pools / {promo_code_pool_id} /提供

列出促销活动和优惠。根据提供的筛选器返回分页列表（每页1000个结果）。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
促销代码池id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
帖子 / v1 / promo-code-pools / {promo_code_pool_id} /提供

将报价附加到PromotCodePool。每笔交易最多可向PromoCodePool添加500个优惠。示例发布正文（如果发布JSON而不是表单编码参数）：{“id”：“abcde12345”}或[{“id”：“bcdef23456”}，{“id”：“cdefg34567”}，{“id”：“defgh45678”}，{“id”：“efghi56789”}]

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
促销代码池id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
id 提供您希望附加到PromoCodePool的ID 一串
删除 /v1/promo代码池/{promo\u代码池{u id}/offers/{offer\u id}

从PromoCodePool中删除要约。不删除Offer或PromoCodePool

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
促销代码池id必修的 一串
offer_id必修的 一串

促销代码

收到 / v1 /促销代码

PromoCodes列表。根据提供的过滤器返回一个分页列表(每页1000个结果)。

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
促销代码池id 通过报价的id过滤结果 一串
代码 按所用代码筛选结果-区分大小写 一串
忙碌的 根据活动(真或假)过滤结果 一串
帖子 / v1 /促销代码

创建一个促销代码。在尝试发布到此终结点之前，PromoCodePool必须存在。示例发布正文（如果发布JSON而不是表单编码参数）：{“代码”：“6hhzj2ea-v5j3ak3d”，“最大使用”：30，“活动”：true，“促销代码”池id:“9uips0sdja”，}

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
代码必修的 一串
max_uses必修的 整数
忙碌的 布尔值
促销代码池id必修的 一串
收到 /v1/promo-code/{promo\u-code\u-id}

获取促销代码详细信息

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
promo_code_id必修的 一串
放 /v1/promo-code/{promo\u-code\u-id}

促销代码的更新。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
promo_code_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
代码必修的 一串
max_uses必修的 整数
忙碌的 布尔值
补丁 /v1/promo-code/{promo\u-code\u-id}

促销代码的更新。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
promo_code_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
代码 一串
max_uses 整数
忙碌的 布尔值
删除 /v1/promo-code/{promo\u-code\u-id}

删除一个PromoCode记录。这一行动无法挽回。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
promo_code_id必修的 一串

购买

收到 /v1/采购/{purchase_id}

得到购买细节。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
purchase_id必修的 Purchase对象的ID 一串

响应对象

响应对象是“application / JSON”已编码的对象，包含以下项。

参数 描述
id 采购对象的（内部）ID
用户 创建Purchase对象的用户对象
状态信息 购买付款失败时的状态消息
于购买 Purchase对象创建的日期
退还 被拒绝的购买被退款的日期（如果）
退款0美分 (如果)反对购买的金额被退回
payment_processor 付款处理器
order_id Purchase的惟一订单ID
price_cents 所购买物品的价格(美分)
数量 购买物品数量
offer_id （内部）购买的报价的ID
报价单 (内部)所购买的要约SKU
offer_description 所购要约的说明
报价(美分) 购买要约的价格(美分)
促销代码价格美分 所用促销代码的价格（单位：美分）
促销代码折扣百分比 促销代码折扣百分比
促销代码数量 使用的促销代码数量
tax_price_cents 购买的地方税价格(美分)
付款\处理程序\订单\ id 所使用的支付处理器的ID
payment_processor_response_data 使用的支付处理程序的响应
货币代码 购买时使用的货币类型
放 /v1/采购/{purchase_id}

更新购买详细信息。PUT和修补程序完全相同-都进行部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
purchase_id必修的 一串

请求主体

请求体应该是“application / JSON”编码，并应包含单个项。

参数 描述 类型
状态 'PENDING'， 'SUCCESS'， 'FAILED'， ' refund '，或'CANCELLED' 枚举
退还 一串
退款0美分 整数
price_cents 整数
tax_price_cents 整数
补丁 /v1/采购/{purchase_id}

更新购买详细信息。PUT和修补程序完全相同-都进行部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
purchase_id必修的 一串

请求主体

请求体应该是“application / JSON”编码，并应包含单个项。

参数 描述 类型
状态 'PENDING'， 'SUCCESS'， 'FAILED'， ' refund '，或'CANCELLED' 枚举
退还 一串
退款0美分 整数
price_cents 整数
tax_price_cents 整数
帖子 / v1 /购买/ {purchase_id} /完成

满足特定的购买。更新购买状态，如果“成功”，完成购买，创建任何必要的课程或域名注册。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
purchase_id必修的 一串

请求主体

请求体应该是“application / JSON”编码，并应包含单个项。

参数 描述 类型
状态必修的 'SUCCESS'， 'FAILED'，或'CANCELLED' 枚举
错误消息 可选:这个错误消息将在用户返回Skilljar后显示给他们，并将被设置为购买的status_msg 一串
付款\处理程序\订单\ id 可选:支付处理器系统内交易的id，仅供参考 一串
payment_processor_response_data 可选：购买元数据。仅供参考。建议使用JSON格式 一串

用户

收到 / v1 /用户

列出已在至少一个域中注册的用户。返回用户的分页列表(每页1000个结果)。

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
电子邮件 按电子邮件地址筛选用户 一串
first_name 按名字筛选用户-区分大小写 一串
last_name 按姓氏筛选用户-区分大小写 一串
收到 /v1/users/{user_id}

获取用户的课程注册概述。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串
放 /v1/users/{user_id}

更新用户详细信息。只能更改名称和电子邮件地址。PUT和修补程序相同-两者都进行部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
电子邮件 电子邮件地址 一串
first_name 第一个名字 一串
last_name 姓 一串
补丁 /v1/users/{user_id}

部分更新用户详细信息。只能更改名称和电子邮件地址。PUT和修补程序相同-两者都进行部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
电子邮件 电子邮件地址 一串
first_name 第一个名字 一串
last_name 姓 一串
帖子 / v1 /用户/ {user_id} /匿名化

混淆所有可用于直接或间接识别用户的数据。这将永久更新用户，删除敏感信息，并防止将来使用该平台。这种行为是不可逆的。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串
收到 / v1 /用户/ {user_id} /组

列出用户所属的组。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
收到 / v1 /用户/ {user_id} / published-courses

为用户列出已发布的课程和进度详细信息。返回一个分页列表(每页1000个结果)，当然是用户的进度细节。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
收到 /v1/users/{user_id}/已发布课程/{published_课程{u id}

获取用户的课程进度详细信息。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串
published_course_id必修的 一串
放 /v1/users/{user_id}/已发布课程/{published_课程{u id}

更新用户的课程进度。PUT和PATCH是相同的——两者都做部分更新。要将一门课程标记为完成，只需要在课程进度中设置completed_at。例如:{"course_progress": {"completed_at": "2015-06-03T01:02:03.012345Z"， "success_status": "PASSED"}}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串
published_course_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
published_course_id 已发布课程的ID 一串
课程进展必修的 对象
补丁 /v1/users/{user_id}/已发布课程/{published_课程{u id}

用户的部分更新课程进度。PUT和PATCH是相同的-都进行部分更新。要将课程标记为已完成，只需在课程进度中将已完成的_设置为。例如：{“课程进度”：{“完成时间”：“2015-06-03T01:02:03.012345Z”，“成功状态”：“通过”}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串
published_course_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
published_course_id 已发布课程的ID 一串
课程进展 对象
收到 /v1/users/{user_id}/已发布课程/{published_课程{u id}/课程

列出特定课程中用户的课程进度详细信息。为用户返回课程进度详细信息的分页列表（每页100个结果）。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串
published_course_id必修的 一串

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
收到 / v1 /用户/ {user_id} / published-courses / {published_course_id} /经验/ {lesson_id}

获取用户的课程进度细节。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串
published_course_id必修的 一串
第十一课必修的 一串
放 / v1 /用户/ {user_id} / published-courses / {published_course_id} /经验/ {lesson_id}

为用户更新课程进度。PUT和PATCH是相同的-都进行部分更新。要将课程标记为已完成，只需在课程进度中将已完成的_设置为。例如：{“课程进度”：{“完成时间”：“2015-06-03T01:02:03.012345Z”}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串
published_course_id必修的 一串
第十一课必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
lesson_progress必修的 对象
补丁 / v1 /用户/ {user_id} / published-courses / {published_course_id} /经验/ {lesson_id}

用户的部分更新课程进度。PUT和PATCH是相同的-都进行部分更新。要将课程标记为已完成，只需在课程进度中将已完成的_设置为。例如：{“课程进度”：{“完成时间”：“2015-06-03T01:02:03.012345Z”}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
user_id必修的 一串
published_course_id必修的 一串
第十一课必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
lesson_progress 对象

vilt会话事件

收到 / v1 / vilt-session-events

ViltSessionEvents列表。根据提供的筛选器返回一个分页列表。

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
session__lesson__course__id 通过与Course ID的精确匹配过滤ViltSessionEvents 一串
session__lesson__id 按课程ID的精确匹配筛选ViltSessionEvents 一串
开始于 在ViltSessionEvent大于或等于start at值的地方进行筛选。Datetime格式 一串
ends_at__lte 筛选ViltSessionEvent小于或等于结束值的地方。Datetime格式 一串
收到 / v1 / vilt-session-events / {vilt_session_event_id}

获取ViltSessionEvent详细信息

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
vilt_session_event_id必修的 一串

vilt会话注册

收到 / v1 / vilt-session-registrations

列出ViltSession注册。根据提供的筛选器返回分页列表（每页1000个结果）。

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
页面大小 每页返回的结果数。 整数
session__id 按ViltSession的id筛选结果 一串
帖子 / v1 / vilt-session-registrations

注册一个用户到vilt_session。在尝试发送到此端点之前，必须存在该用户的注册。示例POST body(如果是POST JSON而不是form-encoded parameters): {"vilt_session": {"id": "jaso89ajs"，}， " registrment_id ": "9uips0sdja"}

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
维尔托会议 对象
enrollment_id 一串
收到 / v1 / vilt-session-registrations / {vilt_session_registration_id}

获取ViltSessionRegistration详细信息

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
vilt\u会话\u注册\u id必修的 一串
放 / v1 / vilt-session-registrations / {vilt_session_registration_id}

vilt-session-registrations更新。只有出席人数可以更改。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
vilt\u会话\u注册\u id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
参加了必修的 布尔值
补丁 / v1 / vilt-session-registrations / {vilt_session_registration_id}

vilt-session-registrations更新。只有出席人数可以更改。PUT和PATCH是相同的——两者都做部分更新。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
vilt\u会话\u注册\u id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
参加了 布尔值
删除 / v1 / vilt-session-registrations / {vilt_session_registration_id}

删除ViltSessionRegistration记录，将学生标记为ViltSessionEvent的无人参与。此操作无法撤消。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
vilt\u会话\u注册\u id必修的 一串

人则

收到 / v1 /人

人名单。返回webhook的分页响应(每页100个结果)。响应示例:{"count": 1， "next": null， "previous": null， "results": [{"id": "abcd1234"， "target_url": "http://example.com/skilljar-hook-processor"， "active": true， "deactivate_reason": null}]}

查询参数

以下参数应作为URL查询字符串的一部分包含。

参数 描述 类型
页 分页结果集中的页码。 整数
帖子 / v1 /人

创建一个webhook。当平台内发生事件时，Skilljar系统将向给定URL发送HTTP POST请求。事件包括：用户注册课程时、用户完成课程时以及用户注册域时。

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
target_url必修的 一串
忙碌的 布尔值
收到 /v1/webhook/{webhook_id}

获取webhook详细信息。响应示例：{“id”：“abcd1234”，“target_url”：”http://example.com/skilljar-hook-processor，“active”：true，“deactivate_reason”：null}

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
webhook_id必修的 一串
放 /v1/webhook/{webhook_id}

更新webhook细节。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
webhook_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
target_url必修的 一串
忙碌的 布尔值
补丁 /v1/webhook/{webhook_id}

更新webhook细节。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
webhook_id必修的 一串

请求主体

请求体应该是“application / json”编码，并应包含单个项。

参数 描述 类型
target_url 一串
忙碌的 布尔值
删除 /v1/webhook/{webhook_id}

删除webhook。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
webhook_id必修的 一串
帖子 / v1 /人/ {webhook_id} /平

发送一个类型为PING的HTTP POST事件到webhook。失败不会使webhook失效，也不会重试。

路径参数

URL路径中应该包含以下参数。

参数 描述 类型
webhook_id必修的 一串
收到 / v1 /人/ sample-course-completion

返回课程完成事件示例的单项列表。此API返回的示例事件要么是最近的COURSE_COMPLETION事件，要么是带有示例数据(如果没有课程完成)的示例事件。这个API在内部用于生成样本数据;实际的webhook通知的主体将是一个单一的JSON事件，不包含在列表中。

收到 / v1 /人/ sample-course-enrollment

返回示例课程注册事件的单项列表。此API返回的样例事件要么是最近的COURSE_ENROLLMENT事件，要么是带有样例数据(如果没有课程注册)的样例事件。这个API在内部用于生成样本数据;实际的webhook通知的主体将是一个单一的JSON事件，不包含在列表中。

收到 / v1 /人/ sample-domain-enrollment

返回示例域登记事件的单项列表。此API返回的样例事件要么是最近的DOMAIN_ENROLLMENT事件(如果最近的域成员具有与当前活动注册字段相对应的注册信息)，要么是带有样例数据的样例事件(如果没有域成员关系)。这个API在内部用于生成样本数据;实际的webhook通知的主体将是一个单一的JSON事件，不包含在列表中。

收到 /v1/webhooks/示例课程完成

返回示例课程完成事件的单个项目列表。此API返回的示例事件可以是最近的课程完成事件，也可以是包含示例数据的示例事件（如果没有课程完成）。此API在内部用于生成示例数据；实际webhook通知的主体将是单个JSON事件at不包含在列表中。

收到 / v1 /人/ sample-purchase-fulfillment

返回示例采购履行事件的单个项目列表。此API返回的示例事件要么是最近的采购履行事件，要么是包含示例数据的示例事件（如果没有采购履行事件）。该API在内部用于生成样本数据；实际webhook通知的主体将是一个不包含在列表中的JSON事件。

收到 / v1 /人/ sample-quiz-completion

返回样本测验完成事件的单个项目列表。此API返回的样本事件要么是最近的测验完成事件，要么是包含样本数据的样本事件（如果没有测验完成）。此API在内部用于生成样本数据；实际webhook通知的主体将是单个JSON事件，即不包含在列表中。

Baidu