The Course Evaluations & Surveys REST API offering is inline with current industry standard API approaches and is available to our customers at no additional charge.
NOTE
The required knowledge to use the Rest API feature resides at your institution.
Watermark Course Evaluations & Surveys Support does not provide training in the use of REST API. However, please contact Support (click Submit A Request from the Help Center) if you are having a technical issue with a function.
NOTE
To use the REST API feature you will first need to request a token. Please contact Support (click Submit A Request from the Help Center) to acquire a token.
The Course Evaluations & Surveys API documentation is located in Course Evaluations & Surveys under Account > API (section) > Documentation. REST API documentation is only available to CES Administrators.
REST API
The REST API provides you with an integration point into your Course Evaluations & Surveys account for accessing and extracting, creating and modifying data within the system, all of which is accomplished externally from our main application, using your own programs and scripting. Interacting with our API will require a developer with relevant knowledge and skills within your organization, but a REST API is far easier and less time to integrate than SOAP API.
To use the REST API you will first need to request a token from Course Evaluations & Surveys , by contacting Support (click Submit A Request from the Help Center)
To access the Course Evaluations & Surveys REST API documentation, navigate to: Account API Documentation. REST API documentation is only available to CES Administrators.
REST API key functionality includes:
Ability to extract survey raw data results directly via the API. Customers can integrate with the API to also extract metadata of interest along with the raw data results, for instance, desired course and user metadata, and survey question metadata. As well, customers can populate an unlimited number of additional custom user and course data fields in the system, which can also be extracted along with the raw data results.
REST API allows customers to add, modify, and delete courses and users in projects. In addition to the standard course and user fields (students and instructors), customers can add an unlimited number of additional custom fields via the API for your course, students, and instructors. The REST API also allows creation and modification of Projects. Also supported in the REST API, customers can use the API for real-time monitoring of respondents and non-respondents within projects, and access all relevant course and user metadata as desired when doing so. This can be useful if you wish to pull this information in real-time (vs just at the end of the project) directly into another system while the project is still open.
