Web Content Packages are website files, compressed in .zip format, that can be added to Schoology course sections.
Table of Contents
Web Content Packages are website files, compressed in .zip format, that can be added to Schoology course sections
Fields
Field | Name | Description | Type | Required |
id | Id | The Schoology \ id of the web content package | string | |
title | Title | The title of the web package | string | |
url | uid | The id of the user who created the web package | integer | |
url | Launch URL | The URL to launch the web package | string | |
Operations
list
View a list of web content packages in a course section
Path | GET https://api.schoology.com/v1/sections/{section_id}/web_packages |
Content | none |
Return | A collection of web content packages, each one containing web content package fields JSON {
"web": [
{
"id": 123456,
"title": "webpackage.zip",
"uid": 1864351,
"url": "https:\/\/schoology.com\/web\/123456\/view"
},
{
"id": 7891011,
"title": "webpackage2.zip",
"uid": 1864351,
"url": "https:\/\/schoology.com\/web\/7891011\/view"
}
],
"total": 2,
"links": {
"self": "http:\/\/schoology.com\/v1\/sections\/9560267\/web_packages?start=0&limit=20"
}
} XML <?xml version="1.0" encoding="utf-8" ?>
<result>
<web>
<id>123456</id>
<title>webpackage.zip</title>
<uid>1864351</uid>
<url>https://schoology.com/web/123456/view</url>
</web>
<web>
<id>7891011</id>
<title>webpackage2.zip</title>
<uid>1864351</uid>
<url>https://schoology.com/web/7891011/view</url>
</web>
<total>2</total>
<links>
<self>http://schoology.com/v1/sections/9560267/web_packages?start=0&limit=20</self>
</links>
</result>
|
view
View a specified web content package.:
Path | GET https://api.schoology.com/v1/sections/{section_id}/web_packages/{id} |
Content | none |
Return | An object containing web content package fields JSON {
"id": 123456,
"title": "webpackage.zip",
"uid": 1864351,
"url": "https:\/\/schoology.com\/web\/123456\/view"
} XML <?xml version="1.0" encoding="utf-8" ?>
<result>
<id>123456</id>
<title>webpackage.zip</title>
<uid>1864351</uid>
<url>https://schoology.com/web/123456/view</url>
</result>
|
delete
Delete a web content package (cannot be undone)
Path | DELETE https://api.schoology.com/v1/sections/{section_id}/web_packages/{id} |
Content | none |
Return | none |