Skip to content
This repository has been archived by the owner on Jan 31, 2020. It is now read-only.

Latest commit

 

History

History
235 lines (167 loc) · 18.2 KB

CourseGroupUsersApi.md

File metadata and controls

235 lines (167 loc) · 18.2 KB
Raw

BlackboardRest\CourseGroupUsersApi

All URIs are relative to https://localhost/learn/api/public/v1/

Method HTTP request Description
coursesCourseIdGroupsGroupIdUsersGet GET courses/{courseId}/groups/{groupId}/users Get Group Memberships
coursesCourseIdGroupsGroupIdUsersUserIdDelete DELETE courses/{courseId}/groups/{groupId}/users/{userId} Delete Group Membership
coursesCourseIdGroupsGroupIdUsersUserIdGet GET courses/{courseId}/groups/{groupId}/users/{userId} Get Group Membership
coursesCourseIdGroupsGroupIdUsersUserIdPut PUT courses/{courseId}/groups/{groupId}/users/{userId} Put Group Membership

coursesCourseIdGroupsGroupIdUsersGet

\BlackboardRest\Model\InlineResponse20013 coursesCourseIdGroupsGroupIdUsersGet($group_id, $course_id, $offset, $limit, $fields)

Get Group Memberships

Returns a list of group memberships objects for the specified group. Callers not enrolled in the group must have at least one of the following entitlements: - course.group.VIEW Since: 3100.6.0

Example

<?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\CourseGroupUsersApi();
$group_id = "group_id_example"; // string | The group ID.  This may be the primary ID, or any of the secondary IDs prefixed with the ID type.    | ID type    | Example                               |  |------------|---------------------------------------|  | primary    | _123_1                                |  | externalId | externalId:breakfastClub              |
$course_id = "course_id_example"; // string | The course or organization ID.  This may be the primary ID, or any of the secondary IDs prefixed with the ID type.    | ID type    | Example                               |  |------------|---------------------------------------|  | primary    | _123_1                                |  | externalId | externalId:math101                    |  | courseId   | courseId:math101                      |  | uuid       | uuid:915c7567d76d444abf1eed56aad3beb5 |
$offset = 56; // int | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
$limit = 56; // int | The maximum number of results to be returned. There may be less if the query returned less than the maximum.
$fields = "fields_example"; // string | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

