GET APPDASHBOARD

Main Application Dashboard

Parameters
Name Description
AppLink *Required
string
 Link Type
ProjectId *Required
long
 Project ID
MenuLink
string
 Navigation Toolbar Menu Item to initially open. Values for MenuLink are generally the same as the UI Link values for the service, with the following aliases supported. 'ContainerViewer' : Viewer, 'DocumentUpload' : Upload, 'FileCatalog' : FileRoom, 'ProjectDashboard' : AppDashboard, 'ProjectAdmin' : Admin, 'SearchDashboard' : Search, 'BarcodeDashboard' : Barcode, 'BundleDashboard' : Bundle, 'BatchDashboard' : Batch
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET BATCHDASHBOARD

Batch Processing Dashboard UI

Parameters
Name Description
AppLink *Required
string
 Link Type
ProjectId *Required
long
 Project ID
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET CONTAINERBUNDLE

ContainerBundle

Parameters
Name Description
AppLink *Required
string
 Link Type
ProjectId *Required
long
 Project ID
ContainerKey *Required
long
 Key to Reference Loan Container; A Unique ID Provided by the LOS.
ProfileCode
long
 If set, initially selects this Bundle Profile.
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET CONTAINERVIEWER

Container Document Viewer UI

Parameters
Name Description
AppLink *Required
string
 Link Type
ProjectId *Required
long
 Project ID
ContainerKey *Required
int
 Key to Reference Loan Container; A Unique ID Provided by the LOS.
DocumentId
long
 Internal Id of the Document to initially open.
DocumentRef
string
 External Reference set on the Document when uploaded via APIs. The Viewer will open directly to this Document for the Container.
DocumentType
string
 Document Definition Schema Id or Reference Code. If set and the DocumentId parameter is empty, the Viewer will attempt to open the first Current Document of this type for the Container.
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET DOCUMENTUPLOAD

Document Upload UI

Parameters
Name Description
AppLink *Required
string
 Link Type
ProjectId *Required
long
 Project ID
ContainerKey
long
 If set, the Container will default to this Object from the Integrated Application
DocumentType
string
 Document Definition Schema Id or Reference Code. If set, the Document Type field in the UI will default to this value.
UploadInColor
bool
 Document Definition Schema Id or Reference Code. If set, the Document Type field in the UI will default to this value.
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET FILECATALOG

File Room UI

Parameters
Name Description
AppLink *Required
string
 Link Type
ProjectId *Required
long
 Project ID
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET PROJECTADMIN

Administration Dashboard.

Parameters
Name Description
AppLink *Required
string
 Link Type
ProjectId *Required
long
 Project ID
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET PROJECTDASHBOARD

Main Application Dashboard UI including top logo / logon bar.

Parameters
Name Description
AppLink *Required
string
 Link Type
ProjectId *Required
long
 Project ID
MenuLink
long
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET SEARCHDASHBOARD

Container Search UI

Parameters
Name Description
AppLink *Required
string
 Link Type
ProjectId *Required
long
 Project ID
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed