2017 © Pedro Peláez
 

library blackboard-rest-php

image

mcharris/blackboard-rest-php

  • Tuesday, April 25, 2017
  • by mcharris
  • Repository
  • 1 Watchers
  • 0 Stars
  • 5 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 2 Versions
  • 0 % Grown

The README.md

blackboard-rest-php

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen), (*1)

This PHP package is automatically generated by the Swagger Codegen project:, (*2)

  • API version: 3200.0.0
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later, (*3)

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:, (*4)

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

Then run composer install, (*5)

Manual Installation

Download the files and include autoload.php:, (*6)

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

Tests

To run the unit tests:, (*7)

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:, (*8)

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;
}

?>

Documentation for API Endpoints

All URIs are relative to https://localhost/learn/api/public/v1/, (*9)

Class Method HTTP request Description
AnnouncementsApi announcementsAnnouncementIdDelete DELETE announcements/{announcementId} Delete Announcement
AnnouncementsApi announcementsAnnouncementIdGet GET announcements/{announcementId} Get Announcement
AnnouncementsApi announcementsAnnouncementIdPatch PATCH announcements/{announcementId} Update Announcement
AnnouncementsApi announcementsGet GET announcements Get Announcements
AnnouncementsApi announcementsPost POST announcements Create Announcement
ContentApi coursesCourseIdContentsContentIdChildrenGet GET courses/{courseId}/contents/{contentId}/children Get Children
ContentApi coursesCourseIdContentsContentIdChildrenPost POST courses/{courseId}/contents/{contentId}/children Create Child
ContentApi coursesCourseIdContentsContentIdDelete DELETE courses/{courseId}/contents/{contentId} Delete Content
ContentApi coursesCourseIdContentsContentIdGet GET courses/{courseId}/contents/{contentId} Get Content
ContentApi coursesCourseIdContentsContentIdPatch PATCH courses/{courseId}/contents/{contentId} Update Content
ContentApi coursesCourseIdContentsGet GET courses/{courseId}/contents Get Contents
ContentApi coursesCourseIdContentsPost POST courses/{courseId}/contents Create Content
ContentGroupAssignmentsApi coursesCourseIdContentsContentIdGroupsGet GET courses/{courseId}/contents/{contentId}/groups Get Content Groups
ContentGroupAssignmentsApi coursesCourseIdContentsContentIdGroupsGroupIdDelete DELETE courses/{courseId}/contents/{contentId}/groups/{groupId} Delete Content Group
ContentGroupAssignmentsApi coursesCourseIdContentsContentIdGroupsGroupIdGet GET courses/{courseId}/contents/{contentId}/groups/{groupId} Get Content Group
ContentGroupAssignmentsApi coursesCourseIdContentsContentIdGroupsGroupIdPut PUT courses/{courseId}/contents/{contentId}/groups/{groupId} Create Content Group
CourseGradesApi coursesCourseIdGradebookColumnsColumnIdAttemptsAttemptIdGet GET courses/{courseId}/gradebook/columns/{columnId}/attempts/{attemptId} Get Column Attempt
CourseGradesApi coursesCourseIdGradebookColumnsColumnIdAttemptsGet GET courses/{courseId}/gradebook/columns/{columnId}/attempts Get Column Attempts
CourseGradesApi coursesCourseIdGradebookColumnsColumnIdDelete DELETE courses/{courseId}/gradebook/columns/{columnId} Delete Grade Column
CourseGradesApi coursesCourseIdGradebookColumnsColumnIdGet GET courses/{courseId}/gradebook/columns/{columnId} Get Grade Column
CourseGradesApi coursesCourseIdGradebookColumnsColumnIdPatch PATCH courses/{courseId}/gradebook/columns/{columnId} Update Grade Column
CourseGradesApi coursesCourseIdGradebookColumnsColumnIdUsersGet GET courses/{courseId}/gradebook/columns/{columnId}/users Get Column Grades
CourseGradesApi coursesCourseIdGradebookColumnsColumnIdUsersUserIdGet GET courses/{courseId}/gradebook/columns/{columnId}/users/{userId} Get Column Grade
CourseGradesApi coursesCourseIdGradebookColumnsColumnIdUsersUserIdPatch PATCH courses/{courseId}/gradebook/columns/{columnId}/users/{userId} Update Column Grade
CourseGradesApi coursesCourseIdGradebookColumnsGet GET courses/{courseId}/gradebook/columns Get Grade Columns
CourseGradesApi coursesCourseIdGradebookColumnsPost POST courses/{courseId}/gradebook/columns Create Grade Column
CourseGradesApi coursesCourseIdGradebookUsersUserIdGet GET courses/{courseId}/gradebook/users/{userId} Get User Grades
CourseGroupUsersApi coursesCourseIdGroupsGroupIdUsersGet GET courses/{courseId}/groups/{groupId}/users Get Group Memberships
CourseGroupUsersApi coursesCourseIdGroupsGroupIdUsersUserIdDelete DELETE courses/{courseId}/groups/{groupId}/users/{userId} Delete Group Membership
CourseGroupUsersApi coursesCourseIdGroupsGroupIdUsersUserIdGet GET courses/{courseId}/groups/{groupId}/users/{userId} Get Group Membership
CourseGroupUsersApi coursesCourseIdGroupsGroupIdUsersUserIdPut PUT courses/{courseId}/groups/{groupId}/users/{userId} Put Group Membership
CourseGroupsApi coursesCourseIdGroupsGet GET courses/{courseId}/groups Get Groups
CourseGroupsApi coursesCourseIdGroupsGroupIdDelete DELETE courses/{courseId}/groups/{groupId} Delete Group
CourseGroupsApi coursesCourseIdGroupsGroupIdGet GET courses/{courseId}/groups/{groupId} Get Group
CourseGroupsApi coursesCourseIdGroupsGroupIdPatch PATCH courses/{courseId}/groups/{groupId} Update Group
CourseGroupsApi coursesCourseIdGroupsPost POST courses/{courseId}/groups Create Group
CourseMembershipsApi coursesCourseIdUsersGet GET courses/{courseId}/users Get Memberships
CourseMembershipsApi coursesCourseIdUsersUserIdDelete DELETE courses/{courseId}/users/{userId} Delete Membership
CourseMembershipsApi coursesCourseIdUsersUserIdGet GET courses/{courseId}/users/{userId} Get Membership
CourseMembershipsApi coursesCourseIdUsersUserIdPatch PATCH courses/{courseId}/users/{userId} Update Membership
CourseMembershipsApi coursesCourseIdUsersUserIdPut PUT courses/{courseId}/users/{userId} Create Membership
CourseMembershipsApi usersUserIdCoursesGet GET users/{userId}/courses Get Memberships
CoursesApi coursesCourseIdChildrenChildCourseIdGet GET courses/{courseId}/children/{childCourseId} Get Child
CoursesApi coursesCourseIdChildrenGet GET courses/{courseId}/children Get Children
CoursesApi coursesCourseIdDelete DELETE courses/{courseId} Delete Course
CoursesApi coursesCourseIdGet GET courses/{courseId} Get Course
CoursesApi coursesCourseIdPatch PATCH courses/{courseId} Update Course
CoursesApi coursesGet GET courses Get Courses
CoursesApi coursesPost POST courses Create Course
DataSourcesApi dataSourcesDataSourceIdDelete DELETE dataSources/{dataSourceId} Delete Data Source
DataSourcesApi dataSourcesDataSourceIdGet GET dataSources/{dataSourceId} Get Data Source
DataSourcesApi dataSourcesDataSourceIdPatch PATCH dataSources/{dataSourceId} Update Data Source
DataSourcesApi dataSourcesGet GET dataSources Get Data Sources
DataSourcesApi dataSourcesPost POST dataSources Create Data Source
OauthApi oauth2TokenPost POST oauth2/token Request Token
SystemApi systemVersionGet GET system/version Get Version
TermsApi termsGet GET terms Get Terms
TermsApi termsPost POST terms Create Term
TermsApi termsTermIdDelete DELETE terms/{termId} Delete Term
TermsApi termsTermIdGet GET terms/{termId} Get Term
TermsApi termsTermIdPatch PATCH terms/{termId} Update Term
UsersApi usersGet GET users Get Users
UsersApi usersPost POST users Create User
UsersApi usersUserIdDelete DELETE users/{userId} Delete User
UsersApi usersUserIdGet GET users/{userId} Get User
UsersApi usersUserIdPatch PATCH users/{userId} Update User

Documentation For Models

Documentation For Authorization

basic

  • Type: HTTP basic authentication

bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

The Versions

25/04 2017

dev-master

9999999-dev http://swagger.io

  Sources   Download

proprietary

The Requires

  • php >=5.4
  • ext-curl *
  • ext-json *
  • ext-mbstring *

 

The Development Requires

by Swagger and contributors

api php swagger sdk

25/04 2017

v0.1

0.1.0.0 http://swagger.io

  Sources   Download

proprietary

The Requires

  • php >=5.4
  • ext-curl *
  • ext-json *
  • ext-mbstring *

 

The Development Requires

by Swagger and contributors

api php swagger sdk