Language: Sample Response:

Application Service Methods

GET App.ApiTest

Used to Test Connectivity and API Protocol Handshaking

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
IsError
bool
Set IsError = 1 to Generate an Error Response
InputData
string
Will Be Included in Response Headers and XML Payload 'ReturnData' Field
Responses
XwsResultCode XwsResultInfo
0 Success
4001 Simulated Error
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

System Service Methods

GET System.AppVersionHistory

Shows full version installation and update history, listing records for the base install and every product update.

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
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 System.AppVersionInfo

Outputs current production version information.

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
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 System.SecurityProfileInfo

Used to get Security Profile Information in XML format including Project Grants.

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
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

Project Service Methods

GET Project.DocumentStackList

Returns a list of Document Stacks for the project, optionally filtered by the Include related usage parameters.

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
UsageFlags
int
UsageFlags is a bit mask indicating which stacks to include in the results; 1 = Marked for use in Security Profiles, 2 = Marked for use in Printing, 4 = Marked for use in Bundling, 8 = Marked for use in Viewing (Viewers)
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET Project.DocumentStackProfileList

Equivalent to DocumentStackList, but only includes Stacks marked for use in Profiles.

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId
long
Project ID
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET Project.DocumentStackTypeList

Returns a list of Document Type definitions for the project and Document Stack.

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
StackCode *Required
string
The StackCode can either be the internal Document Stack 19 digit id, or the Document Stack Code, which is unique by Project.
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET Project.DocumentTypeList

Returns a list of Document Type definitions (Document Schemas) for the project.

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
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

Container Service Methods

GET Container.BundleSchedule

Creates a new Bundle Package for the container and input Bundle Profile. Returns the Package Id of the generated package


This method kicks off the Bundle Workflow for the package - Bundle Generate, and then Bundle Deliver.

Workflow tasks are visible in the Workflow Monitor.

Bundle Package Info and Status is visible in the Bundle Manager.

Use Container.BundleStatus with the generated PackageId for API monitoring of the status.

The method cannot be used with Bundle Profiles that have a delivery type of 'download'.

Note: This method is only available in XDOC build 6111 or higher
Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
ContainerKey *Required
string
Key to Reference Loan Container; A Unique ID Provided by the LOS. ContainerKey or ContainerRef must be specified.
ContainerRef
string
Alternate User Friendly Unique Key for the Loan; This is the Loan Number in the User Interface. ContainerKey or ContainerRef must be specified.
BundleProfile *Required
string
Profile Code or Internal Profile Id
Responses
XwsResultCode XwsResultInfo
0 Success
4000 Param Value Missing
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed
500 Profile Not Found / Profile Not Valid / Container Not Found

GET Container.BundleStatus

Returns Status Info of a Container Bundle Package


A Quick Status Indicator is Returned in the XML Response within the BundlePackage envelope under the StatusLabel attribute and also in the XwsReturnData Response Header Value:
  • 'processing' - bundling is in process
  • 'success' - package generated and delivered successfully
  • 'error' - package generate or delivery failed
  • 'cancelled' - bundling process has been cancelled in the Bundle Manager
  • 'paused' - bundling process has been paused in the Bundle Manager

Note: This method is only available in XDOC build 6111 or higher
Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
PackageId *Required
long
19 digit internal PackageId from BundleSchedule method
Responses
XwsResultCode XwsResultInfo
0 Success
4000 Missing Object Id / PackageId Not Found
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET Container.ContainerInfo

Used to get Container Information in XML format including optionally the Document List, Document Fields, and Document Versions.

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
ContainerId
string
Internal XDOC ID to Reference Loan Container. ContainerId, ContainerKey or ContainerRef must be specified.
ContainerKey *Required
string
Key to Reference Loan Container; A Unique ID Provided by the LOS. ContainerId, ContainerKey or ContainerRef must be specified.
ContainerRef
string
Alternate User Friendly Unique Key for the Loan; This is the Loan Number in the User Interface. ContainerId, ContainerKey or ContainerRef must be specified.
DataIncludeFlags
int
Allows specification of whether to include the Document List, Fields, and Versions; 1 = Document Listing, 2 = Document Fields, 4 = Document Versions
Responses
XwsResultCode XwsResultInfo
0 Success
1202 Param Value Missing
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET Container.DocumentDownload

