School

Fields

Field	Name	Description	Type	Required
`id`	School Id	The internal Schoology ID that identifies the school. This field cannot be used in create operations; only update and read operations.	`string`
`title`	School Title	The name of the school	`string`	yes
`address1`	Street address line 1	The first line of the school's street address	`string`
`address2`	Street address line 2	The second line of the school's street address	`string`
`city`	City	The city where the school is located	`string`
`state`	State	The state/province where the school is located	`string`
`postal_code`	Postal code	The postal code where the school is located	`string`
`country`	Country	The country where the school is located	`string`
`website`	Website	The school's website address	`string`
`phone`	Phone number	The school's phone number	`string`
`fax`	Fax Number	The school's fax number	`string`
`picture_url`	Profile Picture URL	The full URL of the school's profile picture	`string`

Operations

view

View a specified school

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

Content

none

Return

An object containing school fields

JSON

{
    "id": "344232",
    "title": "Hill Valley High School",
    "address1": "700 Western Ave",
    "address2": "",
    "city": "Petaluma",
    "state": "CA",
    "postal_code": "94952",
    "country": "US",
    "website": "",
    "phone": "234234324234",
    "fax": "",
    "building_code": "",
    "picture_url": ".. URL ..."
}

XML

<?xml version="1.0" encoding="utf-8" ?>
<result>
	<id>344232</id>
	<title>Hill Valley High School</title>
	<address1>700 Western Ave</address1>
	<address2 />
	<city>Petaluma</city>
	<state>CA</state>
	<postal_code>94952</postal_code>
	<country>US</country>
	<website />
	<phone>234234324234</phone>
	<fax />
	<building_code />
	<picture_url>.. URL ...</picture_url>
</result>

create

Create a school

Path POST https://api.schoology.com/v1/schools

Content

An object containing school fields

JSON

{
    "title": "Example school name",
    "address1": "750 West Road",
    "city": "New York",
    "state": "New York"
}

XML

<body>
  <title>Example school name</title>
  <address1>750 West Road</address1>
  <city>New York</city>
  <state>New York</state>
</body>

Return

An object containing school fields

create

Create a building in school

Path POST https://api.schoology.com/v1/schools/{school id}/buildings

Content

An object containing school fields

JSON

{
    "title": "Example school name",
    "address1": "750 West Road",
    "city": "New York",
    "state": "New York"
}

XML

<body>
  <title>Example school name</title>
  <address1>750 West Road</address1>
  <city>New York</city>
  <state>New York</state>
</body>

Return

An object containing school fields

JSON

{
    "id": "5592393",
    "title": "Example school 2 name",
    "address1": "750 West Road",
    "address2": null,
    "city": "NYC",
    "state": "NY",
    "postal_code": null,
    "country": null,
    "website": "",
    "phone": null,
    "fax": null,
    "building_code": "",
    "picture_url": "... URL ... ",
    "links": {
        "self": "... URL ... "
    }
}

XML

<?xml version="1.0" encoding="utf-8" ?>
<result>
	<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 ... >
	<links>
		<self>... URL ... >
	</links>
</result>

edit

Edit a specified school

Path PUT https://api.schoology.com/v1/schools/{id}

Content

An object containing school fields

JSON

{
    "title": "Update example school name",
    "address1": "800 East Road"
}

XML

<body>
  <title>Update example school name</title>
  <address1>800 East Road</address1>
</body>

delete

Delete a specified school

Path	`DELETE https://api.schoology.com/v1/schools/{id}`