API Guide

S2. User Interface Link Listing

The table below lists the User Interfaces (Links) available by the Service, and their corresponding parameters. Detailed specifications for each Link are available in section 3.

User Interface Link Listing

Link Parameters Description
ContainerViewer ProjectId
ContainerKey
DocumentId
DocumentRef
DocumentType
Container Document Viewer UI
ContainerBundle ProjectId
ContainerKey
ProfileCode
ContainerBundle
DocumentUpload ProjectId
ContainerKey
DocumentType
Document Upload UI
FileCatalog ProjectId File Room UI
ProjectAdmin ProjectId Administration Dashboard.
ProjectDashboard ProjectId
MenuLink
Main Application Dashboard UI including top logo / logon bar.
SearchDashboard ProjectId Container Search UI
BarcodeDashboard ProjectId Barcode Dashboard UI
BundleDashboard ProjectId Bundle Dashboard UI
BatchDashboard ProjectId Batch Processing Dashboard UI

Common Parameters across many User Interfaces

Name Data Type Examples Notes
ContainerKey String 4456278 Internal Id of the Object in the Integrated Application. E.g.: loan id, employee id.
ContainerRef String 123456789 Human Readable Unique Key of the Object in the Integrated Application. E.g.: loan number, employee user name.