Writes the binary data of the specified documents to the response stream for download.

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
DocumentId *Required
string
Multiple Documents can be specified by sending multiple DocumentId parameters. If sending multiple DocumentId parameters, then multiple BookmarkLabel parameters can also be sent that match the DocumentId parameter array.
BookmarkLabel
string
If no BookmarkLabel parameters are sent, then the Bookmarks will default to the Document Definition Label or Name.
FormatPdf
string
If FormatPdf = 1, then document will be returned in PDF format. Otherwise, TIF.
AsAttachment
string
Specifying AsAttachment = 1 will result in the Content-Disposition HTTP header on the Response being set to “attachment”. In most browsers, this will result in the Browser giving the user an “open or save” dialog.
FileName
string
The default file name that will appear in the browser “open or save” dialog is using AsAttachment.
Responses
XwsResultCode XwsResultInfo
0 Success
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed
404 Document Not Found

GET Container.DocumentDownloadStack

Downloads all documents for the Container and specified Document Stack.

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
ContainerKey *Required
string
Key to Reference Loan Container; A Unique ID Provided by the LOS. ContainerId or ContainerKey must be specified
ContainerId
string
Internal XDOC ID to Reference Loan Container. ContainerId or ContainerKey must be specified.
StackCode
string
The StackCode can either be the internal Document Stack 19 digit id, or the Document Stack Code, which is unique by Project.
FormatPdf
string
If FormatPdf = 1, then document will be returned in PDF format. Otherwise, TIF.
AsAttachment
string
Specifying AsAttachment = 1 will result in the Content-Disposition HTTP header on the Response being set to “attachment”. In most browsers, this will result in the Browser giving the user an “open or save” dialog.
FileName
string
The default file name that will appear in the browser “open or save” dialog is using AsAttachment.
Responses
XwsResultCode XwsResultInfo
0 Success
401 Object Id Missing / Missing StackCode Parameter
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed
404 Documents Not Found

GET Container.DocumentDownloadType

Same as DocumentDownload, but allows specification of the document by Container and DocumentType instead of the DocumentId.

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
ContainerKey *Required
string
Key to Reference Loan Container; A Unique ID Provided by the LOS. ContainerId or ContainerKey must be specified
ContainerId
string
Internal XDOC ID to Reference Loan Container. ContainerId or ContainerKey must be specified.
DocumentType *Required
string
DocumentType can be set to the Schema Id, Code, or Alternate ID of the Document Definition. If multiple documents exist for the DocumentType, all will be returned unless LastDocumentOnly is set = 1.
FormatPdf
bool
If FormatPdf = 1, then document will be returned in PDF format. Otherwise, TIF.
BookmarkLabel
string
If no BookmarkLabel parameters are sent, then the Bookmarks will default to the Document Definition Label or Name.
AsAttachment
bool
Specifying AsAttachment = 1 will result in the Content-Disposition HTTP header on the Response being set to “attachment”. In most browsers, this will result in the Browser giving the user an “open or save” dialog.
FileName
string
FileName is the default file name that will appear in the browser “open or save” dialog is using AsAttachment.
LastDocumentOnly
bool
If LastDocumentOnly = 1, then only the latest document of that DocumentType will be sent.
Responses
XwsResultCode XwsResultInfo
0 Success
401 Object Id Missing / Missing DocumentType Parameter
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed
404 Document Not Found

GET Container.DocumentInfo

Used to get Document Information in XML format for 1 specific document.

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
DocumentId *Required
long
Document ID
DataIncludeFlags
int
Allows specification of whether to include the Document List, Fields, and Versions; 1 = Document Listing, 2 = Document Fields, 4 = Document Versions
Responses
XwsResultCode XwsResultInfo
0 Success
1202 Param Value Missing
1203 Param Value Invalid
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

