Adobe 65029902 User Guide - Page 23

USING ROBOHELP SERVER 8 20 Managing the server RoboHelp Server provides sample files in four languages: Visual Basic, VC++, C#, and JavaScript. All the sample files in different languages, other than JavaScript, are stored in different folders. For example, a Visual Basic folder is named Sample_RoboHelp_CSH_VB. All the language-specific sample folders also contain solution files (.sln files) to open and run them in Visual Studio. Using these samples, you can perform search and Robowindow service from REST services on the projects published on the RoboHelp Server. The result of the query is responded in XML format. You can use the results to be displayed in different formats or for scripting purposes. In the samples, the search results are displayed in a table format. The columns display rank, title, the URL, and the summary links to the relevant topics of the specified project. To get a RoboWindow using the REST web services, select one of the following options: • To get the window properties and Help URL for a context ID, use the HTTP GET method and send the query in the following format: URL: http:////rest/robowindow?wtype=ctx&project=&context=&area=[&type=flashhelp] • To get the window properties and Help URL for a given window name, use the HTTP GET method and send your query in the following format: URL: http:////rest/robowindow?wtype=prj&project=&wnd=&area=[&type=flashhelp] Note: The method to get the Robowindow is same for both public and protected areas. The RoboHelp Server sends the response for both public and private areas in the same format: Send a search query to RoboHelp server • Public area When you send a search request to a public area, use the HTTP GET method. You can use the following format for your search query: URL : http://[:port-num]//rest/search?project=&area=&quesn=[&type=flashhelp] The server sends the response in the following XML format: • Protected area To send a query request to a protected area, use the HTTP POST method. Use the following format for your search query: URL : http://[:port-num]//rest/search For the query request to a protected area, enter a Request body. [] The RoboHelp server sends the response in the following format: