LTO REST API: Schedule (Get, Create, Update)

Schedule API (Get, Create and Update)

Get Schedules : Provides the details of schedule via Litmos Commerce 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 URI :

Get details of all schedules in Litmos commerce application (subscription listing and bundle are excluded) –

GET https://api.viewcentral.com/api/schedules/

Response Codes:

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

Response Example:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "ApprovalStatus": "String [max length 50]",
      "CancellationDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "CancellationReason": " String [max length 255]",
      "DisplayEndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "DisplayStartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "DisplayInAttendeeView": "Bool",
      "DurationType": " String [max length 50]",
      "Duration": " Numeric [max length 10]",
      "EndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "EndTime": "Thh:mm:ssZ ",
      "Url": " String [max length 255]",
      "Id": "Int [max length 4] ",
      "ImageUrl": " String [max length 255]",
      "ImageUrl2": " String [max length 255]",
      "ForecastedExpense": "Decimal [max length 14]",
      "ForcastedRevenue": "Decimal [max length 14]",
      "ForcastedSeats": 2,
      "IsSubSchedule": false,
      "Language": "French",
      "MaxSeats": "Int [max length 4] ",
      "MinSeats": "Int [max length 4] ",
      "NumberOfCredits": "Numeric [max length 13]",
      "RegistrationEndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "RegistrationEndTime": " ddThh:mm:ssZ]",
      "RegistrationStartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "GroupId": "String [max length 50]",
      "Name": " String [max length 255]",
      "Status": " String [max length 50]",
      "SeatsTaken": "Int [max length 4] ",
      "StartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "StartTime": " Thh:mm:ssZ]",
      "TimeZone": "String [max length 72]",
      "TrainingHours": "Numeric [max length 10]",
      "CustomDetail1": "String [max length 1024]",
      "CustomDetail2": "String [max length 1024]",
      "CustomDetail3": "String [max length 1024]",
      "CustomDetail4": "String [max length 1024]",
      "CustomDetail5": "String [max length 1024]",
      "CustomDetail6": "String [max length 1024]",
      "InheritBusinessUnitFromCourse": "Bool",
      "UseCourseDuration": "Bool",
      "TotalAttendedRegistrations": "Int [max length 4] ",
      "CourseTypes": [
        "String",
        "String"
      ],
      "DeliveryMethod": "Required string [max length 1024]",
      "BusinessUnit": {
        "ID": "Int [max length 4] "
      },
      "Location": {
        "ID": "Int [max length 4] "
      },
      "Course": {
        "ID": "Int [max length 4] "
      },
      "Sublocation": {
        "ID": "Int [max length 4] "
      },
      "Modified": {
        "CreatedBy": "string [max length 50]",
        "CreatedDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
        "UpdatedBy": "string [max length 50]",
        "UpdatedDate": "datetime [yyyy-mm-ddThh:mm:ssZ]"
      },
      "Links": [
        {
          "Rel": "Self",
          "Href": "/schedules/{id}",
          "Method": "GET"
        },
        {
          "Rel": "Schedule Personnel",
          "Href": "/schedules/{id}/instructors",
          "Method": "GET"
        },
        {
          "Rel": "Schedule Equipments",
          "Href": "/schedules/{id}/equipments",
          "Method": "GET"
        },
        {
          "Rel": "Schedule Translations",
          "Href": "/schedules/{id}/translations",
          "Method": "GET"
        }
      ]
    }
  ]
}

Get details of schedule using filter in Litmos commerce application (subscription listing and bundle are excluded) –

GET https://api.viewcentral.com/api/schedules?name=

Request Filters : Name = schedule name.

Sl.No	Key	Value
1	name	String [max length 255]

Response Codes:

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

Get details of schedule using schedule id in Litmos commerce application (subscription listing and bundle are excluded) –

GET https://api.viewcentral.com/api/schedules/{ID}

Response :

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

Create Schedule ( ClassRoom only) :

Create schedule via Litmos Commerce API. (Provide course object in request body).

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 created schedule object in request body

URI: POST https://api.viewcentral.com/api/Schedules

Request Example :