Document Service Methods

POST Document.DocumentAdd

Upload a new document to the repository

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
ContainerKey *Required
long
Key to Reference Loan Container; A Unique ID Provided by the LOS. ContainerKey or ContainerRef must be specified.
ContainerRef
long
Alternate User Friendly Unique Key for the Loan; This is the Loan Number in the User Interface. ContainerKey or ContainerRef must be specified.
DocumentType *Required
string
Type of document being added. Must match either the Schema Id, Code, or Alternate ID of the Document Definition
BucketCode
string
Bucket assignment for the document. If empty, will use the default from the Project Settings
BatchCode
string
Batch assignment for the document. Typically Batch assignment features are not used in most confiugrations
CaptureUser
string
Username of the user adding the document.
CaptureDate
string
Date and Time (UTC) the document was created / captured. If empty, defaults to the current date/time.
CaptureMethod
string
The method the document was received.
FieldType
string
Type of field being set. Must match either the Schema Id, Code, or Alternate ID of the Field Definition
FieldValue
string
Value for Field Specified by 'FieldType'
ExternalRef
string
Arbitrary External System Identifier or reference.
FileName
string
Original source file name.
FileData
string
Written directly to the Request Input Stream. For Text based data, this can also be included as a Request Parameter.
FileExtension *Required
string
Since the FileData is written to the Request Input Stream, this parameter tells XDOC the file format so it can properly convert to TIF.
ProcessInColor
bool
If set = 1, indicates to render the document in Color.
ProcessBarcodes
bool
If set = 1, indicates to process barcodes and apply barcode identification algorithms to try to automatically identify the Container. Note: if the Container Key is specified and valid, this parameter is ignored.
ProcessAltIdExt
bool
If set = 1, indicates to use the secondary alternate ids for document type identifcation during barcode id processing.
ProcessingFlags
int
Additional processing bit flags; 1 Indicates to add the document even if the Container is not found in the Integrated Application, 2 Indicates to add the document even if the Document type is not found, 4 Indicates to use the Default Document Type.
Responses
XwsResultCode XwsResultInfo
0 Success - Check ResultInfo envelope in xml response payload for DocumentAdded and FileAdded attribute values
10211 File Type Not Allowed
20221 Document Type Not Found
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed
404 Document Not Found / File Extension Not Found

POST Document.DocumentAddXml

Upload a new document to the repository. Same as DocumentAdd, but the input parameters and file data are specified in XML written directly to the Request Input Stream.

Request Body
                  <RequestData>
   <DocumentAdd
      ProjectId="1000"
      ContainerKey="201001"
      DocumentType="w2"
      CaptureUser="admin"
      CaptureDate="2010-11-23T12:52:56Z"
      CaptureMethod="scan"
      ExternalReference="doc12345"
      ProcessingFlags="1"
      FileExtension="pdf"
      FileName="Doc.pdf" >
      <FieldList>
         <Field FieldType="status" FieldValue="approved" />
         <Field FieldType="requiresReview" FieldValue="1" />
      </FieldList>
      <FileData>
         Base64 Encoded File Data Goes Here
      </FileData>
   </DocumentAdd>
</RequestData>
                  
               
Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
Responses
XwsResultCode XwsResultInfo
0 Success - Check ResultInfo envelope in xml response payload for DocumentAdded and FileAdded attribute values
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed

GET Document.DocumentDelete

Deletes a document. Deleting a document in XDOC performs a “soft delete”, which marks the document as deleted and logs the action

Parameters
Name Description
XM *Required
string
Method Signature
XSC *Required
string
Security Context
XST *Required
string
Security Token
ProjectId *Required
long
Project ID
DocumentId *Required
long
Document Id to Reference
ActionUser
long
Username of the user deleting the document.
Responses
XwsResultCode XwsResultInfo
0 Success
1202 Param Value Missing
1203 Param Value Invalid
20220 Document Not Found
403 Security Validation Failed / Security Config or Context Missing / Security Token Expired or Decryption Failed