Instructor API (Get)
Get Instructors: Provides the details (list/by id) of Instructors 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 :
1. Get list of all instructors in Litmos commerce application –
GET https://api.viewcentral.com/api/instructors
Response Codes:
| HTTP Status | Description |
| 200 | Operation successful. Instructor object returned in response |
| 400 | Operation not successful. Response contains error information |
| 404 | Operation not successful. Instructor object not found |
Response Example:
{
"Success": true,
"Error": null,
"Data": [
{
"Active": "true/false",
"BeginDate": " datetime [yyyy-mm-ddThh:mm:ssZ]",
"Mobile": "String [max length 50]",
"City": "String [max length 200]",
"Country": "string [max length 2, See Country list]",
"RateCurrency": "String [max length 3] , See Currency list",
"Email": "string [max length 256]",
"EndDate": " datetime [yyyy-mm-ddThh:mm:ssZ]",
"PhoneExt": "String [max length 10]",
"ExternalId": "String [max length 50]",
"Fax": "String [max length 50]",
"FirstName": "string [max length 100]",
"Initials": "string [max length 10]",
"Id": "Int [max length 4]",
"Type": "string [max length 50]",
"Url": "string [max length 255]",
"LastName": "string [max length 100]",
"LocationGroup": "string [max length 100]",
"ManagerEmail": "string [max length 50]",
"ManagerName": "string [max length 50]",
"MiddleName": "string [max length 50]",
"OtherStateProvince": "string [max length 200]",
"Pager": "String [max length 50]",
"Phone": "String [max length 50]",
"Pin": "String [max length 10]",
"PostalCode": "String [max length 20]",
"ResourceGroup": "String [max length 100]",
"Salutation": "String [max length 10]",
"StateProvince": "String [max length 100]",
"Street1": "String [max length 50]",
"Street2": "String [max length 50]",
"Rate": "Numeric [max length 5]",
"Title": "String [max length 100]",
"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]"
}
}
]
}
Request URI :
2. Get details of Instructor using instructor id {id} in Litmos commerce application
GET https://api.viewcentral.com/api/instructors/{ID}
Response Codes:
| HTTP Status | Description |
| 200 | Operation successful. Instructor object returned in response |
| 400 | Operation not successful. Response contains error information |
| 404 | Operation not successful. Instructor object not found |