### Multi-get Request Body Example (XML)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/multi-get

This example demonstrates the structure of a Multi-get request body in XML format. Each <request> tag contains a URL for an individual GET request.

```xml
 <?xml version="1.0" encoding="utf-8" ?>
 <requests>
   <request>/v1/users/265</request>
   <request>/v1/users/265/sections</request>
   <request>/v1/sections/2354/assignments</request>
 </requests>

```

--------------------------------

### Subscription API Return Example

Source: https://developers.schoology.com/api-documentation/rest-api-triggers-v1

This is an example of the return object from the subscription API. It includes the status of each subscription action, with messages for any errors encountered.

```json
{
  "subscription": [
    {
      "item": {
        "target_id": 373221,
        "trigger": "grades",
        "version": "v1",
        "subscribed": 1,
        "target_url": "http:\/\/school.schoology.com\/trigger",
        "include_object": "1"
      },
      "status": 200
    },
    {
      "item": {
        "target_id": 373221,
        "target_url": null,
        "trigger": "attendancesdf",
        "subscribed": 0,
        "version": null,
        "include_object": null
      },
      "message": "The trigger with name attendancesdf does not exist",
      "status": 400
    }
  ]
}
```

--------------------------------

### Multi-get Request Example

Source: https://developers.schoology.com/api-documentation/rest-api-v1/multi-get

An example of a Multi-get request body in text/xml format, demonstrating how to structure multiple GET requests within a single POST call.

```APIDOC
## Multi-get

### Description
Make multiple GET calls with a single POST call and receive each response body in full in a single compiled response.

### Method
POST

### Endpoint
/v1/multi-get

### Request Body
- **requests** (xml) - Required - A list of URLs to be fetched.

### Request Example
```xml
<?xml version="1.0" encoding="utf-8" ?>
<requests>
  <request>/v1/users/265</request>
  <request>/v1/users/265/sections</request>
  <request>/v1/sections/2354/assignments</request>
</requests>
```

### Note
There is a request limit of 50 URLs when making a multi-GET call. Only the first 50 URLs are returned for calls with more than 50 URLs.
```

--------------------------------

### Example Search URI

Source: https://developers.schoology.com/api-documentation/rest-api-v1/search

Construct a URI to search for users with specific keywords. Searches are case-insensitive.

```http
/search?keywords=avilo&type=user
```

--------------------------------

### JSON Response for Viewing a Course

Source: https://developers.schoology.com/api-documentation/rest-api-v1/course

Example JSON response for a single course, detailing its properties.

```JSON
{
    "id": 1407691,
    "title": "Time Travel",
    "course_code": "CC106",
    "department": "",
    "description": "",
    "credits": 0,
    "subject_area": 0,
    "grade_level_range_start": 12,
    "grade_level_range_end": 14,
    "synced": 1,
    "building_id": "344232"
}
```

--------------------------------

### XML Response for Viewing a Course

Source: https://developers.schoology.com/api-documentation/rest-api-v1/course

Example XML response for a single course, detailing its properties.

```XML
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<id>1407691</id>
	<title>Time Travel</title>
	<course_code>CC106</course_code>
	<department />
	<description />
	<credits>0</credits>
	<subject_area>0</subject_area>
	<grade_level_range_start>12</grade_level_range_start>
	<grade_level_range_end>14</grade_level_range_end>
	<synced>1</synced>
	<building_id>344232</building_id>
</result>
```

--------------------------------

### Create User Response Body (XML)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/user

This is an example of the XML response received after successfully creating a user.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
    <uid>1710711</uid>
    <id>1710711</id>
    <school_id>344232</school_id>
    <synced>0</synced>
    <school_uid>test123</school_uid>
    <building_id>344232</building_id>
    <additional_buildings>456</additional_buildings>
    <name_title />
    <name_title_show>0</name_title_show>
    <name_first>John</name_first>
    <name_first_preferred />
    <name_middle />
    <name_middle_show>0</name_middle_show>
    <name_last>Smith</name_last>
    <name_display>John Smith</name_display>
    <username />
    <primary_email>test123@myclass.com</primary_email>
    <picture_url> ... URL .. </picture_url>
    <gender />
    <position />
    <grad_year />
    <password />
    <role_id>1214</role_id>
    <tz_offset>-4</tz_offset>
    <tz_name>America/New_York</tz_name>
    <parents />
    <child_uids />
    <send_message>1</send_message>
    <links>
        <self> ... URL ... </self>
    </links>
