API Configuration for Website UI - Public Sector Constituency Web Access - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external

Public Sector Constituency Web Access
Platform
OnBase
Product
Public Sector Constituency Web Access
Release
Foundation 24.1
License

Public Access components can be customized to complement the website they integrate with. You can add the Public Access Viewer API controls to your own .aspx page and use custom CSS style sheets to maintain a consistent look and feel across the website.

The following API controls are available:

Resource Method Description
/api/DocumentType Get Returns a list of available Document Types in ID/Name pairs.
/api/DocumentType/FullTextSearch Post Returns results of a full-text search using parameters specified in the following payload:
string SearchText [Required]
DateTime? FromDate
DateTime? ToDate
long? DocTypeID
long? QueryID
Keyword[] Keywords [Required if DocTypeID is specified]
long? QueryLimit
Keyword Properties:
	long ID
	string Value
	string KeywordOperator ("=", "<", etc)
	string Relation ("AND", "OR")
/api/CustomQuery Get Returns a list of available Custom Queries.
/api/CustomQuery/KeywordSearch Post Returns results of a search on a particular Custom Query using parameters specified in the following payload:
string FolderID [One of Folder or Query ID is required]
string QueryID [One of Folder or Query ID is required]
DateTime? FromDate
DateTime? ToDate
Keyword[] Keywords
long? QueryLimit		
Keyword Properties:
	long ID
	string Value
	string KeywordOperator ("=", "<", etc)
	string Relation ("AND", "OR")
/api/Keywords Post Returns a list of searchable keywords for either a Custom Query or a Document Type, depending on the parameter found in the payload.
  • To return a list of keywords for a Custom Query, use long QueryID in the payload.
  • To return a list of keywords for a Document Type, use long DocTypeID in the payload.
/api/Document/[id] Get Returns the document based on the Document ID entered in the place of "[id]". The document is returned in a byte stream.
/api/Document/[id] Post Returns a document's information based on the Document ID entered in the place of "[id]". The information returned is the document's size and Viewer Mode (such as "PDF").