Role

Every user is associated with a role; each role contains a list of permissions that allow users to do certain actions on the system.

Fields

FieldNameDescriptionTypeRequired
title Role Name The title of the role string yes
faculty Faculty Whether or not the role is a faculty roleinteger {0,1} yes

Operations

list

View a list of roles in your school

Path

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

Content

none

Return

A collection of roles.

JSON
{
    "role": [
        {
            "id": "1215",
            "title": "Parent",
            "faculty": 0
            "links": {
                "self": "http:\/\/..."
            }
        },
        {
            "id": "1212",
            "title": "School Admin",
            "faculty": 1
            "links": {
                "self": "http:\/\/..."
            }
        },
        {
            "id": "1214",
            "title": "Student",
            "faculty": 0
            "links": {
                "self": "http:\/\/..."
            }
        },
        {
            "id": "1213",
            "title": "Teacher",
            "faculty": 1
            "links": {
                "self": "http:\/\/..."
            }
        }
    ]
}
XML
<?xml version="1.0" encoding="utf-8" ?>
<result>
    <role>
        <id>1215</id>
        <title>Parent</title>
        <faculty>0</faculty>
        <links>
            <self>http:\/\/...</self>
        </links>
    </role>
    <role>
        <id>1212</id>
        <title>School Admin</title>
        <faculty>1</faculty>
        <links>
            <self>http:\/\/...</self>
        </links>
    </role>
    <role>
        <id>1214</id>
        <title>Student</title>
        <faculty>0</faculty>
        <links>
            <self>http:\/\/...</self>
        </links>
    </role>
    <role>
        <id>1213</id>
        <title>Teacher</title>
        <faculty>1</faculty>
        <links>
            <self>http:\/\/...</self>
        </links>
    </role>
</result>

view

View a specified role

Path

GET https://api.schoology.com/v1/roles/{id}

Content

none

Return

An role object.

JSON
{
    "id": "1213",
    "title": "Teacher",
    "faculty": 1
}
XML
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<id>1213</id>
	<title>Teacher</title>
        <faculty>1</faculty>
</result>