try {
    $result = $api_instance->coursesCourseIdGroupsGroupIdUsersGet($group_id, $course_id, $offset, $limit, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CourseGroupUsersApi->coursesCourseIdGroupsGroupIdUsersGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
group_id string The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. ID type
course_id string The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. ID type
offset int The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. [optional]
limit int The maximum number of results to be returned. There may be less if the query returned less than the maximum. [optional]
fields string A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. [optional]

Return type

\BlackboardRest\Model\InlineResponse20013

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

coursesCourseIdGroupsGroupIdUsersUserIdDelete

coursesCourseIdGroupsGroupIdUsersUserIdDelete($course_id, $group_id, $user_id)

Delete Group Membership

Deletes a group from the specified course. Required entitlements: - course.group.MODIFY Since: 3100.6.0

Example

<?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\CourseGroupUsersApi();
$course_id = "course_id_example"; // string | The course or organization ID.  This may be the primary ID, or any of the secondary IDs prefixed with the ID type.    | ID type    | Example                               |  |------------|---------------------------------------|  | primary    | _123_1                                |  | externalId | externalId:math101                    |  | courseId   | courseId:math101                      |  | uuid       | uuid:915c7567d76d444abf1eed56aad3beb5 |
$group_id = "group_id_example"; // string | The group ID.  This may be the primary ID, or any of the secondary IDs prefixed with the ID type.    | ID type    | Example                               |  |------------|---------------------------------------|  | primary    | _123_1                                |  | externalId | externalId:breakfastClub              |
$user_id = "user_id_example"; // string | The user ID.  This may be the primary ID, or any of the secondary IDs prefixed with the ID type.    | ID type    | Example                               |  |------------|---------------------------------------|  | primary    | _123_1                                |  | externalId | externalId:jsmith                     |  | userName   | userName:jsmith                       |  | uuid       | uuid:915c7567d76d444abf1eed56aad3beb5 |

try {
    $api_instance->coursesCourseIdGroupsGroupIdUsersUserIdDelete($course_id, $group_id, $user_id);
} catch (Exception $e) {
    echo 'Exception when calling CourseGroupUsersApi->coursesCourseIdGroupsGroupIdUsersUserIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
course_id string The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. ID type
group_id string The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. ID type
user_id string The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. ID type

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

coursesCourseIdGroupsGroupIdUsersUserIdGet

\BlackboardRest\Model\GroupMembership coursesCourseIdGroupsGroupIdUsersUserIdGet($course_id, $group_id, $user_id, $fields)

Get Group Membership

Loads a group membership in the specified group. Callers not enrolled in the group must have at least one of the following entitlements: - course.group.VIEW Since: 3100.6.0

Example

<?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\CourseGroupUsersApi();
$course_id = "course_id_example"; // string | The course or organization ID.  This may be the primary ID, or any of the secondary IDs prefixed with the ID type.    | ID type    | Example                               |  |------------|---------------------------------------|  | primary    | _123_1                                |  | externalId | externalId:math101                    |  | courseId   | courseId:math101                      |  | uuid       | uuid:915c7567d76d444abf1eed56aad3beb5 |
$group_id = "group_id_example"; // string | The group ID.  This may be the primary ID, or any of the secondary IDs prefixed with the ID type.    | ID type    | Example                               |  |------------|---------------------------------------|  | primary    | _123_1                                |  | externalId | externalId:breakfastClub              |
$user_id = "user_id_example"; // string | The user ID.  This may be the primary ID, or any of the secondary IDs prefixed with the ID type.    | ID type    | Example                               |  |------------|---------------------------------------|  | primary    | _123_1                                |  | externalId | externalId:jsmith                     |  | userName   | userName:jsmith                       |  | uuid       | uuid:915c7567d76d444abf1eed56aad3beb5 |
$fields = "fields_example"; // string | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

try {
    $result = $api_instance->coursesCourseIdGroupsGroupIdUsersUserIdGet($course_id, $group_id, $user_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CourseGroupUsersApi->coursesCourseIdGroupsGroupIdUsersUserIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
course_id string The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. ID type
group_id string The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. ID type
user_id string The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. ID type
fields string A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. [optional]

Return type

\BlackboardRest\Model\GroupMembership

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

coursesCourseIdGroupsGroupIdUsersUserIdPut

\BlackboardRest\Model\GroupMembership coursesCourseIdGroupsGroupIdUsersUserIdPut($course_id, $group_id, $user_id, $fields)

Put Group Membership

Creates a group membership in the specified group. Minimal entitlements required: - course.group.MODIFY Since: 3100.6.0

Example

<?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\CourseGroupUsersApi();
$course_id = "course_id_example"; // string | The course or organization ID.  This may be the primary ID, or any of the secondary IDs prefixed with the ID type.    | ID type    | Example                               |  |------------|---------------------------------------|  | primary    | _123_1                                |  | externalId | externalId:math101                    |  | courseId   | courseId:math101                      |  | uuid       | uuid:915c7567d76d444abf1eed56aad3beb5 |
$group_id = "group_id_example"; // string | The group ID.  This may be the primary ID, or any of the secondary IDs prefixed with the ID type.    | ID type    | Example                               |  |------------|---------------------------------------|  | primary    | _123_1                                |  | externalId | externalId:breakfastClub              |
$user_id = "user_id_example"; // string | The user ID.  This may be the primary ID, or any of the secondary IDs prefixed with the ID type.    | ID type    | Example                               |  |------------|---------------------------------------|  | primary    | _123_1                                |  | externalId | externalId:jsmith                     |  | userName   | userName:jsmith                       |  | uuid       | uuid:915c7567d76d444abf1eed56aad3beb5 |
$fields = "fields_example"; // string | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

try {
    $result = $api_instance->coursesCourseIdGroupsGroupIdUsersUserIdPut($course_id, $group_id, $user_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CourseGroupUsersApi->coursesCourseIdGroupsGroupIdUsersUserIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
course_id string The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. ID type
group_id string The group ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. ID type
user_id string The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. ID type
fields string A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. [optional]

Return type

\BlackboardRest\Model\GroupMembership

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]