mcharris/blackboard-rest-php

此包已被弃用，不再维护。未建议替代包。

维护者

详细信息

github.com/mcharris/blackboard-rest-php

主页

源代码

问题

安装: 43

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

v0.1 2017-04-25 21:28 UTC

Requires

Requires (Dev)

proprietary b6c980e3f823f2ea9e150bf85afaff0933fabd6a

phpapisdkswagger

This package is not auto-updated.

Last update: 2020-02-07 17:00:46 UTC

README

未提供描述（由Swagger Codegen生成 https://github.com/swagger-api/swagger-codegen）

此PHP包由Swagger Codegen项目自动生成

  • API版本：3200.0.0
  • 构建包：io.swagger.codegen.languages.PhpClientCodegen

要求

PHP 5.4.0及更高版本

安装和用法

Composer

要使用Composer安装绑定，请将以下内容添加到composer.json

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/mcharris/BlackboardRestPHP.git"
    }
  ],
  "require": {
    "mcharris/BlackboardRestPHP": "*@dev"
  }
}

然后运行composer install

手动安装

下载文件并包含autoload.php

    require_once('/path/to/SwaggerClient-php/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门

请按照安装过程进行操作，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
BlackboardRest\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// BlackboardRest\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new BlackboardRest\Api\AnnouncementsApi();
$announcement_id = "announcement_id_example"; // string |
$fields = "fields_example"; // string | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

try {
    $api_instance->announcementsAnnouncementIdDelete($announcement_id, $fields);
} catch (Exception $e) {
    echo 'Exception when calling AnnouncementsApi->announcementsAnnouncementIdDelete: ', $e->getMessage(), PHP_EOL;
}

?>

API端点的文档

所有URI都是相对于https:///learn/api/public/v1/

类 方法 HTTP请求 描述
AnnouncementsApi announcementsAnnouncementIdDelete DELETE announcements/{announcementId} 删除公告
AnnouncementsApi announcementsAnnouncementIdGet GET announcements/{announcementId} 获取公告
AnnouncementsApi announcementsAnnouncementIdPatch PATCH announcements/{announcementId} 更新公告
AnnouncementsApi announcementsGet GET announcements 获取公告
AnnouncementsApi announcementsPost POST announcements 创建公告
ContentApi coursesCourseIdContentsContentIdChildrenGet GET courses/{courseId}/contents/{contentId}/children 获取子项
ContentApi coursesCourseIdContentsContentIdChildrenPost POST courses/{courseId}/contents/{contentId}/children 创建子项
ContentApi coursesCourseIdContentsContentIdDelete DELETE courses/{courseId}/contents/{contentId} 删除内容
ContentApi coursesCourseIdContentsContentIdGet GET courses/{courseId}/contents/{contentId} 获取内容
ContentApi coursesCourseIdContentsContentIdPatch PATCH courses/{courseId}/contents/{contentId} 更新内容
ContentApi coursesCourseIdContentsGet GET courses/{courseId}/contents 获取内容
ContentApi coursesCourseIdContentsPost POST courses/{courseId}/contents 创建内容
ContentGroupAssignmentsApi coursesCourseIdContentsContentIdGroupsGet GET courses/{courseId}/contents/{contentId}/groups 获取内容组
ContentGroupAssignmentsApi coursesCourseIdContentsContentIdGroupsGroupIdDelete DELETE courses/{courseId}/contents/{contentId}/groups/{groupId} 删除内容组
ContentGroupAssignmentsApi 课程内容组ID获取 GET courses/{courseId}/contents/{contentId}/groups/{groupId} 获取内容组
ContentGroupAssignmentsApi 课程内容组ID更新 PUT courses/{courseId}/contents/{contentId}/groups/{groupId} 创建内容组
课程成绩API 课程ID成绩簿列尝试ID获取 GET courses/{courseId}/gradebook/columns/{columnId}/attempts/{attemptId} 获取列尝试
课程成绩API 课程ID成绩簿列尝试获取 GET courses/{courseId}/gradebook/columns/{columnId}/attempts 获取列尝试列表
课程成绩API 课程ID成绩簿列删除 DELETE courses/{courseId}/gradebook/columns/{columnId} 删除成绩列
课程成绩API 课程ID成绩簿列获取 GET courses/{courseId}/gradebook/columns/{columnId} 获取成绩列
课程成绩API 课程ID成绩簿列部分更新 PATCH courses/{courseId}/gradebook/columns/{columnId} 更新成绩列
课程成绩API 课程ID成绩簿列用户获取 GET courses/{courseId}/gradebook/columns/{columnId}/users 获取列成绩
课程成绩API 课程ID成绩簿列用户用户ID获取 GET courses/{courseId}/gradebook/columns/{columnId}/users/{userId} 获取列成绩
课程成绩API 课程ID成绩簿列用户用户ID部分更新 PATCH courses/{courseId}/gradebook/columns/{columnId}/users/{userId} 更新列成绩
课程成绩API 课程ID成绩簿列获取 GET courses/{courseId}/gradebook/columns 获取成绩列列表
课程成绩API 课程ID成绩簿列创建 POST courses/{courseId}/gradebook/columns 创建成绩列
课程成绩API 课程ID成绩簿用户用户ID获取 GET courses/{courseId}/gradebook/users/{userId} 获取用户成绩
课程组用户API 课程ID组组ID用户获取 GET courses/{courseId}/groups/{groupId}/users 获取组成员
课程组用户API 课程ID组组ID用户用户ID删除 DELETE courses/{courseId}/groups/{groupId}/users/{userId} 删除组成员
课程组用户API 课程ID组组ID用户用户ID获取 GET courses/{courseId}/groups/{groupId}/users/{userId} 获取组成员
课程组用户API 课程ID组组ID用户用户ID更新 PUT courses/{courseId}/groups/{groupId}/users/{userId} 更新组成员
课程组API 课程ID组获取 GET courses/{courseId}/groups 获取组
课程组API 课程ID组组ID删除 DELETE courses/{courseId}/groups/{groupId} 删除组
课程组API 课程ID组组ID获取 GET courses/{courseId}/groups/{groupId} 获取组
课程组API 课程ID组组ID部分更新 PATCH courses/{courseId}/groups/{groupId} 更新组
课程组API 课程ID组创建 POST courses/{courseId}/groups 创建组
课程成员API 课程ID用户获取 GET courses/{courseId}/users 获取成员
课程成员API 课程ID用户用户ID删除 DELETE courses/{courseId}/users/{userId} 删除成员
课程成员API 课程ID用户用户ID获取 GET courses/{courseId}/users/{userId} 获取成员
课程成员API 课程ID用户用户ID部分更新 PATCH courses/{courseId}/users/{userId} 更新成员
课程成员API 课程ID用户用户ID更新 PUT courses/{courseId}/users/{userId} 创建成员
课程成员API 用户ID课程获取 GET users/{userId}/courses 获取成员
课程API 课程ID子课程ID获取 GET courses/{courseId}/children/{childCourseId} 获取子课程
课程API 课程ID子课程获取 GET courses/{courseId}/children 获取子项
课程API 课程ID删除 DELETE courses/{courseId} 删除课程
课程API 课程ID获取 GET courses/{courseId} 获取课程
课程API 课程ID部分更新 PATCH courses/{courseId} 更新课程
课程API 课程获取 GET courses 获取课程列表
课程API 课程创建 POST courses 创建课程
数据源API 数据源ID删除 DELETE dataSources/{dataSourceId} 删除数据源
数据源API 数据源ID获取 GET dataSources/{dataSourceId} 获取数据源
数据源API 数据源数据源ID补丁 PATCH dataSources/{dataSourceId} 更新数据源
数据源API dataSourcesGet GET dataSources 获取数据源
数据源API dataSourcesPost POST dataSources 创建数据源
OauthApi oauth2TokenPost POST oauth2/token 请求令牌
SystemApi systemVersionGet GET system/version 获取版本
TermsApi termsGet GET terms 获取条款
TermsApi termsPost POST terms 创建条款
TermsApi termsTermIdDelete DELETE terms/{termId} 删除条款
TermsApi termsTermIdGet GET terms/{termId} 获取条款
TermsApi termsTermIdPatch PATCH terms/{termId} 更新条款
UsersApi usersGet GET users 获取用户
UsersApi usersPost POST users 创建用户
UsersApi usersUserIdDelete DELETE users/{userId} 删除用户
UsersApi usersUserIdGet GET users/{userId} 获取用户
UsersApi usersUserIdPatch PATCH users/{userId} 更新用户

模型文档

授权文档

基本

  • 类型：HTTP基本身份验证

承载

  • 类型：API密钥
  • API密钥参数名：Authorization
  • 位置：HTTP头部

作者