API Guide

S3. User Interface Link Details

3.1. Link: CONTAINERVIEWER Input Parameters:

Parameter Data Type Required Sample Data Description
ProjectId String Yes 1000 XDOC Project ID.
ContainerKey String Yes 12345 Internal Id of the Object in the Integrated Application.
DocumentId String 20100123123 Internal Id of the Document to initially open.
DocumentRef String 1234 External Reference set on the Document when uploaded via APIs. The Viewer will open directly to this Document for the Container.
DocumentType String APPRAISAL 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.

URL Invocation Example:

/XDocUIService.ashx?AppLink=CONTAINERVIEWER&ProjectId=1000&ContainerKey=12345&XST=

3.2. Link: CONTAINERBUNDLE Input Parameters:

Parameter Data Type Required Sample Data Description
ProjectId String Yes 1000 XDOC Project ID.
ContainerKey String Yes 12345 If set, the Container will default to this Object from the Integrated Application
ProfileCode String If set, initially selects this Bundle Profile.

URL Invocation Example:

/ XDocUIService.ashx?AppLink=CONTAINERBUNDLE&ProjectId=1000&ContainerKey=12345&XST=

3.3. Link: DOCUMENTUPLOAD Input Parameters:

Parameter Data Type Required Sample Data Description
ProjectId String Yes 1000 XDOC Project ID.
ContainerKey String 12345 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 Boolean 1 If set to 1, the “upload” in color checkbox will be initially set.

URL Invocation Example:

/ XDocUIService.ashx?AppLink =DOCUMENTUPLOAD& ProjectId=1000&ContainerKey=12345&XST=

3.4. Link: APPDASHBOARD Input Parameters:

Parameter Data Type Required Sample Data Description
ProjectId String Yes 1000 XDOC Project ID.
MenuLink String PROJECTADMIN 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

URL Invocation Example:

/ XDocUIService.ashx?AppLink=APPDASHBOARD&ProjectId=1000&XST=

3.5. Link: PROJECTDASHBOARD Input Parameters:

Parameter Data Type Required Sample Data Description
ProjectId String Yes 1000 XDOC Project ID.
MenuLink String PROJECTADMIN Toolbar Menu Item to initially open. Values for MenuLink are the same as the general “LINK” values for this service.

URL Invocation Example:

/ XDocUIService.ashx?AppLink=PROJECTDASHBOARD&ProjectId=1000&XST =

3.6. Link: PROJECTADMIN Input Parameters:

Parameter Data Type Required Sample Data Description
ProjectId String Yes 1000 XDOC Project ID.

URL Invocation Example:

/ XDocUIService.ashx?AppLink=PROJECTADMIN&ProjectId=1000&XST =

3.7. Link: FILECATALOG Input Parameters:

Parameter Data Type Required Sample Data Description
ProjectId String Yes 1000 XDOC Project ID.

URL Invocation Example:

/ XDocUIService.ashx?AppLink=FILECATALOG&ProjectId=1000&XST =

3.8. Link: SEARCHDASHBOARD Input Parameters:

Parameter Data Type Required Sample Data Description
ProjectId String Yes 1000 XDOC Project ID.

URL Invocation Example:

/ XDocUIService.ashx?AppLink=SEARCHDASHBOARD&ProjectId=1000&XST =

3.9. Link: BATCHDASHBOARD Input Parameters:

Parameter Data Type Required Sample Data Description
Project String Yes 1000 XDOC Project ID.

URL Invocation Example:

/ XDocUIService.ashx?AppLink=BATCHDASHBOARD&ProjectId=1000&XST =