Skip to content

Web Content Packages

Web Content Packages are website files, compressed in .zip format, that can be added to Schoology course sections.

NOTE

Web Content Packages exist in sections.

Fields

FieldNameDescriptionType
idIdThe Schoology id of the web content packagestring
titleTitleThe title of the web packagestring
uidUIDThe id of the user who created the web packageinteger
urlLaunch URLThe URL to launch the web packagestring

GET sections/{section id}/web_packages

View a list of web content packages in a course section

Return A list of web content packages

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&amp;limit=20</self>
	</links>
</result>

GET sections/{section id}/web_packages/{id}

View a specified web content package

Return A web content package

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 sections/{section id}/web_packages/{id}

Delete a web content package (cannot be undone)