</result>
```

--------------------------------

### Create Course Response Body (XML)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/course

This is an example of the XML response received after successfully creating a course.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<id>5614879</id>
	<title>REST API Course</title>
	<course_code>RAPI101</course_code>
	<department>Computer Science</department>
	<description>discuss REST API</description>
	<credits>0</credits>
	<subject_area>0</subject_area>
	<grade_level_range_start>0</grade_level_range_start>
	<grade_level_range_end>0</grade_level_range_end>
	<synced>0</synced>
	<building_id>344232</building_id>
	<links>
		<self>http:\/...\/v1\/courses\/5614879</self>
	</links>
</result>
```

--------------------------------

### Create Course Response Body (JSON)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/course

This is an example of the JSON response received after successfully creating a course.

```json
{
    "id": 5614879,
    "title": "REST API Course",
    "course_code": "RAPI101",
    "department": "Computer Science",
    "description": "discuss REST API",
    "credits": 0,
    "subject_area": 0,
    "grade_level_range_start": 0,
    "grade_level_range_end": 0,
    "synced": 0,
    "building_id": "344232",
    "links": {
        "self": "http:\/\/...\/v1\/courses\/5614879"
    }
}
```

--------------------------------

### Create User Response Body (JSON)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/user

This is an example of the JSON response received after successfully creating a user.

```json
{
    "uid": "1710709",
    "id": 1710709,
    "school_id": 344232,
    "synced": 0,
    "school_uid": "test123",
    "building_id": 344232,
    "additional_buildings":"456"
    "name_title": "",
    "name_title_show": 0,
    "name_first": "John",
    "name_first_preferred": "",
    "name_middle": "",
    "name_middle_show": 0,
    "name_last": "Smith",
    "name_display": "John Smith",
    "username": "",
    "primary_email": "test123@myclass.com",
    "picture_url": " ... URL .. ",
    "gender": null,
    "position": null,
    "grad_year": "",
    "password": "",
    "role_id": 1214,
    "tz_offset": -4,
    "tz_name": "America\/New_York",
    "parents": null,
    "child_uids": null,
    "send_message": 1,
    "links": {
        "self": " ... URL ... "
    }
}
```

--------------------------------

### Created Collection Response JSON

Source: https://developers.schoology.com/api-documentation/rest-api-v1/library-resources

Example JSON response after successfully creating a collection.

```json
{
    "id": 5825417,
    "title": "New Collection",
    "shared_users": 0,
    "is_default": 0,
    "uid": 48289,
    "links": {
        "self": "http:\/\/"
    }
}
```

--------------------------------

### Create Assignment Response (XML)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/assignment

This is an example of the XML response received after successfully creating an assignment.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
  <id>5699937</id>
  <title>this is a test assignment</title>
  <description>extra credit assignment</description>
  <due>2014-09-25 11:30:00</due>
  <grading_scale>0</grading_scale>
  <grading_period>13011</grading_period>
  <grading_category>0</grading_category>
  <max_points>100</max_points>
  <factor>1</factor>
  <is_final>0</is_final>
  <show_comments>0</show_comments>
  <grade_stats>0</grade_stats>
  <allow_dropbox>1</allow_dropbox>
  <allow_discussion>1</allow_discussion>
  <published>1</published>
  <type>assignment</type>
  <grade_item_id>5699937</grade_item_id>
  <available>1</available>
  <completed>0</completed>
  <dropbox_locked>0</dropbox_locked>
  <grading_scale_type>0</grading_scale_type>
  <show_rubric></show_rubric>
  <count_in_grade>0</count_in_grade>
  <collected_only>0</collected_only>
  <auto_publish_grades>0</auto_publish_grades>
  <num_assignees>4</num_assignees>
  <assignees>12345</assignees>
  <assignees>4567</assignees>
  <assignees>888</assignees>
  <assignees>999</assignees>
  <grading_group_ids>534</grading_group_ids>
  <links>
    <self>http://.../assignments/5699937</self>
  </links>
</result>
```

--------------------------------

### Created Collection Response XML

Source: https://developers.schoology.com/api-documentation/rest-api-v1/library-resources

Example XML response after successfully creating a collection.

```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>
```

--------------------------------

### Create Assignment Response (JSON)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/assignment

This is an example of the JSON response received after successfully creating an assignment.

```json
{
  "id": 5699937,
  "title": "this is a test assignment",
  "description": "extra credit assignment",
  "due": "2014-09-25 11:30:00",
  "grading_scale": "0",
  "grading_period": "13011",
  "grading_category": "0",
  "max_points": "100",
  "factor": "1",
  "is_final": "0",
  "show_comments": "0",
  "grade_stats": "0",
  "allow_dropbox": "1",
  "allow_discussion": "1",
  "published": 1,
  "type": "assignment",
  "grade_item_id": 5699937,
  "available": 1,
  "completed": 0,
  "dropbox_locked": 0,
  "grading_scale_type": 0,
  "show_rubric": false,
  "count_in_grade": 0,
  "collected_only": 0,
  "auto_publish_grades": 0,
  "num_assignees": 4,
  "assignees": [
    12345,
    4567,
    888,
    999
  ],
  "grading_group_ids": [
    534
  ],
  "links": {
    "self": "http:\/\/...\/assignments\/5699937"
  }
}
```

--------------------------------

### Created Media Album Response (XML)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/media-album

This is an example of the XML response received after successfully creating a media album.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<id>5692169</id>
	<title>My media album</title>
	<description>This is a media album</description>
	<setting_comments>1</setting_comments>
	<setting_member_post>0</setting_member_post>
	<photo_count>0</photo_count>
	<video_count>0</video_count>
	<audio_count>0</audio_count>
	<created>1388170669</created>
	<available>1</available>
	<completed>0</completed>
	<links>
		<self>http://.../v1/album/5692169</self>
	</links>
</result>
```

--------------------------------

### Created Media Album Response (JSON)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/media-album

This is an example of the JSON response received after successfully creating a media album.

```json
{
    "id": 5692169,
    "title": "My media album",
    "description": "This is a media album",
    "setting_comments": 1,
    "setting_member_post": 0,
    "photo_count": 0,
    "video_count": 0,
    "audio_count": 0,
    "created": 1388170669,
    "available": 1,
    "completed": 0,
    "links": {
        "self": "http:\/\/...\/v1\/album\/5692169"
    }
}
```

--------------------------------

### Create Event Response Body (XML)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/event

This is an example of the XML response received after successfully creating an event.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
  <id>5615013</id>
  <title>My Course Event</title>
  <description>My course event description</description>
  <start>2014-12-28 11:30:00</start>
  <has_end>1</has_end>
  <end>2014-12-28 13:30:00</end>
  <all_day>0</all_day>
  <editable>1</editable>
  <rsvp>0</rsvp>
  <comments_enabled>1</comments_enabled>
  <type>event</type>
  <realm>section</realm>
  <section_id>3719526</section_id>
  <links>
    <self>http:\/\/...\/events\/5615013</self>
  </links>
</result>
```

--------------------------------

### Create Event Response Body (JSON)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/event

This is an example of the JSON response received after successfully creating an event.

```json
{
    "id": 5615013,
    "title": "My Course Event",
    "description": "My course event description",
    "start": "2014-12-28 11:30:00",
    "has_end": 1,
    "end": "2014-12-28 13:30:00",
    "all_day": 0,
    "editable": 1,
    "rsvp": 0,
    "comments_enabled": 1,
    "type": "event",
    "realm": "section",
    "section_id": 3719526,
    "links": {
        "self": "http:\/\/...\/3719526\/events\/5615013"
    }
}
```

--------------------------------

### Create Message XML Response

Source: https://developers.schoology.com/api-documentation/rest-api-v1/private-messaging

Example XML response after successfully creating a message. Includes the new message's ID and details.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
    <id>14065</id>
    <subject>This is subject</subject>
    <recipient_ids>48289</recipient_ids>
    <last_updated>1389716445</last_updated>
    <mid />
    <author_id>45552</author_id>
    <message_status />
    <message>This is message</message>
</result>
```

--------------------------------

### Get Collection Response XML

Source: https://developers.schoology.com/api-documentation/rest-api-v1/library-resources

Example XML response when retrieving a single collection.

```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>
```

--------------------------------

### Get Collection Response JSON

Source: https://developers.schoology.com/api-documentation/rest-api-v1/library-resources

Example JSON response when retrieving a single collection.

```json
{
    "id": 5825417,
    "title": "New Collection",
    "shared_users": 1,
    "is_default": 0,
    "uid": 48289
}
```

--------------------------------

### Multi-get

Source: https://developers.schoology.com/api-documentation/rest-api-v1

Make multiple GET calls with a single POST call.

```APIDOC
## POST multiget

### Description
Make multiple GET calls with a single POST call and receive each response body in full in a single compiled response.

### Method
POST

### Endpoint
/multiget
```

--------------------------------

### Get User Grades

Source: https://developers.schoology.com/api-documentation/rest-api-v1/user-grades

