Resource Collections

Resource Collections are containers for user and group resource templates.

Table of Contents

Resource Collection Objects

Field Name Description Type Required
id Id

The Schoology Id of the collection

 integer
title Title

The title the collection

 string
User Id Uid

The owner of the collection

 integer
is_default Default Collection
  • 0: Regular collection
  • 1: Default home collection
  • 2: Default Downloads collection
 {0,1,2}
shared_users Shared Users

The number of users this collection is shared with

 integer
realm Realm

The realm the collection is in

 string
realm_id Realm ID

The realm id of the collection

 integer
realm_link Realm Link

A URL to the realm that owns the collection

 string

Resource Collections are containers for Resource Templates.

Operations - collections

list

List a users Collections

Path

GET https://api.schoology.com/v1/collections

Content

none
Return

A object containing a list of collection fields

create

Create a Collection

Path

POST https://api.schoology.com/v1/collections

Content

An object containing collection fields

JSON 
{
    "title": "The title the collection"
}
XML 
<body>
  <title>The title the collection</title>
</body>
Return

A object containing a list of collection fields

JSON 
{
    "id": 5825417,
    "title": "New Collection",
    "shared_users": 0,
    "is_default": 0,
    "uid": 48289,
    "links": {
        "self": "http:\/\/..."
    }
}
XML 
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<id>5825417</id>
	<title>New Collection</title>
	<shared_users>0</shared_users>
	<is_default>0</is_default>
	<uid>48289</uid>
	<links>
		<self>http:\/\/...</self>
	</links>
</result>

Operations - collections/[collection_id]

list

Get a single Collection

Path

GET https://api.schoology.com/v1/collections/[collection_id]

Content

none
Return

An object containing collection fields

JSON 
{
    "id": 5825417,
    "title": "New Collection",
    "shared_users": 1,
    "is_default": 0,
    "uid": 48289
}
XML 
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<id>5825417</id>
	<title>New Collection</title>
	<shared_users>1</shared_users>
	<is_default>0</is_default>
	<uid>48289</uid>
</result>

edit

Edit a Collection

Path

PUT https://api.schoology.com/v1/collections/[collection_id]

Content

An object containing collection fields

JSON 
{
    "title": "The updated title"
}
XML 
<body>
  <title>The updated title</title>
</body>
Return

none

delete

Delete a Collection

Path

DELETE https://api.schoology.com/v1/collections/[collection_id]

Content

none
Return

none