LTO REST API: Instructor (Get, Post/Assign, Update Assignment, Delete Assignment)

Get the instructors assigned to a schedule, assign one, update the assignment details, and unassign an instructor, through the Litmos Commerce API.

Sep 26, 2026
Knowledge

Title

Last Updated

5/9/2023

URL Name

lto-rest-api-schedule-instructor-get

Product

Training Ops

Body

The following document will help you to:

Get the instructor(s) assigned to a schedule
Assign an instructor to a schedule
Update the details around an instructor's assignment to a schedule
Delete/unassign an instructor from a schedule

Get Instructors

Returns all instructors assigned to a schedule via Litmos Training Ops API.

Note: All requests must be Authenticated.

Authentication and Authorization

Information used for API authentication and authorization is submitted in the request header. The following header values are required with each request.

Header	Description
CompanyLoginId	Company Login Id (provisioned by ViewCentral account management)
ProductId	Product Id. 1=Learning Management, 2=Event Management
Username	User account username
Password	User account password

Request: Provide schedule ID in the URL. Gets all the Instructors assigned to the schedule object.

URI: GET https://api.viewcentral.com/api/Schedules/{ScheduleId}/Instructors/

Response Examples:

{
  "AssignmentId": "Required int [max length 10]",
  "ScheduleId": "Required Int [max length 10]",
  "InstructorId": "Required int [max length 10]",
  "StartDate": "Required date [yyyy-mm-dd]",
  "EndDate": "Optional date [yyyy-mm-dd]",
  "TimeZone": "Required String [max length 256]",
  "StartTime": "Required [Thh:mm:ssZ]",
  "EndTime": " Optional [Thh:mm:ssZ]",
  "Billable": "Bool",
  "Invoiced": "Bool",
  "PersonnelAssignedEmailSent": "Bool",
  "AttendeeViewdisplay": "Bool",
  "Deleted": "Int [1 or 0]"
}

Response Codes:

HTTP Status	Description
200	Operation successful. Schedule Instructor object returned in response
400	Operation not successful. The response contains error information
404	Operation not successful. Schedule Instructor object not found

Sample Response Data:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "AssignmentId": 493339,
      "ScheduleId": 3600,
      "InstructorId": "58",
      "StartDate": "2023-05-30",
      "EndDate": "2023-05-30",
      "TimeZone": "(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna",
      "StartTime": "15:00",
      "EndTime": "16:00",
      "Billable": false,
      "Invoiced": false,
      "PersonnelAssignedEmailSent": false,
      "AttendeeViewdisplay": false,
      "Deleted": 1,
      "Modified": {
        "CreatedBy": "CKUNTAMU",
        "CreatedDate": "2023-04-27T12:37:36.727Z",
        "UpdatedBy": "CKUNTAMU",
        "UpdatedDate": "2023-04-27T12:49:02.687Z"
      },
      "Links": [
        {
          "Rel": "Self",
          "Href": "/schedules/3600/instructors",
          "Method": "GET"
        },
        {
          "Rel": "Instructor",
          "Href": "/instructors/493339",
          "Method": "GET"
        }
      ]
    },
    {
      "AssignmentId": 493340,
      "ScheduleId": 3600,
      "InstructorId": "29",
      "StartDate": "2023-05-30",
      "EndDate": "2023-05-30",
      "TimeZone": "(GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London",
      "StartTime": "04:00",
      "EndTime": "05:00",
      "Billable": true,
      "Invoiced": true,
      "PersonnelAssignedEmailSent": true,
      "AttendeeViewdisplay": true,
      "Deleted": 0,
      "Modified": {
        "CreatedBy": "CKUNTAMU",
        "CreatedDate": "2023-04-28T05:47:21.387Z",
        "UpdatedBy": "CKUNTAMU",
        "UpdatedDate": "2023-04-28T05:47:37.52Z"
      },
      "Links": [
        {
          "Rel": "Self",
          "Href": "/schedules/3600/instructors",
          "Method": "GET"
        },
        {
          "Rel": "Instructor",
          "Href": "/instructors/493340",
          "Method": "GET"
        }
      ]
    }
  ]
}

Get Single Instructor Assigned to a Schedule

Returns a single Instructor detail assigned to a schedule for a given AssignmentId.

Note: All requests must be Authenticated.

Authentication and Authorization

Information used for API authentication and authorization is submitted in the request header. The following header values are required with each request.

Header	Description
CompanyLoginId	Company Login Id (provisioned by ViewCentral account management)
ProductId	Product Id. 1=Learning Management, 2=Event Management
Username	User account username
Password	User account password

Request: Provide schedule Id and Assignment Id in URL. Gets the specific Instructor details assigned to the schedule object.

URI: GET https://api.viewcentral.com/api/Schedules/{ScheduleId}/Instructors/{AssignmentId}

Response Example:

{
  "AssignmentId": "Required int [max length 10]",
  "ScheduleId ": "Required Int [max length 10]",
  "InstructorId ": "Required int [max length 10]",
  "StartDate ": "Required date [yyyy-mm-dd]",
  "EndDate ": "Optional date [yyyy-mm-dd] ",
  "TimeZone ": "Required String [max length 256]",
  "StartTime ": "Required [Thh:mm:ssZ]",
  "EndTime ": " Optional [Thh:mm:ssZ]",
  "Billable ": "Bool",
  "Invoiced ": "Bool",
  "PersonnelAssignedEmailSent ": "Bool",
  "AttendeeViewdisplay ": "Bool",
  "Deleted": "Int [1 or 0]"
}

Response Codes:

HTTP Status	Description
200	Operation successful. Schedule Instructor object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. Schedule Instructor object not found

Sample Response Data:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "AssignmentId": 493340,
      "ScheduleId": 3600,
      "InstructorId": "29",
      "StartDate": "2023-05-30",
      "EndDate": "2023-05-30",
      "TimeZone": "(GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London",
      "StartTime": "04:00",
      "EndTime": "05:00",
      "Billable": true,
      "Invoiced": true,
      "PersonnelAssignedEmailSent": true,
      "AttendeeViewdisplay": true,
      "Deleted": 0,
      "Modified": {
        "CreatedBy": "CKUNTAMU",
        "CreatedDate": "2023-04-28T05:47:21.387Z",
        "UpdatedBy": "CKUNTAMU",
        "UpdatedDate": "2023-04-28T05:47:37.52Z"
      },
      "Links": [
        {
          "Rel": "Self",
          "Href": "/schedules/3600/instructors",
          "Method": "GET"
        },
        {
          "Rel": "Instructor",
          "Href": "/instructors/493340",
          "Method": "GET"
        }
      ]
    }
  ]
}

Post/Assign Instructor to a Schedule

Assigns Instructor to a schedule via Litmos Training Ops API

Note: All requests must be Authenticated.

Authentication and Authorization

Information used for API authentication and authorization is submitted in the request header. The following header name/values are required with each request.

Header	Description
CompanyLoginId	Company Login Id (provisioned by ViewCentral account management)
ProductId	Product Id. 1=Learning Management, 2=Event Management
Username	User account username
Password	User account password

Request: Provide instructor to schedule object in request body. Assignment is based on schedule ID.

URI: POST https://api.viewcentral.com/api/Schedules/{ScheduleId}/Instructor

Request Example:

{
  "ScheduleId ": "Required Int [max length 10]",
  "InstructorId ": "Required int [max length 10]",
  "StartDate ": "Required date [yyyy-mm-dd]",
  "EndDate ": "Optional date [yyyy-mm-dd]",
  "TimeZone ": "Required String [max length 256]",
  "StartTime ": "Required [Thh:mm:ssZ]",
  "EndTime ": " Optional [Thh:mm:ssZ]",
  "Billable ": "Bool",
  "Invoiced ": "Bool",
  "PersonnelAssignedEmailSent ": "Bool",
  "AttendeeViewdisplay ": "Bool"
}

Response Codes:

HTTP Status	Description
200	Operation successful. Schedule Instructor object returned in response
400	Operation not successful. The response contains error information
404	Operation not successful. Schedule Instructor object not found

Error Messages:

Please provide a valid Instructor Id."
Schedule Id does not exist
End Date should be greater than start Date
Instructor Id does not exist
Specified Instructor is Inactive
End time should be greater than start time
Enter valid date format
Instructor field is required
Start date field is required
Start date is invalid
End date is invalid
Start time field is required
Start time is invalid
End time field is required
End time is invalid
Billable field is required it should be either true or false
Invoiced field is required it should be either true or false
PersonnelAssignedEmailSent field is required it should be either true or false
AttendeeViewdisplay field is required it should be either true or false
TimeZone field is required
Please provide a valid Instructor Id
Requested data is invalid
Invalid TimeZone

Sample Error Output:

{
  "Success": false,
  "Error": [
    {
      "Code": "INVALID_DATA",
      "Message": "Value supplied is invalid",
      "MessageDetail": "Instructor Id does not  exist"
    }
  ],
  "Data": null
}

Sample Response Data:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "AssignmentId": 493341,
      "ScheduleId": 3600,
      "InstructorId": "60",
      "StartDate": "2023-04-29",
      "EndDate": "2023-04-30",
      "TimeZone": "(GMT-06:00) Central Time (US & Canada)",
      "StartTime": "15:00",
      "EndTime": "16:00",
      "Billable": true,
      "Invoiced": true,
      "PersonnelAssignedEmailSent": true,
      "AttendeeViewdisplay": true,
      "Modified": {
        "CreatedBy": "CKUNTAMU",
        "CreatedDate": "2023-04-28T06:09:11.937Z",
        "UpdatedBy": null,
        "UpdatedDate": null
      },
      "Links": [
        {
          "Rel": "Self",
          "Href": "/schedules/3600/instructors",
          "Method": "GET"
        },
        {
          "Rel": "Instructor",
          "Href": "/instructors/493341",
          "Method": "GET"
        }
      ]
    }
  ]
}