Retrieves a list of grades for a specific user.

```APIDOC
## GET /v1/users/{user_id}/grades

### Description
Retrieves a list of grades for a specific user.

### Method
GET

### Endpoint
/v1/users/{user_id}/grades

### Parameters
#### Path Parameters
- **user_id** (integer) - Required - The ID of the user whose grades are to be retrieved.

### Response
#### Success Response (200)
- **grading_category** (object) - A list of grading categories, each containing an ID and title.
  - **id** (integer) - The ID of the grading category.
  - **title** (string) - The title of the grading category.

#### Response Example
```json
{
  "grading_category": [
    {
      "id": 123,
      "title": "Homework"
    },
    {
      "id": 4341,
      "title": "xtra points"
    }
  ],
  "links": {
    "self": "http://.../v1/users/48289/grades"
  }
}
```
```

--------------------------------

### Get Collection

Source: https://developers.schoology.com/api-documentation/rest-api-v1/library-resources

Retrieves details for a specific resource collection by its ID.

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

### Description
Get a single Collection

### Method
GET

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

### Parameters
#### Path Parameters
- **collection_id** (integer) - Required - The ID of the collection to retrieve.

### Response
#### Success Response (200)
- An object containing collection fields

#### Response Example
```json
{
    "id": 5825417,
    "title": "New Collection",
    "shared_users": 1,
    "is_default": 0,
    "uid": 48289
}
```
```

--------------------------------

### JSON Response for Listing Courses

Source: https://developers.schoology.com/api-documentation/rest-api-v1/course

Example JSON response when listing courses, showing course details, total count, and pagination links.

```JSON
{
    "course": [
        {
            "id": 1407691,
            "title": "Time Travel",
            "course_code": "CC106",
            "department": "",
            "description": "",
            "credits": 0,
            "subject_area": 0,
            "grade_level_range_start": 12,
            "grade_level_range_end": 14,
            "synced": 1,
            "building_id": "344232"
        },
        {
            "id": 5410559,
            "title": "FS1 Course",
            "course_code": "",
            "department": "",
            "description": "",
            "credits": 0,
            "subject_area": 2,
            "grade_level_range_start": 6,
            "grade_level_range_end": 0,
            "synced": 0,
            "building_id": "5171921"
        },
        {
            "id": 5614935,
            "title": "Bulk Course 1",
            "course_code": "BC101",
            "department": "Administration",
            "description": "discuss bulk operations",
            "credits": 0,
            "subject_area": 0,
            "grade_level_range_start": 0,
            "grade_level_range_end": 0,
            "synced": 0,
            "building_id": "344232"
        }
    ],
    "total": "3",
    "links": {
        "self": "http:\/\/...\/v1\/courses?start=0&limit=20"
    }
}
```

--------------------------------

### XML Response for Listing Courses

Source: https://developers.schoology.com/api-documentation/rest-api-v1/course

Example XML response when listing courses, showing course details, total count, and pagination links.

```XML
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<course>
		<id>1407691</id>
		<title>Time Travel</title>
		<course_code>CC106</course_code>
		<department />
		<description />
		<credits>0</credits>
		<subject_area>0</subject_area>
		<grade_level_range_start>12</grade_level_range_start>
		<grade_level_range_end>14</grade_level_range_end>
		<synced>1</synced>
		<building_id>344232</building_id>
	</course>
	<course>
		<id>5410559</id>
		<title>FS1 Course</title>
		<course_code />
		<department />
		<description />
		<credits>0</credits>
		<subject_area>2</subject_area>
		<grade_level_range_start>6</grade_level_range_start>
		<grade_level_range_end>0</grade_level_range_end>
		<synced>0</synced>
		<building_id>5171921</building_id>
	</course>
	<course>
		<id>5614935</id>
		<title>Bulk Course 1</title>
		<course_code>BC101</course_code>
		<department>Administration</department>
		<description>discuss bulk operations</description>
		<credits>0</credits>
		<subject_area>0</subject_area>
		<grade_level_range_start>0</grade_level_range_start>
		<grade_level_range_end>0</grade_level_range_end>
		<synced>0</synced>
		<building_id>344232</building_id>
	</course>
	<total>3</total>
	<links>
		<self>http:\/\/...\/v1\/courses?start=0&amp;limit=20</self>
	</links>
</result>
```

--------------------------------

### View Assignment XML Response

Source: https://developers.schoology.com/api-documentation/rest-api-v1/assignment

Example XML response when viewing assignment details.

```XML
<?xml version="1.0" encoding="utf-8" ?>
<result>
  <id>5699937</id>
  <title>this is a test assignment</title>
  <description>extra credit assignment</description>
  <due>2014-09-25 11:30:00</due>
  <grading_scale>0</grading_scale>
  <grading_period>13011</grading_period>
  <grading_category>0</grading_category>
  <max_points>100</max_points>
  <factor>1</factor>
  <is_final>0</is_final>
  <show_comments>0</show_comments>
  <grade_stats>0</grade_stats>
  <allow_dropbox>1</allow_dropbox>
  <allow_discussion>1</allow_discussion>
  <published>1</published>
  <type>assignment</type>
  <grade_item_id>5699937</grade_item_id>
  <available>1</available>
  <completed>0</completed>
  <dropbox_locked>0</dropbox_locked>
  <grading_scale_type>0</grading_scale_type>
  <show_rubric></show_rubric>
  <count_in_grade>1</count_in_grade>
  <collected_only>0</collected_only>
  <auto_publish_grades>1</auto_publish_grades>
  <num_assignees>0</num_assignees>
  <assignees />
  <completion_status />
</result>
```

--------------------------------

### Enrollment Creation Response (JSON)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/enrollment

Example JSON response after a successful bulk enrollment creation. It includes the status code, ID, UID, and location for each created enrollment.

```json
{
    "enrollments": {
        "enrollment": [
            {
                "response_code": 200,
                "location": "http:\/\/...\/54302505",
                "uid": 248101,
                "id": "54302505"
            },
            {
                "response_code": 200,
                "location": "http:\/\/...\/44783161",
                "uid": 48489,
                "id": "44783161"
            }
        ]
    }
}
```

--------------------------------

### View Assignment JSON Response

Source: https://developers.schoology.com/api-documentation/rest-api-v1/assignment

Example JSON response when viewing assignment details.

```JSON
{
  "id": 5699937,
  "title": "this is a test assignment",
  "description": "extra credit assignment",
  "due": "2014-09-25 11:30:00",
  "grading_scale": "0",
  "grading_period": "13011",
  "grading_category": "0",
  "max_points": "100",
  "factor": "1",
  "is_final": "0",
  "show_comments": "0",
  "grade_stats": "0",
  "allow_dropbox": "1",
  "allow_discussion": "1",
  "published": 1,
  "type": "assignment",
  "grade_item_id": 5699937,
  "available": 1,
  "completed": 0,
  "dropbox_locked": 0,
  "grading_scale_type": 0,
  "show_rubric": false,
  "count_in_grade": 1,
  "collected_only": 0,
  "auto_publish_grades": 1,
  "num_assignees": 0,
  "assignees": [

  ],
  "completion_status": ""
}
```

--------------------------------

### Create Enrollment using Access Code (JSON)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/enrollment

Create an enrollment by providing an access code. This is useful for self-enrollment scenarios. The realm and ID must be correctly specified in the URL.

```json
{
    "access_code": "VCVKF-4MJG9"
}
```

--------------------------------

### Assignment Response XML

Source: https://developers.schoology.com/api-documentation/rest-api-v1/assignment

Example XML structure for a single assignment object returned by the API.

```XML
<?xml version="1.0" encoding="utf-8" ?>
<result>
  <assignment>
    <id>5699937</id>
    <title>this is a test assignment</title>
    <description>extra credit assignment</description>
    <due>2014-09-25 11:30:00</due>
    <grading_scale>0</grading_scale>
    <grading_period>13011</grading_period>
    <grading_category>0</grading_category>
    <max_points>100</max_points>
    <factor>1</factor>
    <is_final>0</is_final>
    <show_comments>0</show_comments>
    <grade_stats>0</grade_stats>
    <allow_dropbox>1</allow_dropbox>
    <allow_discussion>1</allow_discussion>
    <published>1</published>
    <type>assignment</type>
    <grade_item_id>5699937</grade_item_id>
    <available>1</available>
    <completed>0</completed>
    <dropbox_locked>0</dropbox_locked>
    <grading_scale_type>0</grading_scale_type>
    <show_rubric></show_rubric>
    <count_in_grade>1</count_in_grade>
    <collected_only>0</collected_only>
    <auto_publish_grades>1</auto_publish_grades>
    <num_assignees>4</num_assignees>
    <assignees>12345</assignees>
    <assignees>4567</assignees>
    <assignees>888</assignees>
    <assignees>999</assignees>
    <grading_group_ids>534</grading_group_ids>
    <completion_status />
    <links>
      <self>http://.../assignments/5699937</self>
    </links>
  </assignment>
  <total>1</total>
  <links>
    <self>http://.../assignments?start=0&limit=20</self>
  </links>
