Building

Buildings (AKA campuses), are further separations of courses, groups, and users that all belong to the same system.

Table of Contents

Fields

Buildings have the same fields as schools.

Field Name Description Type Required
id Building Id

The internal Schoology ID that identifies the building. This field cannot be used in create operations; only update and read operations.

 string
title Building Title

The name of the building

 string yes
address1 Street address line 1

The first line of the building’s street address

 string
address2 Street address line 2

The second line of the building’s street address

 string
city City

The city where the building is located

 string
state State

The state/province where the building is located

 string
postal_code Postal code

The postal code where the building is located

 string
country Country

The country where the building is located

 string
website Website

The building’s website address

 string
phone Phone number

The building’s phone number

 string
fax Fax number

The building’s fax number

 string
building_code Building Code

The configurable external ID of this building (used for imports and synchronization)

 string
picture_url Profile Picture URL

The full URL of the school’s profile picture

 string

Operations

view

View the buildings for a school

Path

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

Content

none
Return

An list of buildings containing building fields

JSON 
{
    "building": [
        {
            "id": "5171921",
            "title": "Cave High",
            "address1": "800 Underground Ave",
            "address2": "",
            "city": "Petaluma",
            "state": "CA",
            "postal_code": "94952",
            "country": "US",
            "website": "",
            "phone": "234234324",
            "fax": "",
            "building_code": "",
            "picture_url": " ... URL ... "
        },
        {
            "id": "5592393",
            "title": "Example school 2 name",
            "address1": "750 West Road",
            "address2": "",
            "city": "NYC",
            "state": "NY",
            "postal_code": "",
            "country": "",
            "website": "",
            "phone": "",
            "fax": "",
            "building_code": "",
            "picture_url": " ... URL ... "
        },
        {
            "id": "5592395",
            "title": "Example school 2 name",
            "address1": "750 West Road",
            "address2": "",
            "city": "NYC",
            "state": "NY",
            "postal_code": "",
            "country": "",
            "website": "",
            "phone": "",
            "fax": "",
            "building_code": "",
            "picture_url": " ... URL ... "
        }
    ]
}
XML 
<?xml version="1.0" encoding="utf-8" ?>
<result>
        <building>
                <id>5171921</id>
                <title>Cave High</title>
                <address1>800 Underground Ave</address1>
                <address2 />
                <city>Petaluma</city>
                <state>CA</state>
                <postal_code>94952</postal_code>
                <country>US</country>
                <website />
                <phone>234234324</phone>
                <fax />
                <building_code />
                <picture_url> ... URL ... </picture_url>
        </building>
        <building>
                <id>5592393</id>
                <title>Example school 2 name</title>
                <address1>750 West Road</address1>
                <address2 />
                <city>NYC</city>
                <state>NY</state>
                <postal_code />
                <country />
                <website />
                <phone />
                <fax />
                <building_code />
                <picture_url> ... URL ... >
        </building>
        <building>
                <id>5592395</id>
                <title>Example school 2 name</title>
                <address1>750 West Road</address1>
                <address2 />
                <city>NYC</city>
                <state>NY</state>
                <postal_code />
                <country />
                <website />
                <phone />
                <fax />
                <building_code />
                <picture_url> ... URL ... >
        </building>
</result>

Note

For other operations related to buildings (i.e. GET,POST,PUT,DELETE) you can treat buildings like schools and use the available school object endpoints. For example, to make a change to an existing building, you would use PUT /school/[building_id]. For more details, check out the School Object.