Update Schedule - Instructor

Update schedule instructor assignment based on Schedule Id and Assignment Id via Litmos Training Ops API.

Note: The virtual meeting host assigned in the schedule definition page is reflected under the "Personnel" tab. The PUT method is not supported to change the "Instructor Id," which is the same behavior from the admin view. The other fields, like Start Date, End Date, Start Time, End Time, Timezone, Billable, Invoiced, etc., can be updated for the same personnel.

Note: All requests must be Authenticated.

Authentication and Authorization

Information used for API authentication and authorization is submitted in the request header. The following header values are required with each request.

Header	Description
CompanyLoginId	Company Login Id (provisioned by ViewCentral account management)
ProductId	Product Id. 1=Learning Management, 2=Event Management
Username	User account username
Password	User account password

Request: Provide updated ScheduleId and AssignmentId in the URL.

URI: POST https://api.viewcentral.com/api/Schedules/{ScheduleId}/Instructor/{AssignmentId}

Request Example:

{
  "InstructorId": "Required int[max length 10]",
  "StartDate": "Required date [yyyy-mm-dd]",
  "EndDate": "Optional date [yyyy-mm-dd]",
  "TimeZone": "Required String [max length 256]",
  "StartTime": "Required [Thh:mm:ssZ]",
  "EndTime": " Optional [Thh:mm:ssZ]",
  "Billable": "Bool",
  "Invoiced": "Bool",
  "PersonnelAssignedEmailSent": "Bool",
  "AttendeeViewdisplay": "Bool"
}

Response Codes:

HTTP Status	Description
200	Operation successful. Schedule Instructor object returned in response
400	Operation not successful. The response contains error information
404	Operation not successful. Schedule Instructor object not found

Error Messages:

Please provide a valid Instructor Id.
Assignment Id does not exist
Instructor Id cannot be edited.
Schedule Id does not exist
End Date should be greater than start Date
Instructor Id does not exist
Specified Instructor is Inactive
End time should be greater than start time
Enter valid date format
Instructor field is required
Start date field is required
Start date is invalid
End date is invalid
Start time field is required
Start time is invalid
End time field is required
End time is invalid
Billable field is required it should be either true or false
Invoiced field is required it should be either true or false
PersonnelAssignedEmailSent field is required it should be either true or false
AttendeeViewdisplay field is required it should be either true or false
TimeZone field is required
Please provide a valid Instructor Id.
Requested data is invalid
Invalid TimeZone

Sample Error Output

{
  "Success": false,
  "Error": [
    {
      "Code": "INVALID_DATA_REFERENCE_CODE",
      "Message": "Reference code supplied is invalid",
      "MessageDetail": "Invalid TimeZone :(GMT--06:00) Central Time (US & Canada) provided."
    }
  ],
  "Data": null
}

Sample Response Data:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "AssignmentId": 493340,
      "ScheduleId": 3600,
      "InstructorId": "58",
      "StartDate": "2023-05-30",
      "EndDate": "2023-05-30",
      "TimeZone": "(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna",
      "StartTime": "15:00",
      "EndTime": "16:00",
      "Billable": false,
      "Invoiced": false,
      "PersonnelAssignedEmailSent": false,
      "AttendeeViewdisplay": false,
      "Modified": {
        "CreatedBy": "CKUNTAMU",
        "CreatedDate": "2023-04-28T05:47:21.387Z",
        "UpdatedBy": "CKUNTAMU",
        "UpdatedDate": "2023-04-28T06:13:57.283Z"
      },
      "Links": [
        {
          "Rel": "Self",
          "Href": "/schedules/3600/instructors",
          "Method": "GET"
        },
        {
          "Rel": "Instructor",
          "Href": "/instructors/493340",
          "Method": "GET"
        }
      ]
    }
  ]
}

Delete Schedule Instructor Assignment

Un-assign instructor from schedule using Schedule Id and Assignment Id via Litmos Training Ops API. This deletion is soft delete mechanism.

Note: All requests must be Authenticated.

Authentication and Authorization

Information used for API authentication and authorization is submitted in the request header. The following header values are required with each request.

Header	Description
CompanyLoginId	Company Login Id (provisioned by ViewCentral account management)
ProductId	Product Id. 1=Learning Management, 2=Event Management
Username	User account username
Password	User account password

Request:ScheduleId and AssignmentId to be provided in the URL.

URI: DELETE https://api.viewcentral.com/api/Schedules/{ScheduleId}/Instructor/AssignmentId}

Response Codes:

HTTP Status	Description
200	Operation successful. Schedule Instructor object returned in response
400	Operation not successful. The response contains error information
404	Operation not successful. Schedule Instructor object not found

Error Messages:

Delete Method is not supported for this Instructor Id.