</result>
```

--------------------------------

### Assignment Response JSON

Source: https://developers.schoology.com/api-documentation/rest-api-v1/assignment

Example JSON structure for a single assignment object returned by the API.

```JSON
{
  "assignment": [
    {
      "id": 5699937,
      "title": "this is a test assignment",
      "description": "extra credit assignment",
      "due": "2014-09-25 11:30:00",
      "grading_scale": "0",
      "grading_period": "13011",
      "grading_category": "0",
      "max_points": "100",
      "factor": "1",
      "is_final": "0",
      "show_comments": "0",
      "grade_stats": "0",
      "allow_dropbox": "1",
      "allow_discussion": "1",
      "published": 1,
      "type": "assignment",
      "grade_item_id": 5699937,
      "available": 1,
      "completed": 0,
      "dropbox_locked": 0,
      "grading_scale_type": 0,
      "show_rubric": false,
      "count_in_grade": 1,
      "collected_only": 0,
      "auto_publish_grades": 1,
      "num_assignees": 4,
      "assignees": [
        12345,
        4567,
        888,
        999
      ],
      "grading_group_ids": [
        534
      ],
      "completion_status": "",
      "links": {
        "self": "http://.../assignments/5699937"
      }
    }
  ],
  "total": 1,
  "links": {
    "self": "http://.../assignments?start=0&limit=20"
  }
}
```

--------------------------------

### Create Enrollment (XML)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/enrollment

Use this endpoint to create a new enrollment by providing user details in XML format. Ensure the realm and ID are correctly specified in the URL.

```xml
<body>
  <uid>2461632</uid>
  <admin>0</admin>
  <status>1</status>
</body>
```

--------------------------------

### Create Enrollment using Access Code (XML)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/enrollment

Create an enrollment by providing an access code in XML format. This is useful for self-enrollment scenarios. The realm and ID must be correctly specified in the URL.

```xml
<body>
  <access_code>VCVKF-4MJG9</access_code>
</body>
```

--------------------------------

### Create Course Section Response (JSON)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/course-section

This is an example of a successful response when creating a course section. It includes the new section's ID and other details.

```json
{
    "id": "5614973",
    "course_id": "1407691",
    "school_id": "344232",
    "access_code": "C2BGQ-F3TCV",
    "section_title": "Section API",
    "section_code": "",
    "section_school_code": "SA1",
    "synced": null,
    "active": 1,
    "description": "discuss REST API",
    "grading_periods": [
        13011
    ],
    "profile_url": "http:\/\/......\/course-default.gif",
    "location": "",
    "meeting_days": [
        ""
    ],
    "start_time": null,
    "end_time": null,
    "options": {
        "weighted_grading_categories": null,
        "upload_documents": null,
        "create_discussion": null,
        "member_post": null,
        "member_post_comment": null,
        "content_index_visibility": [

        ]
    },
    "links": {
        "self": "http:\/\/...\/v1\/sections\/5614973"
    }
}
```

--------------------------------

### Assignment Comment Response (XML)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/assignment-comments

This is an example of the XML response when creating or retrieving an assignment comment.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
    <id>3570325</id>
    <uid>45552</uid>
    <comment>this is a test comment</comment>
    <created>1388422820</created>
    <parent_id>0</parent_id>
    <status>1</status>
    <likes>0</likes>
    <user_like_action></user_like_action>
    <links>
        <self>http:\/\/...\/comments\/</self>
    </links>
</result>
```

--------------------------------

### Bulk Create Enrollments in Single Realm (XML)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/enrollment

XML format for creating multiple enrollments within a single realm. Ensure the 'enrollments' and 'enrollment' tags are used correctly.

```xml
<body>
  <enrollments>
    <enrollment>
      <uid>2461632</uid>
      <admin>0</admin>
      <status>1</status>
    </enrollment>
    <enrollment>
      <uid>23453322</uid>
      <admin>0</admin>
      <status>1</status>
    </enrollment>
  </enrollments>
</body>
```

--------------------------------

### Assignment Comment Response (JSON)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/assignment-comments

This is an example of the JSON response when creating or retrieving an assignment comment.

```json
{
    "id": 3570325,
    "uid": 45552,
    "comment": "this is a test comment",
    "created": 1388422820,
    "parent_id": 0,
    "status": 1,
    "likes": 0,
    "user_like_action": false,
    "links": {
        "self": "http:\/\/...\/comments\/"
    }
}
```

