Schedule Equipment API (Get)

Provides the details of Equipment assigned to 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 :

1. Get details of all Equipment assigned to schedule in Litmos commerce application (subscription listing and bundle are excluded) – {id} = schedule id

GET https://api.viewcentral.com/api/schedules/{id}/equipments

Response Codes:

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

Response Example:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "Equipment": [
        "String List"
      ],
      "StartDate": "date [yyyy-mm-dd]",
      "EndDate": "date [yyyy-mm-dd]",
      "TimeZone": "String [max length 72]",
      "StartTime": "[Thh:mm:ssZ]",
      "EndTime": "[Thh:mm:ssZ]"
    },
    "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]"
    }
  ]
}

2. Get details of Equipment assigned to schedule using filter in Litmos commerce application (subscription listing and bundle are excluded) –

GET https://api.viewcentral.com/api/schedules/{id}/equipments?equipment=

Request Filters : Name = Equipment’s name.

Sl.No	Key	Value
1	equipment	String [max length 200]

Response Codes:

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