Examples - Public Sector Constituency Web Access - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external

The following examples are used to illustrate how common tasks in the Public Access Viewer may be replicated in the integrated website by using API controls.

Finding and Viewing a Document using a Custom Query

1. Use /api/CustomQuery to display a list to the user. The user can select which Custom Query to use for the search.
2. Use /api/Keywords to get the list of searchable keywords based on the selected Custom Query. Since this is being used for a Custom Query, the long QueryID parameter is included in the payload.
3. Use /api/CustomQuery/KeywordSearch to perform the search, making sure to pass in the Custom Query ID and search values entered by the user.
4. Use /api/Document/[id] to get the Document image to display based on the results of the Custom Query keyword search.

Finding and Viewing a Document using Full-Text Search

1. Use /api/DocumentType to display a list to the user. The user can select which Document Type to use for the search.
2. Display search input fields by using the values for the /api/DocumentType/FullTextSearch payload.
3. Use /api/DocumentType/FullTextSearch to execute the search based on the user's input.
4. Display the full-text search results to the user.
5. Use /api/Document/[id] to get the Document image to display based on the results of the full-text search.