--------------------------------

### Create User

Source: https://developers.schoology.com/api-documentation/rest-api-v1/user

Creates a new user in your school. Requires a JSON object with user details.

```APIDOC
## POST https://api.schoology.com/v1/users

### Description
Create a user in your school.

### Method
POST

### Endpoint
https://api.schoology.com/v1/users

### Request Body
- **school_uid** (string) - Required - The unique identifier for the school.
- **name_first** (string) - Required - The first name of the user.
- **name_last** (string) - Required - The last name of the user.
- **primary_email** (string) - Required - The primary email address of the user.
- **role_id** (string) - Required - The ID of the user's role.
- **additional_buildings** (string) - Optional - Additional building identifiers for the user.

### Request Example
```json
{
    "school_uid": "test123",
    "name_first": "John",
    "name_last": "Smith",
    "primary_email": "test123@myclass.com",
    "role_id": "2451",
    "additional_buildings":"456"
}
```

### Response
#### Success Response (200)
- **uid** (string) - The unique identifier for the created user.
- **id** (integer) - The user's ID.
- **school_id** (integer) - The ID of the school the user belongs to.
- **synced** (integer) - Indicates if the user is synced.
- **school_uid** (string) - The unique identifier for the school.
- **building_id** (integer) - The ID of the user's building.
- **additional_buildings** (string) - Additional building identifiers for the user.
- **name_first** (string) - The first name of the user.
- **name_last** (string) - The last name of the user.
- **name_display** (string) - The display name of the user.
- **primary_email** (string) - The primary email address of the user.
- **picture_url** (string) - The URL of the user's profile picture.
- **role_id** (integer) - The ID of the user's role.
- **tz_offset** (integer) - The timezone offset for the user.
- **tz_name** (string) - The timezone name for the user.
- **send_message** (integer) - Indicates if the user can send messages.
- **links** (object) - Links related to the user.

### Response Example
```json
{
    "uid": "1710709",
    "id": 1710709,
    "school_id": 344232,
    "synced": 0,
    "school_uid": "test123",
    "building_id": 344232,
    "additional_buildings":"456",
    "name_title": "",
    "name_title_show": 0,
    "name_first": "John",
    "name_first_preferred": "",
    "name_middle": "",
    "name_middle_show": 0,
    "name_last": "Smith",
    "name_display": "John Smith",
    "username": "",
    "primary_email": "test123@myclass.com",
    "picture_url": " ... URL .. ",
    "gender": null,
    "position": null,
    "grad_year": "",
    "password": "",
    "role_id": 1214,
    "tz_offset": -4,
    "tz_name": "America/New_York",
    "parents": null,
    "child_uids": null,
    "send_message": 1,
    "links": {
        "self": " ... URL ... "
    }
}
```
```

--------------------------------

### Get Available Languages

Source: https://developers.schoology.com/api-documentation/rest-api-v1/user

Retrieves a list of all supported interface languages, including their codes and names.

```APIDOC
## GET /users/languages

### Description
Returns a list of all available interface languages. The language codes can be used when creating or updating user language preferences.

### Method
GET

### Endpoint
https://api.schoology.com/v1/users/languages

### Response
#### Success Response (200)
- **language** (array) - A list of language objects.
  - **language_code** (string) - The code representing the language.
  - **language_name** (string) - The display name of the language.

### Response Example
#### JSON
```json
{
    "language": [
        {
            "language_code": "en",
            "language_name": "English"
        },
        {
            "language_code": "en-GB",
            "language_name": "English (UK)"
        },
        {
            "language_code": "ar",
            "language_name": "Arabic"
        },
        {
            "language_code": "zh-hans",
            "language_name": "Chinese, Simplified"
        },
        {
            "language_code": "fr-corp",
            "language_name": "French - Corporate"
        },
        {
            "language_code": "de",
            "language_name": "German"
        },
        {
            "language_code": "ms",
            "language_name": "Malay"
        },
        {
            "language_code": "es",
            "language_name": "Spanish"
        }
    ]
}
```
#### XML
```xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<language>
		<language_code>en</language_code>
		<language_name>English</language_name>
	</language>
	<language>
		<language_code>en-GB</language_code>
		<language_name>English (UK)</language_name>
	</language>
	<language>
		<language_code>ar</language_code>
		<language_name>Arabic</language_name>
	</language>
	<language>
		<language_code>zh-hans</language_code>
		<language_name>Chinese, Simplified</language_name>
	</language>
	<language>
		<language_code>fr-corp</language_code>
		<language_name>French - Corporate</language_name>
	</language>
	<language>
		<language_code>de</language_code>
		<language_name>German</language_name>
	</language>
	<language>
		<language_code>ms</language_code>
		<language_name>Malay</language_name>
	</language>
	<language>
		<language_code>es</language_code>
		<language_name>Spanish</language_name>
	</language>