{
  "DisplayStartDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "DisplayEndDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "DisplayInAttendeeView": "Bool",
  "DurationType": "Optional String [max length 50]",
  "Duration": "Optional Numeric [max length 10]",
  "StartDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "StartTime": "Optional [Thh:mm:ssZ]",
  "EndDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "EndTime": "Optional [hh:mm:ssZ]",
  "Url": "Optional String [max length 255]",
  "ImageUrl": "Optional String [max length 255]",
  "ImageUrl2": "Optional String [max length 255]",
  "Language": "Optional String [max length 50]",
  "MinSeats": "Required Int [max length 4]",
  "MaxSeats": "Required  Int [max length 4]",
  "NumberOfCredits": "Optional Numeric [max length 13]",
  "RegistrationStartDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "RegistrationEndDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "RegistrationEndTime": "Optional ddThh:mm:ssZ",
  "GroupId": "Optional String [max length 50]",
  "Name": "Optional String [max length 255]",
  "Status": "Required String [max length 50]",
  "TimeZone": "Optional String [max length 72]",
  "TrainingHours": "Optional Numeric [max length 10]",
  "CustomDetail1": "Optional String [max length 1024]",
  "CustomDetail2": "Optional String [max length 1024]",
  "CustomDetail3": "Optional String [max length 1024]",
  "CustomDetail4": "Optional String [max length 1024]",
  "CustomDetail5": "Optional String [max length 1024]",
  "CustomDetail6": "Optional String [max length 1024]",
  "InheritBusinessUnitFromCourse": "Bool",
  "UseCourseDuration": "Bool",
  "CourseTypes": [
    "String",
    "String"
  ] // Optional,
  "BusinessUnit": {
    "ID": "Optional Int [max length 4]"
  },
  "Location": {
    "ID": "Required Int [max length 4]"
  },
  "Course": {
    "ID": "Required Int [max length 4]"
  },
  "DeliveryMethod": "Required  string [max length 1024]"
}

Response Codes:

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

Update Schedule ( ClassRoom only) :

Update schedule via Litmos Commerce API. (Provide course object in request body).

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 updated schedule object in request body.

URI: PUT https://api.viewcentral.com/api/schedules/{ID}

NOTE: this operation supports complete object update as well as partial object update. If the API request data does not supply ALL properties/fields with their intended values, the fields not supplied will be assigned the default value: NULL. If record previously had data in this field, the value will now be set to previous value. For example, course record is added with the ‘Full Description’ set to “Course FD”. With the API (PUT action) to update, if the course.‘Full Description’ property is not supplied in the API request, the ‘Full Description’ value will not be changed means it has value of “Course FD”.

Request example:

{
  "DisplayStartDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "DisplayEndDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "DisplayInAttendeeView": "Bool",
  "DurationType": "Optional String [max length 50]",
  "Duration": "Optional Numeric [max length 10] ",
  "StartDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "StartTime": "Optional [Thh:mm:ssZ]",
  "EndDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "EndTime": "Optional [hh:mm:ssZ]",
  "Url": "Optional String [max length 255]",
  "ImageUrl": "Optional String [max length 255]",
  "ImageUrl2": "Optional String [max length 255]",
  "Language": "Optional String [max length 50]",
  "MinSeats": "Required Int [max length 4]",
  "MaxSeats": "Required  Int [max length 4]",
  "NumberOfCredits": "Optional Numeric [max length 13]",
  "RegistrationStartDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "RegistrationEndDate": "Optional datetime [yyyy-mm-ddThh:mm:ssZ]",
  "RegistrationEndTime": "Optional [ddThh:mm:ssZ]",
  "GroupId": "Optional String [max length 50]",
  "Name": "Optional String [max length 255]",
  "Status": "Required String [max length 50]",
  "TimeZone": "Optional String [max length 72]",
  "TrainingHours": "Optional Numeric [max length 10]",
  "CustomDetail1": "Optional String [max length 1024]",
  "CustomDetail2": "Optional String [max length 1024]",
  "CustomDetail3": "Optional String [max length 1024]",
  "CustomDetail4": "Optional String [max length 1024]",
  "CustomDetail5": "Optional String [max length 1024]",
  "CustomDetail6": "Optional String [max length 1024]",
  "InheritBusinessUnitFromCourse": "Bool",
  "UseCourseDuration": "Bool",
  "CourseTypes": [
    "String",
    "String"
  ] //Optional,
  "BusinessUnit": {
    "ID": "Optional Int [max length 4]"
  },
  "Location": {
    "ID": "Required Int [max length 4]"
  },
  "Course": {
    "ID": "Required Int [max length 4]"
  },
  "DeliveryMethod": "Required  string [max length 1024]"
}

Response Codes:

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

Litmos Training Operations Documentation

APIs

LTO REST API: Schedule (Get, Create, Update)

Useful Links

In this article

Related articles