Table of Contents
Fields
Field | Name | Description | Type | Required |
---|---|---|---|---|
content_id | Content ID | The ID of the content related to the comment | integer | yes |
uid | User ID | The ID of the user who created the comment | integer | |
comment | Comment | The comment text | string | |
created | Created timestamp | The unix timestamp when the comment was created | integer |
Operations
The operations below are available for the following realms (replace [realm]
with the appropriate realm and ID):
Realm | Path |
---|---|
Course Sections | sections/{id} |
Groups | groups/{id} |
create
Create a comment
This endpoint has changed as of 2/15/15. The existing endpoint is still available but no longer maintained:
POST https://api.schoology.com/v1/album/{id}/content/{content_id}/comments
Path | |
Content | An object containing comment fields JSON XML
|
Return | An object containing comment fields JSON XML
|
list
View a list of comments (paged)
This endpoint has changed as of 2/15/15. The existing endpoint is still available but no longer maintained:
GET https://api.schoology.com/v1/album/{id}/content/{content_id}/comments
Path | |
Content | none |
Return | A collection of comment objects, each one containing comment fields JSON XML
|
view
View a specified comment
This endpoint has changed as of 2/15/15. The existing endpoint is still available but no longer maintained:
GET https://api.schoology.com/v1/album/{id}/content/{content_id}/comments/{comment_id}
Path | |
Content | none |
Return | An object containing comment fields JSON XML
|
delete
Delete a comment (cannot be undone)
This endpoint has changed as of 2/15/15. The existing endpoint is still available but no longer maintained:
DELETE https://api.schoology.com/v1/album/{id}/content/{content_id}/comments/{comment_id}
Path | |
Content | none |
Return | none |