</result>
```
```

--------------------------------

### Create Course Section Response (XML)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/course-section

This is an example of a successful response when creating a course section in XML format. It includes the new section's ID and other details.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<result>
	<id>5614973</id>
	<course_id>1407691</course_id>
	<school_id>344232</school_id>
	<access_code>C2BGQ-F3TCV</access_code>
	<section_title>Section API</section_title>
	<section_code />
	<section_school_code>SA1</section_school_code>
	<synced />
	<active>1</active>
	<description>discuss REST API</description>
	<grading_periods>13011</grading_periods>
	<profile_url>http://......course-default.gif</profile_url>
	<location />
	<meeting_days />
	<start_time />
	<end_time />
	<options>
		<weighted_grading_categories />
		<upload_documents />
		<create_discussion />
		<member_post />
		<member_post_comment />
		<content_index_visibility />
	</options>
	<links>
		<self>http://.../v1/sections/5614973</self>
	</links>
</result>
```

--------------------------------

### List Web Content Packages (JSON)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/web-content-package

Retrieve a collection of web content packages for a specific course section. The response includes package details, total count, and navigation links.

```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"
  }
}
```

--------------------------------

### Get Current User Information

Source: https://developers.schoology.com/api-documentation/rest-api-v1/user

A shortcut to retrieve the details of the currently authenticated API user.

```APIDOC
## GET /users/me

### Description
Retrieves information about the current API user.

### Method
GET

### Endpoint
https://api.schoology.com/v1/users/me
```

--------------------------------

### Create Enrollment (JSON)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/enrollment

Use this endpoint to create a new enrollment by providing user details. Ensure the realm and ID are correctly specified in the URL.

```json
{
    "uid": "2461632",
    "admin": "0",
    "status": "1"
}
```

--------------------------------

### Update Assignment XML Payload

Source: https://developers.schoology.com/api-documentation/rest-api-v1/assignment

Example XML payload for updating an assignment, including modifications to attachments.

```XML
<body>
  <title>The assignment title with updated due date</title>
  <due>2014-09-28 09:30:00</due>
  <attachments>
    <id>9</id>
    <title>mypicture.jpeg</title>
  </attachments>
  <attachments>
    <id>11</id>
    <title>title test</title>
  </attachments>
</body>
```

--------------------------------

### Blog Post Creation Response JSON

Source: https://developers.schoology.com/api-documentation/rest-api-v1/blog-post

This is an example of the JSON response received after successfully creating a blog post. It includes the post's ID, title, body, creation timestamp, and links.

```json
{
    "id": "5615045",
    "title": "REST API meetup",
    "body": "Let's meet and chat about REST API",
    "created": 1386886221,
    "links": {
        "self": "http:\/\/...\/posts\/5615045"
    }
}
```

--------------------------------

### Update Assignment JSON Payload

Source: https://developers.schoology.com/api-documentation/rest-api-v1/assignment

Example JSON payload for updating an assignment, including modifications to attachments.

```JSON
{
  "title": "The assignment title with updated due date",
  "due": "2014-09-25 11:30:00",
  "attachments": [
    {
      "id": 9,
      "title": "mypicture.jpeg"
    },
    {
      "id": 11,
      "title": "title test"
    }
  ]
}
```

--------------------------------

### Bulk User Creation (XML)

Source: https://developers.schoology.com/api-documentation/rest-api-v1/user

An alternative XML format for creating multiple users. Ensure user data is correctly nested within the `users` and `user` elements.

```xml
<body>
  <users>
    <user>
        <school_uid>test123</school_uid>
        <name_first>John</name_first>
        <name_last>Smith</name_last>
        <primary_email>test123@myclass.com</primary_email>
        <role_id>2451</role_id>
        <additional_buildings>123,789</additional_buildings>
    </user>
    <user>
        <school_uid>test456</school_uid>
        <name_first>Perter</name_first>
        <name_last>Sonund</name_last>
        <primary_email>test456@myclass.com</primary_email>
        <role_id>2451</role_id>
        <additional_buildings>456,789</additional_buildings>
    </user>
  </users>
</body>
```