Base URLs: -- https://echo360.org (US Region) -- https://echo360.org.uk (UK Region) -- https://echo360.org.au (AU/ANZ Region) -- https://echo360.ca (Canada Region)
Version: 1.0 and Version 2.0 Schedule API
31 October 2018
| Operation | Description |
|---|---|
| GET /public/api/v1/lms-accounts | List LMS accounts for User by ID, Email, or External ID |
| DELETE /public/api/v1/lms-accounts | Reset all LMS accounts for User by ID, Email, or External ID |
| Operation | Description |
|---|---|
| GET /public/api/v1/lessons/{lessonId} | Get existing Lesson by ID |
| PUT /public/api/v1/lessons/{lessonId} | Update existing Lesson by ID |
| DELETE /public/api/v1/lessons/{lessonId} | Delete existing Lesson by ID |
| GET /public/api/v1/sections/{sectionId}/lessons | List of all existing and future Lessons for current Section |
| POST /public/api/v1/sections/{sectionId}/lessons | Add Lesson |
| Operation | Description |
|---|---|
| GET /public/api/v1/lms-profiles | List of all LmsProfiles for current Institution |
| POST /public/api/v1/lms-profiles | Add LmsProfile by externalSystemIdRef |
| GET /public/api/v1/lms-profiles/{lmsProfileId} | Get LmsProfile by Id |
| PUT /public/api/v1/lms-profiles/{lmsProfileId} | Update LmsProfile |
| DELETE /public/api/v1/lms-profiles/{lmsProfileId} | Delete a LmsProfile |
| Operation | Description |
|---|---|
| GET /public/api/v1/buildings | List of all Buildings for current Institution |
| POST /public/api/v1/buildings | Add Building |
| GET /public/api/v1/buildings/{buildingId} | Get Building by ID or External ID |
| PUT /public/api/v1/buildings/{buildingId} | Update Building by ID or External ID |
| DELETE /public/api/v1/buildings/{buildingId} | Delete Building by ID or External ID |
| Operation | Description |
|---|---|
| GET /public/api/v1/rooms/{roomId}/device-access | Get Network Connection Protocol and Port for a given Room |
| GET /public/api/v1/rooms/{roomId}/hardware1/inputs | Get Hardware 1 (SCHD) Input Configuration |
| GET /public/api/v1/rooms/{roomId}/hardware2/front-panel | Get the enabled status of a Hardware 2 (Echo360 PRO) front panel |
| GET /public/api/v1/rooms/{roomId}/hardware2/inputs | Get Hardware 2 (Echo360 PRO) Input Configuration |
| GET /public/api/v1/rooms/{roomId}/hardware2/one-touch | Get the One Touch details of a front-panel-enabled Hardware 2 (Echo360 PRO) device |
| GET /public/api/v1/rooms/{roomId}/hardware3/front-panel | Get the enabled status of a Hardware 3 (Echo360 POD) front panel |
| GET /public/api/v1/rooms/{roomId}/hardware3/inputs | Get Hardware 3 (Echo360 POD) Input Configuration |
| GET /public/api/v1/rooms/{roomId}/hardware3/one-touch | Get the One Touch details of a front-panel-enabled Hardware 3 (Echo360 POD) device |
| GET /public/api/v1/rooms/{roomId}/local-user/admin | Get Local Admin User Credentials |
| GET /public/api/v1/rooms/{roomId}/local-user/generic | Get Local Generic User Credentials |
| GET /public/api/v1/rooms/{roomId}/network | Get Network Settings plus Time Servers for a given Room |
| GET /public/api/v1/rooms/{roomId}/outbound-proxy | Get Outbound Proxy details for a given Room |
| GET /public/api/v1/rooms/{roomId}/software1/inputs | Get Software (CCAP) Input Configuration |
| Operation | Description |
|---|---|
| GET /public/api/v1/courses | List of all Courses for current Institution |
| POST /public/api/v1/courses | Add Course |
| GET /public/api/v1/courses/{courseId} | Get Course by ID or External ID |
| PUT /public/api/v1/courses/{courseId} | Update Course By ID or External ID |
| DELETE /public/api/v1/courses/{courseId} | Delete Course By ID or External ID |
| Operation | Description |
|---|---|
| GET /public/api/v1/organizations | List of all Organizations for current Institution |
| POST /public/api/v1/organizations | Add Organization |
| GET /public/api/v1/organizations/{organizationId} | Get Organization by ID or External ID |
| PUT /public/api/v1/organizations/{organizationId} | Update Organization by ID or External ID |
| DELETE /public/api/v1/organizations/{organizationId} | Delete Organization by ID or External ID |
| Operation | Description |
|---|---|
| GET /public/api/v1/sections | List of all Sections for current Institution |
| POST /public/api/v1/sections | Add Section |
| GET /public/api/v1/sections/{sectionId} | Get Section by ID or External ID |
| PUT /public/api/v1/sections/{sectionId} | Update Section by ID or External ID |
| DELETE /public/api/v1/sections/{sectionId} | Delete Section by ID or External ID |
| POST /public/api/v1/sections/{sectionId}/clone | Clone Section by ID or External ID |
| PUT /public/api/v1/sections/{sectionId}/lms-course-ids | Update Section LMS Course IDs by ID or External ID |
| PUT /public/api/v1/sections/{sectionId}/secondary-instructors | Update Section Secondary Instructors by ID or External ID |
| Operation | Description |
|---|---|
| GET /public/api/v1/terms | List of all Terms for current Institution |
| POST /public/api/v1/terms | Add Term |
| GET /public/api/v1/terms/{termId} | Get Term by ID or External ID |
| PUT /public/api/v1/terms/{termId} | Update Term by ID or External ID |
| DELETE /public/api/v1/terms/{termId} | Delete Term by ID or External ID |
| Operation | Description |
|---|---|
| POST /public/api/v1/lms/{lmsProfileId}/contexts/{contextId}/links | Create LTI Link |
| GET /public/api/v1/lms/{lmsProfileId}/contexts/{contextId}/links/{linkId} | Get LTI Link by ID |
| PUT /public/api/v1/lms/{lmsProfileId}/contexts/{contextId}/links/{linkId} | Update LTI Link |
| DELETE /public/api/v1/lms/{lmsProfileId}/contexts/{contextId}/links/{linkId} | Delete LTI Link by ID |
| GET /public/api/v1/sections/{sectionId}/lti-links | List all LTI Links for a single section |
| Operation | Description |
|---|---|
| POST /oauth2/access_token | Request an access token |
| Operation | Description |
|---|---|
| GET /public/api/v1/sections/{sectionId}/users | List of all User enrollments for Section |
| POST /public/api/v1/sections/{sectionId}/users | Enroll User in a Section |
| GET /public/api/v1/sections/{sectionId}/users/{userId} | Get User enrollment for Section |
| PUT /public/api/v1/sections/{sectionId}/users/{userId} | Update a User's Section Role (Deprecated) |
| DELETE /public/api/v1/sections/{sectionId}/users/{userId} | Unenroll User from Section |
| PUT /public/api/v2/sections/{sectionId}/users/{userId} | Update a User's Section Role |
| Operation | Description |
|---|---|
| GET /public/api/v1/schedules | List of all Schedules for current Institution |
| POST /public/api/v1/schedules | Add Schedule |
| GET /public/api/v1/schedules/{scheduleId} | Get Schedule by ID or External ID |
| PUT /public/api/v1/schedules/{scheduleId} | Update Schedule by ID or External ID |
| DELETE /public/api/v1/schedules/{scheduleId} | Delete Schedule by ID or External ID |
| PUT /public/api/v1/schedules/{scheduleId}/deviceOptions | Update Schedule's Device Options by ID or External ID |
| PUT /public/api/v1/schedules/{scheduleId}/external_id | Update Schedule's External ID by ID or External ID |
| PUT /public/api/v1/schedules/{scheduleId}/flags | Update Schedule's Flags by ID or External ID |
| PUT /public/api/v1/schedules/{scheduleId}/instructors | Update Schedule's Instructors by ID or External ID |
| PUT /public/api/v1/schedules/{scheduleId}/name | Update Schedule's Name by ID or External ID |
| PUT /public/api/v1/schedules/{scheduleId}/section | Update Schedule's Section by ID or External ID |
| PUT /public/api/v1/schedules/{scheduleId}/times | Update Schedule's Times by ID or External ID |
| Operation | Description |
|---|---|
| GET /public/api/v1/users | List of all Users for current Institution |
| POST /public/api/v1/users | Add User |
| GET /public/api/v1/users/{userId} | Get User by ID, Email, or External ID |
| PUT /public/api/v1/users/{userId} | Update User by ID, Email, or External ID |
| GET /public/api/v1/users/{userId}/invite | Resend User Invite by ID, Email, or External ID |
| GET /public/api/v1/users/{userId}/status/{status} | Disable / Enable User by ID, Email, or External ID |
| Operation | Description |
|---|---|
| GET /public/api/v1/departments | List of all Departments for current Institution |
| POST /public/api/v1/departments | Add Department |
| GET /public/api/v1/departments/{departmentId} | Get Department by ID or External ID |
| PUT /public/api/v1/departments/{departmentId} | Update Department by ID or External ID |
| DELETE /public/api/v1/departments/{departmentId} | Delete Department by ID or External ID |
| Operation | Description |
|---|---|
| GET /public/api/v1/campuses | List of all Campuses for current Institution |
| POST /public/api/v1/campuses | Add Campus |
| GET /public/api/v1/campuses/{campusId} | Get Campus by ID or External ID |
| PUT /public/api/v1/campuses/{campusId} | Update Campus by ID or External ID |
| DELETE /public/api/v1/campuses/{campusId} | Delete Campus by ID or External ID |
| Operation | Description |
|---|---|
| GET /public/api/v1/rooms | List of all Rooms for current Institution |
| POST /public/api/v1/rooms | Add Room |
| GET /public/api/v1/rooms/{roomId} | Get Room by ID or External ID |
| PUT /public/api/v1/rooms/{roomId} | Update Room by ID or External ID |
| DELETE /public/api/v1/rooms/{roomId} | Delete Room by ID or External ID |
| Operation | Description |
|---|---|
| GET /public/api/v1/publish/media/lessons/{lessonId} | List publishable Media for a Lesson |
| GET /public/api/v1/publish/media/{mediaId}/lessons | List all Lessons a Media is published to |
| POST /public/api/v1/publish/media/{mediaId}/lessons/{lessonId} | Publish Media to a Lesson and set the availability |
| PUT /public/api/v1/publish/media/{mediaId}/lessons/{lessonId} | Update the availability status of a Media published to a Lesson |
| DELETE /public/api/v1/publish/media/{mediaId}/lessons/{lessonId} | Unpublish Media from a Lesson |
| Operation | Description |
|---|---|
| GET /public/api/v1/medias | List of all Media for the Institution or filter by the published Lesson, Section, Course, or Term |
| GET /public/api/v1/medias/{mediaId} | Get Media by ID |
| GET /public/api/v1/medias/{mediaId}/linking | Get Access Links by Media ID |
| GET /public/api/v1/medias/{mediaId}/linking/{linkId} | Get Access Link by ID and Media ID |
| GET /public/api/v1/medias/{mediaId}/sharing | Get Shares by Media ID |
| GET /public/api/v1/medias/{mediaId}/sharing/{userId} | Get Share by User ID/Email/External ID and Media ID |
| Operation | Description |
|---|---|
| GET /public/api/v2/schedules | List Schedules with filtering by Room details |
| POST /public/api/v2/schedules | Add Schedule |
| GET /public/api/v2/schedules/{schedule} | Get Schedule by ID, or External ID. |
| PUT /public/api/v2/schedules/{schedule} | Update Schedule by ID or External ID |
| DELETE /public/api/v2/schedules/{schedule} | Delete Schedule by ID or External ID |
application/x-www-form-urlencoded
| grant_type | Can be one of the following: client_credentials, password, or refresh_token |
query | string | |
| client_id | Needed for all grant types |
query | string | |
| client_secret | Needed for all grant types except refresh_token |
query | string | |
| username | If password chosen |
query | string | |
| password | If password chosen |
query | string | |
| refresh_token | If refresh_token chosen |
query | string |
Successful
Bad Request
Not Authenticated
Internal Error
| campusId | ID or External ID of the Campus to filter Buildings |
query | string None | |
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Building data
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| buildingId | ID or External ID of the Building to Delete |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| buildingId | ID or External ID of the Building to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
Building data
| buildingId | ID or External ID of the Building to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Campus data
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| campusId | ID or External ID of the Campus to Delete |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| campusId | ID or External ID of the Campus to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Campus data
| campusId | ID or External ID of the Campus to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Course data
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| courseId | ID or External ID of the Course to Delete |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| courseId | ID or External ID of the Course to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Course Data
| courseId | ID or External ID of the Course to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| organizationId | ID or External ID of the Organization to filter Departments |
query | string None | |
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Department data
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| departmentId | ID or External ID of the Department to Delete |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| departmentId | ID of the Department to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Department data
| departmentId | ID or External ID of the Department to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| lessonId | ID of the existing Lesson to Delete |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| lessonId | ID of the existing Lesson to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Lesson data
| lessonId | ID of the existing Lesson to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| userId | ID, Email, or External ID of the User to reset LMS account |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| userId | ID, Email, or External ID of the User to list LMS accounts |
query | string | |
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| limit | Number of results |
query | integer (int32) |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
LmsProfile data
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| lmsProfileId | Name of the LmsProfile to Deleted |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| lmsProfileId | ID of the LmsProfile to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
LmsProfile data
| lmsProfileId | ID of the LmsProfile to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
LTI Link Info
| lmsProfileId | ID of the LMS Profile |
path | string | |
| contextId | ID of the LTI Context |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Internal Error
| lmsProfileId | ID of the LMS Profile |
path | string | |
| contextId | ID of the LTI Context |
path | string | |
| linkId | ID of the LTI Resource Link |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Internal Error
| lmsProfileId | ID of the LMS Profile |
path | string | |
| contextId | ID of the LTI Context |
path | string | |
| linkId | ID of the LTI Resource Link |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Internal Error
LTI Link Info
| lmsProfileId | ID of the LMS Profile |
path | string | |
| contextId | ID of the LTI Context |
path | string | |
| linkId | ID of the LTI Resource Link |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Internal Error
| lessonId | ID of the Lesson to list associated Medias |
query | string None | |
| sectionId | ID or External ID of the Section to list associated Medias |
query | string None | |
| courseId | ID or External ID of the Course to list associated Medias |
query | string None | |
| termId | ID or External ID of the Term to list associated Medias |
query | string None | |
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| mediaId | ID Media to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| mediaId | ID Media to Get Access Links |
path | string | |
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| mediaId | ID Media to Get |
path | string | |
| linkId | ID Link to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| mediaId | ID Media to Get Access Links |
path | string | |
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| mediaId | ID Media to Get |
path | string | |
| userId | ID User to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Organization data
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| organizationId | ID or External ID of the Organization to Delete |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| organizationId | ID or External ID of the Organization to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Organization data
| organizationId | ID or External ID of the Organization to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| lessonId | ID of the lesson |
path | string |
Successful
Not Authenticated
Internal Error
| mediaId | ID of the media |
path | string |
Successful
Not Authenticated
Internal Error
| mediaId | ID of the media |
path | string | |
| lessonId | ID of the lesson |
path | string |
Successful
Not Authenticated
Internal Error
Availability
| mediaId | ID of the media |
path | string | |
| lessonId | ID of the lesson |
path | string |
Successful
Not Authenticated
Internal Error
Availability
| mediaId | ID of the media |
path | string | |
| lessonId | ID of the lesson |
path | string |
Successful
Not Authenticated
Internal Error
| buildingId | ID or External ID of the Building to filter Rooms |
query | string None | |
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Room data
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| roomId | ID or External ID of the Room to Delete |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| roomId | ID or External ID of Room to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Room data
| roomId | ID or External ID of the Room to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID of the Room |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Not Found
Internal Error
| roomId | ID or External ID of the Room to filter Schedules |
query | string None | |
| sectionId | ID or External ID of the Section to filter Schedules |
query | string None | |
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Schedule data
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| scheduleId | ID or External ID of the Schedule to Delete |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| scheduleId | ID or External ID of the Schedule to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Schedule data
| scheduleId | ID or External ID of the Schedule to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Schedule Device Options data
| scheduleId | ID or External ID of the Schedule to Update Device Options |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Schedule External ID
| scheduleId | ID or External ID of the Schedule to Update External ID |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Schedule flags data
| scheduleId | ID or External ID of the Schedule to Update Flags |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Schedule Instructors
| scheduleId | ID or External ID of the Schedule to Update Instructors |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Schedule Name data
| scheduleId | ID or External ID of the Schedule to Update Name |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Schedule Section data
| scheduleId | ID or External ID of the Schedule to Update Section |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Schedule Time data
| scheduleId | ID or External ID of the Schedule to Update Times |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| courseId | ID or External ID of the Course to filter Sections |
query | string None | |
| termId | ID or External ID of the Term to filter Sections |
query | string None | |
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Section data
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| sectionId | ID or External ID of the Section to Delete |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| sectionId | ID or External ID of the Section to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Section data
| sectionId | ID or External ID of the Section to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Section data
| sectionId | ID or External ID of the Section to Clone |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| sectionId | ID or External ID of the Section to Get Lessons |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Section data
| sectionId | ID or External ID of the Section to Update LMS Course IDs |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| sectionId | ID or External ID of the Section to Get LTI Links |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Internal Error
Section data
| sectionId | ID or External ID of the Section to Update Secondary Instructors |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| sectionId | ID or External ID of the Section to Get Enrollments |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Internal Error
Section data
| sectionId | ID or External ID of the Section to Enroll User |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Internal Error
| sectionId | ID or External ID of the Section to Delete Enrollment |
path | string | |
| userId | ID or External ID of the User to Delete Enrollment |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Internal Error
| sectionId | ID or External ID of the Section to Get Enrollments |
path | string | |
| userId | ID or External ID of the User to Get Enrollments |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Internal Error
Either "Student" or "Instructor"
| sectionId | ID of the Section to Update Section Role |
path | string | |
| userId | ID of the User to Update Section Role |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Internal Error
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Term data
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| termId | ID or External ID of the Term to Delete |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| termId | ID or External ID of the Term to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Term data
| termId | ID or External ID of the Term to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
User data
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| userId | ID, Email, or External ID of the User to Get |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
User data
| userId | ID, Email, or External ID of the User to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| userId | ID, Email, or External ID of the User to resend invite |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| userId | ID, Email, or External ID of the User to Disable / Enable |
path | string | |
| status | Active or Inactive status of the User to Disable / Enable |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
| room | Room ID, External ID, or Name |
query | string None | |
| building | Building ID, External ID, or Name (required if Room Name is supplied) |
query | string None | |
| campus | Campus ID, External ID, or Name (required if Room Name is supplied) |
query | string None | |
| limit | Number of results |
query | integer (int32) | |
| offset | Key returned from prior result to get next page |
query | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Schedule data
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| schedule | ID or External ID of the Schedule to Delete |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Internal Error
| schedule | Schedule ID, or External ID |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Schedule data
| schedule | ID or External ID of the Schedule to Update |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Resource Not Found
Method Not Allowed
Internal Error
Enrollment data
| sectionId | ID of the Section to Update Section Role |
path | string | |
| userId | ID of the User to Update Section Role |
path | string |
Successful
Bad Request
Not Authenticated
Forbidden
Internal Error
Availability
Date when media will be available: YYYY-MM-DD
"2018-08-09"
Unique Identifier of the Building
ID of the Campus to which the Building belongs
ID of the Institution to which the Campus belongs
Name of the Building returned
External system identifier for the current Building
Unique Identifier of the Campus
ID of the Instituion to which the Campus belongs
Name of the Campus returned
The Time Zone in which the Campus is located
"US/Eastern"
Offset in minutes to add to UTC to get the local time.
-120
External system identifier for the current Campus
ID or External ID of the Course to which the cloned Section belongs
"ICT102"
ID or External ID of the Term to which the cloned Section belongs
"SEM1_2017"
Number to uniquely identify the cloned Section
"ICT102_S1_2017"
Optional Description of the cloned Section
"Cloned Section"
ID, Email, or External ID of the Instructor for the cloned Section (if omitted the existing Section Instructor will be kept)
"Foo.Bar@echo360.com"
External system identifier of the cloned Section
"ICT102_S2_2017"
Unique Identifier of the Course
ID of the Instituion to which the Organization belongs
ID of the Organization to which the Department belongs. Will default to ownership by Institution if non-existent
ID of the Department to which the Course belongs. Will default to ownership by Organization if non-existent
Name of the Course returned
Institution-specific identifier for the Course
"ICT102"
Number of Sections that exist for the current Course
4
External system identifier
Start date for capture in ISO 8601 Date format: YYYY-MM-DD
"2017-02-01"
Start time for the capture (to the minute) in ISO 8601 Time format: HH:MM. The time zone for the schedule's linked room will be used
"09:00"
The last date for the capture in ISO 8601 Date format: YYYY-MM-DD. If this is specified, daysOfWeek must also be provided
"2017-05-31"
Days of the week this schedule should capture as 2 letter abbreviations: SU, MO, TU, WE, TH, FR, SA. This is required when endDate is specified
"[\"MO\", \"TU\"]"
Dates within the scheduled period skip recording in ISO 8601 Date format: YYYY-MM-DD. This is unused when no endDate/daysOfWeek is specified
"[\"2017-04-14\", \"2014-04-17\"]"
Duration of each scheduled capture in Minutes
60
ID of the Term in which to Schedule the Capture
Deprecated -- ID or External ID of the Section in which to Schedule the Capture
"ICT102_S1_2017"
List of the Sections in which to Schedule the Capture
Name of the Schedule
"ICT102 Sem1 2017 9:00-10:00 Mon/Tue, Rm: Rockerfeller Studio 6H"
ID or External ID of the Room in which to Schedule the Capture
"ROCKEFELLER_STUDIO_6H"
ID, Email, or External ID of the Instructor
"Foo.Bar@echo360.com"
Name of any Guest Instructor
"Visiting consultant Prof A. Citizen"
Boolean value indicating the Capture should be Captioned
Boolean value indicating the Capture should be Streamed Live
Input 1 Logical Graphics Type
Input 2 Logical Graphics Type
Quality of the Capture
Streaming Quality of the Capture
External system identifiers of the Schedule
"ICT102S12017-RECUR_MON,TUE_0900-1000_ROCKEFELLER_STUDIO_6H"
ID or External ID of the Course to which the Section belongs
"ICT102"
ID or External ID of the Term to which the Section belongs
"SEM1_2017"
Number to uniquely identify each Section
"ICT102_S1_2017"
Optional Description of the current Section
ID, Email, or External ID of the Instructor by whom the Section will be taught
"Foo.Bar@echo360.com"
Array of ID's of the Secondary Instructors for the current Section
Array of Section Identifiers from any External Learning Management System
"[\"ICT102_S1_2017\"]"
Array of Section Identifiers from any External Learning Management System
External system identifier of the Section
"ICT102_S1_2017"
ID or External of the Campus to which the Building belongs
"NYC"
Name of the Building
"Rockefeller Plaza"
External system identifier of the Building
"ROCKEFELLER"
Name of the Campus
"New York City"
The Time Zone in which the Campus is located. Will default to the Institution's Time Zone if not specified
"US/Eastern"
External system identifier of the Campus
"NYC"
ID or External ID of the Organization to which the Department belongs. Will default to ownership by Institution if left empty.
"FAC_ENGINEERING"
ID or External ID of the Department to which the Course belongs. Will default to ownership by Organization if left empty
"DEPT_CSEE"
Name of the Course
"Introduction to Computer Science"
Institution-specific identifier for the Course
"ICT102"
External system identifier of the Course
"ICT102"
The ID or External ID of the Organization to which the Department belongs. Will default to ownership by Institution if left empty.
"FAC_ENGINEERING"
Name of the Department
"Dept. of Computer Science & Electrical Engineering"
External system identifier of the Department
"DEPT_CSEE"
Name of the Organization
"Faculty of Engineering"
External system identifier of the Organization
"FAC_ENGINEERING"
ID or External ID of the Building to which to the Room belongs
"ROCKEFELLER"
Name of the Room
"Rockerfeller Studio 6H"
Device ID to assign this room
External system identifier of the Room
"ROCKEFELLER_STUDIO_6H"
Name of the Term
"Semester 1 2017"
Object consisting of the Start Date and End Date of the Term
Any Dates within the current Term on which Class will not be held
External system identifier of the Term
"SEM1_2017"
Email address of the User
"Foo.Bar@echo360.com"
The Time Zone in which the User is located
"US/Eastern"
First Name of the User
"Foo"
Last Name of the User
"Bar"
Phone Number of the User. An object containing the Region and Number
"{\"region\": \"US\", \"number\": \"000-867-5309\"}"
URL of the User's Profile Image
Role(s) of the User within the Institution: Admin, Instructor, Student
"[\"Admin\", \"Instructor\", \"Student\"]"
A string that identifies the user to an external identity provider
"fbar+internet2.edu@subdomain.incommon.org"
External system identifier of the User
"Foo.Bar@echo360.com"
Start Date of the current Term in ISO 8601 Date format: YYYY-MM-DD
End Date of the current Term in ISO 8601 Date format: YYYY-MM-DD
Start Date Time in ISO 8601 Date format: YYYY-MM-DD'T'HH:mm:ss.SSS
"2015-10-05T12:30:00.000"
End Date Time in ISO 8601 Date format: YYYY-MM-DD'T'HH:mm:ss.SSS
"2015-10-05T13:30:00.000"
Unique Identifier of the Department
The ID of the Organization to which the Department belongs. Will default to ownership by Institution if non-existent.
ID of the Institution to which the Organization belongs
Name of the Department returned
Number of Courses that exist for the current Department
"10"
Number of Sections that exist for the current Department
"4"
External system identifier for the current Department
Protocol
Port number
ID or Email of the User
Role(s) of the User within the Institution
Start Date of the Term Exclusion Date Range in ISO 8601 Date format: YYYY-MM-DD
End Date of the Term Exclusion Date Range in ISO 8601 Date format: YYYY-MM-DD
Audio Input Connector
Gain value for analog Audio
Enabled status of DVI Input
Connector for DVI Graphics Input
Aspect ratio of the DVI input
Type of the DVI Input Source
Enabled status of Composite Input
Video Standard of the Composite Input
Enabled status of DVI Input
Connector for DVI Graphics Input
Aspect ratio of the DVI input
Type of the DVI Input Source
Enabled status of Composite Input
Video Standard of the Composite Input
Audio Input Connector
Gain value for analog Audio
Enabled status of Composite Input
Type of the Composite Input Source
Video Standard of the Composite Input
Enabled status of the HDMI input
Type of the HDMI Input Source
Aspect ratio of the HDMI input
Enabled status of HDMI Mixed Audio
Enabled status of SDI Input
Type of the SDI Input Source
Aspect ratio of the SDI input
Enabled status of VGA Input
Type of the VGA Input Source
Aspect ratio of the VGA input
Enabled status of Composite Input
Video Standard of the Composite Input
Type of the Composite Input Source
Enabled status of HDMI Input
Type of the HDMI Input Source
Aspect ratio of the HDMI input
Enabled status of HDMI Mixed Audio
Enabled status of SDI Input
Type of the SDI Input Source
Aspect ratio of the SDI input
Enabled status of VGA Input
Type of the VGA Input Source
Aspect ratio of the VGA input
Audio Input Connector
Gain value for analog Audio
Enabled status of the HDMI Input
Aspect ratio of the HDMI Input
Type of the HDMI Input Source
Enabled status of HDMI Mixed Audio
Enabled status of USB Input
Type of the USB Input Source
Enabled status of USB Mixed Audio
Enabled status of the HDMI Input
Aspect ratio of the HDMI Input
Type of the HDMI Source
Enabled status of HDMI Mixed Audio
Enabled status of USB Input
Type of the USB Input Source
Enabled status of USB Mixed Audio
Id of the lesson
Id of the institution
Id of the section
Id of the capture occurrence
Name of the lesson
Info of the lesson
Timing of the lesson
Name of the Time Zone; defaults to the Institution Time Zone if omitted
"US/Eastern"
Should stream live
DateTime value for Creation Date
"2015-10-05T15:24:53.496Z"
DateTime value for Updated Date
"2015-10-05T15:24:53.496Z"
Id of the lesson
Id of the publishable media
Id of the institution
Id of the term
Name of the term
Id of the course
Id of the section
Name of the lesson
Time range for the lesson publishable media
Name of the timeZone
Name of the course
Availability of the content
Type of the media
ID of the LMS Profile for an External Learning Management System
Section Identifiers from an External Learning Management System
Boolean value for whether this LMS Course links to the Echo360 section home
Unique Identifier of the LmsProfile
Name of the Lms
Unique Token for LmsProfile
Lti Catridge for LmsProfile
External System Id Ref to Course
The Host Url for the LmsProfile
Name of the Lms
External System Id Ref to Course
LMS supplied User ID
ID of the Echo360 LMS Profile for an External Learning Management System
ID of the Echo360 User
Optional LMS supplied User First Name
Optional LMS supplied User Last Name
Email of the User
Role of the User
External system identifier for the User
Local User credentials username
Local User credentials password
Resource Link ID from LMS: resource_link_id
Resource Link Title from LMS: resource_link_title
ID of Echo360 LMS Profile
Context ID from LMS: context_id
Context Title from LMS: context_title
Section Identifier from LMS
ID of Echo360 object (lesson or section) link is connected to
Type of Link: Section or Lesson
ID of Institution
ID of Section link is connected to
ID of Section link is connected to
Outcome Service Url from LMS: lis_outcome_service_url
Resource Link ID from LMS: resource_link_id
Resource Link ID from LMS: resource_link_id
Resource Link Title from LMS: resource_link_title
ID of Echo360 LMS Profile
Context ID from LMS: context_id
ID of Echo360 object (lesson or section) link is connected to
Type of Link: Section or Lesson
Outcome Service Url from LMS: lis_outcome_service_url
Resource Link ID from LMS: resource_link_id
Id of the Publishable Media
Name of the Media
Name of the Media
Id of the User presenting the Media
Media type of the Media
Publishable status of the Media
The Time Zone to which the capture occurrence created the Media
Date/Time of creating Media
Date/Time of updating Media
Tags associated with the Media
Id of the Capture Occurrence for the Media
List of Lesson information associated with the Media
List of Sharing information for the Media
List of Access Link information for the Media
Type of the Network
IP Address of the Device on the Network
32-bit number to mask the IP address
Node on the Network that can forward packets to other Networks
Primary Domain Name System of the Network
Secondary Domain Name System of the Network
Primary Time Server of the Network
Secondary Time Server of the Network
WiFi Enabled flag
WiFi SSID Name
WiFi Password
The Type of Capture Device
The Type of the First Input to the One Touch Enabled Capture Device
The Type of the Second Input to the One Touch Enabled Capture Device
The Quality chosen for the Capture
Unique Identifier of the Organization
ID of the Institution to which the Organization belongs
Name of the Organization returned
Number of Departments that exist for the current Organization
Number of Courses that exist for the current Organization
Number of Sections that exist for the current Organization
External system identifier
Region to which the Phone Number is assigned. The Region will be used to look up the International Calling Code
"United Kingdom"
The 10-digit Phone Number
"999-999-9999"
Host Address of the Outbound Proxy Server
Port Number of the Outbound Proxy Server
User Account to the Outbound Proxy Server
Password for the User Account
Unique Identifier of the Room
ID of the Building to which to the Room belongs
ID of the Institution to which the Building belongs
Name of the Room returned
ID of the Room Configuration. Not Required
Current Software Version on the Lecture Capture Device
"5.5.558149484"
ID/MAC address for room's capture device
The device type, if applicable
DateTime value for Creation Date
"YYYY-MM-DD'T'HH:mm:ss.SSS'Z'"
DateTime value for Updated Date
"YYYY-MM-DD'T'HH:mm:ss.SSS'Z'"
External system identifier for the current Room
ID of the Schedule
Start date for capture in ISO 8601 Date format: YYYY-MM-DD
"2017-02-01"
Start time for the capture (to the minute) in ISO 8601 Time format: HH:MM. The time zone for the schedule's linked room will be used
"09:00"
The last date for the capture, in ISO 8601 Date format: YYYY-MM-DD. If this is specified, daysOfWeek must also be provided
"2017-05-31"
Days of the week this schedule should capture as 2 letter abbreviations: SU, MO, TU, WE, TH, FR, SA. This is required when endDate is specified
"[\"MO\", \"TU\"]"
Dates within the scheduled period skip recording in ISO 8601 Date format: YYYY-MM-DD. This is unused when no endDate/daysOfWeek is specified
"[\"2017-04-14\", \"2014-04-17\"]"
Duration of each scheduled capture in Minutes
60
ID of the primary (first) Section in which to publish the Capture
List of the Sections in which to Schedule the Capture
Name of the Schedule
ID of the Room in which to Schedule the Capture
ID of the Instructor
Name of any Guest Instructor
Boolean value indicating the Capture should be Captioned
Boolean value indicating the Capture should be Automatically Published
Boolean value indicating the Capture should be Streamed Live
Input 1 Logical Graphics Type
Input 2 Logical Graphics Type
Quality of the Capture
Streaming Quality of the Capture
External system identifiers
ID of the Institution to which the Schedule belongs
ID of the Schedule
Name of the Schedule - Optional
Start date for capture in ISO 8601 Date format: YYYY-MM-DD
"2017-02-01"
Start time for the capture (to the minute) in ISO 8601 Time format: HH:MM - The Time Zone obtained from the Campus
"09:00"
End time for the capture (to the minute) in ISO 8601 Time format: HH:MM - The Time Zone obtained from the Campus
"10:00"
End date for the capture in ISO 8601 Date format: YYYY-MM-DD - Only required for recurring Schedules
"2017-05-31"
Days of the week this schedule should capture as 2 letter abbreviations: SU, MO, TU, WE, TH, FR, SA - Only required for recurring Schedules
"[\"MO\", \"TU\"]"
Dates within the scheduled period skip recording in ISO 8601 Date format: YYYY-MM-DD - Only required for recurring Schedules
"[\"2017-04-14\", \"2014-04-17\"]"
The Venue details comprising of Campus, Building, Room details where the Schedule will capture
The Presenter details for the Schedule comprising of User Id and Email
Name of any Guest Presenter without an existing User account
List of the Section details in which the Capture will be published to
Boolean value indicating the Capture should be Captioned; defaults to 'false' if omitted
Boolean value indicating the Capture should be Streamed Live; defaults to 'false' if omitted
Boolean value indicating the Capture has one or more Sections to publish to
Boolean value indicating the Capture is recurring between a Start Date and End Date period
Input 1 Logical Graphics Type
Input 2 Logical Graphics Type
Quality of the Schedule; defaults to 'high' if omitted
Streaming Quality of the Schedule
External ID of the Schedule
Name of the Schedule; defaults to 'Untitled' if omitted
Start date for capture in ISO 8601 Date format: YYYY-MM-DD
"2017-02-01"
Start time for the capture (to the minute) in ISO 8601 Time format: HH:MM - The Time Zone obtained from the Campus
"09:00"
End time for the capture (to the minute) in ISO 8601 Time format: HH:MM - The Time Zone obtained from the Campus
"10:00"
End date for the capture in ISO 8601 Date format: YYYY-MM-DD - Only required for recurring Schedules
"2017-05-31"
Days of the week this schedule should capture as 2 letter abbreviations: SU, MO, TU, WE, TH, FR, SA - Only required for recurring Schedules
"[\"MO\", \"TU\"]"
Dates within the scheduled period skip recording in ISO 8601 Date format: YYYY-MM-DD - Only required for recurring Schedules
"[\"2017-04-14\", \"2014-04-17\"]"
The Venue details comprising of Campus, Building, Room details where the Schedule will capture
The Presenter details for the Schedule comprising of User Id and Email
Name of any Guest Presenter without an existing User account
List of the Section details in which the Capture will be published to
Boolean value indicating the Capture should be Captioned; defaults to 'false' if omitted
Boolean value indicating the Capture should be Streamed Live; defaults to 'false' if omitted
Input 1 Logical Graphics Type
Input 2 Logical Graphics Type
Quality of the Schedule; defaults to 'high' if omitted
Streaming Quality of the Schedule; default to 'high' if omitted and shouldStreamLive is 'true'
External ID of the Schedule
Availability type
Delay in Days from the start of the capture event for relative availability (Only valid for Relative availability)
Date to make available for concrete availability (Only valid for Concrete availability)
Delay in Days after which to make unavailable for relative availability (Only valid for Relative availability)
ID of the User presenting the Schedule
Email of the User presenting the Schedule
Full Name of the User presenting the Schedule
ID of the Course in which to publish the Capture
Identifier of the Course in which to publish the Capture
ID of the Term in which to publish the Capture
Name of the Term in which to publish the Capture
ID of the Section in which to publish the Capture
Name of the Section in which to publish the Capture
Availability status for students
ID of the Campus in which to record the Capture
Name of the Campus in which to record the Capture
ID of the Building in which to record the Capture
Name of the Building in which to record the Capture
ID of the Room in which to record the Capture
Name of the Room in which to record the Capture
ID of the User presenting the Schedule; exclude to clear existing the Schedule Presenter
Email of the User presenting the Schedule; exclude to clear existing the Schedule Presenter
External ID of the User presenting the Schedule; exclude to clear existing the Schedule Presenter
ID of the Course in which to publish the Capture
Identifier of the Course in which to publish the Capture
External ID of the Course in which to publish the Capture
ID of the Term in which to publish the Capture
Name of the Term in which to publish the Capture
External ID of the Term in which to publish the Capture
ID of the Section in which to publish the Capture
Name of the Section in which to publish the Capture
External ID of the Section in which to publish the Capture
Availability status for students
ID of the Campus in which to record the Capture
Name of the Campus in which to record the Capture
External ID of the Campus in which to record the Capture
ID of the Building in which to record the Capture
Name of the Building in which to record the Capture
External ID of the Building in which to record the Capture
ID of the Room in which to record the Capture
Name of the Room in which to record the Capture
External ID of the Room in which to record the Capture
Name of the Schedule; defaults to existing setting if omitted
Start date for capture in ISO 8601 Date format: YYYY-MM-DD; defaults to existing setting if omitted
"2017-02-01"
Start time for the capture (to the minute) in ISO 8601 Time format: HH:MM - The Time Zone obtained from the Campus; defaults to existing setting if omitted
"09:00"
End time for the capture (to the minute) in ISO 8601 Time format: HH:MM - The Time Zone obtained from the Campus; defaults to existing setting if omitted
"10:00"
End date for the capture in ISO 8601 Date format: YYYY-MM-DD - Only required for recurring Schedules; defaults to existing setting if omitted
"2017-05-31"
Days of the week this schedule should capture as 2 letter abbreviations: SU, MO, TU, WE, TH, FR, SA - Only required for recurring Schedules; defaults to existing setting if omitted
"[\"MO\", \"TU\"]"
Dates within the scheduled period skip recording in ISO 8601 Date format: YYYY-MM-DD - Only required for recurring Schedules; defaults to existing setting if omitted
"[\"2017-04-14\", \"2014-04-17\"]"
The Venue details comprising of Campus, Building, Room details where the Schedule will capture; defaults to existing setting if omitted
The Presenter details for the Schedule comprising of User Id and Email; defaults to existing setting if omitted
Name of any Guest Presenter without an existing User account; defaults to existing setting if omitted
List of the Section details in which the Capture will be published to; defaults to existing setting if omitted
Boolean value indicating the Capture should be Captioned; defaults to existing setting if omitted
Boolean value indicating the Capture should be Streamed Live; defaults to existing setting if omitted
Input 1 Logical Graphics Type; defaults to existing setting if omitted
Input 2 Logical Graphics Type; defaults to existing setting if omitted
Quality of the Schedule; defaults to existing setting if omitted
Streaming Quality of the Schedule; defaults to existing setting / 'high' if omitted and shouldStreamLive is 'true'
External ID of the Schedule
Availability type
Delay in Days from the start of the capture event for relative availability (Only valid for Relative availability)
Date to make available for concrete availability (Only valid for Concrete availability)
Delay in Days after which to make unavailable for relative availability (Only valid for Relative availability)
ID of the Section in which to publish the Capture
Should the Capture be made available to students
Unique Identifier of the Section
ID of the Institution to which the Section belongs
ID of the Course to which the Section belongs
ID of the Term to which the Section belongs
Array of ID's of Schedules which belong to the current Section
Number to uniquely identify each Section
Optional ID of the Instructor by whom the Section will be taught
Optional Description of the current Section
Deprecated - Number of Lessons that exist for the current Section
15
Number of Instructors that exist for the current Section
30
Number of Students that exist for the current Section
30
Array of ID's of the Secondary Instructors for the current Section
Array of Section Identifiers from any External Learning Management System
Array of Section Identifiers from any External Learning Management System
External system identifier for the current Section
Name of the Audio Input
Index of the Audio Input
Enabled status of the Audio Input
Name of the Display Input
Index of the Display Input
Enabled status of the Display Input
Name of the Video Input
Index of the Video Input
Enabled status of the Video Input
Name of the Alternative Video Input Configuration
Index of the Alternative Video Input
Enabled status of the Alternative Video Input
Unique Identifier of the Term
ID of the Institution to which the Term belongs
Name of the Term returned
Object consisting of the Start Date and End Date of the Term
Any Dates within the current Term on which Class will not be held
Number of Sections that exist for the current Term
External system identifier for the current Term
ID of the Room in which to Schedule the Capture
Input for this schedule
Optional secondary input for this schedule
The capture quality for this schedule
The (optional) quality for the live stream, if it differs from captureQuality
Boolean value indicating the Capture should be Captioned
Boolean value indicating the Capture should be Streamed Live
ID or Email of the Instructor
Name of any Guest Instructor
ID of the Section with which to update the Schedule
List of the Sections in which to Schedule the Capture
Start date for capture in ISO 8601 Date format: YYYY-MM-DD
"2017-02-01"
Start time for the capture (to the minute) in ISO 8601 Time format: HH:MM. The time zone for the schedule's linked room will be used
"09:00"
The last date for the capture, in ISO 8601 Date format: YYYY-MM-DD. If this is specified, daysOfWeek must also be provided
"2017-05-31"
Days of the week this schedule should capture as 2 letter abbreviations. This is required when endDate is specified
Dates within the scheduled period skip recording in ISO 8601 Date format: YYYY-MM-DD
"[\"2017-04-14\", \"2014-04-17\"]"
Duration of each scheduled capture in Minutes
60
Number to uniquely identify each Section
"ICT102_S1_2017"
Optional Description of the current Section
"First year introductory unit to object-orientated and functional programming"
ID, Email, or External ID of the Instructor by whom the Section will be taught
"Foo.Bar@echo360.com"
External system identifier of the Section
"ICT102_S1_2017"
Array of ID's of the Secondary Instructors for the current Section
Set of Section Identifiers from any External Learning Management System. Required if lmsCourses is left blank
Array of Section Identifiers from any External Learning Management System. Required if lmsCourseIds is left blank
Unique Identifier of the User
ID of the Institution to which the User belongs
Email address of the User
"Foo.Bar@echo360.com"
The Time Zone in which the User is located
"US/Eastern"
Offset in minutes to add to UTC to get the local time
-120
First Name of the User. May be blank if the User has not yet accepted the invitation Email
"Foo"
Last Name of the User. May be blank if the User has not yet accepted the invitation Email
"Bar"
Status of the User.
"Invited"
Phone Number of the User. An object containing the Region and Number
"{\"region\": \"US\", \"number\": \"000-867-5309\"}"
URL of the User's Profile Image
Role(s) of the User within the Institution: Admin, Instructor, Student
"[\"Admin\", \"Instructor\", \"Student\"]"
A string that identifies the user to an external identity provider
"fbar+internet2.edu@subdomain.incommon.org"
External system identifier for the current User
"Foo.Bar@echo360.com"
ID of the User
ID of the Section
Role of the User within the Institution
ID of the Institution
ID of the Course
ID of the Term