Search feature via API (2019-06-28)
Caitlin McCabe
Administrator
Original Post: Doug Costain, Moderator, June 28, 2019 at 10:11 AM
As part of the project MOSAIK, the University of Koblenz is working together with an external agency that wants to connect Panopto and its own platform via the API. For this they need access to the Panopto search, however, no corresponding method seems to be apparent from the documentation of the API. Is there a more detailed / up-to-date API or documentation or can you help in any other way?
Posted on behalf
Responses
Hiroshi Ohno, Moderator, June 28, 2019 at 12:19 PM
You may use ISessionManagement.GetSessionsList method in our classic SOAP API.
You may pass search term to searchQuery parameter.
You may also use in our REST API which is new to Panopto 7.
You may pass search term to searchQuery parameter.
https://demo.hosted.panopto.com/Panopto/Api/Docs/index.html#/Sessions/Sessions_SearchForSessions
If your system supports OpenSearch, OpenSearch interface may be a better option than API call.
https://support.panopto.com/s/article/panopto-opensearch-support
Comments
Is searchQuery just a string for searching the title and textual content or something more?
Hi Robin,
The searchQuery parameter should search through the same locations as on the Panopto site. This would include session metadata such as the title, description and creator's user name. It also includes data from within the session including captions, notes, and slides.
Please let me know if you have any other questions.
Thanks,
Kevin
Thanks Kevin. Is the format just a simple string for use as a wildcard search?
Hi Robin,
Yes, that's correct. Both the SOAP API function (ISessionManagement.GetSessionsList) and the REST API function (api/v1/sessions/search) should just take a simple string for the searchQuery. There should be no wildcards or special formatting needed.
Please let me know if you have any other questions, or if you're not getting the expected results.
Thanks,
Kevin