The MoversSuite Document API is a representational state
transfer (RESTful) architecture system that allows standard HTTP requests to be
made following a prescribed universal resource locator (URL) methodology to get, add or update
documents stored within the MoversSuite Document System.
Methods are provided to add and update, and search document content and information, and to allow the transmission of documents to external systems, such as UniGroup TransDocs.
The following table summarizes key terms referenced throughout the Document API process:
|
Term |
Description |
|
Document Metadata
|
Document Metadata stores information regarding the document such as its name, type, last modification, and the location of the document content (where the document is physically stored). Document Metadata is stored within the MSSDocument table in the MoversSuite database. |
|
Document Content |
Document Content is the actual data of a document stored either in the MoversSuite database.
If utilizing MoversSuite to store documents, then the application references the following to store the content:
MoversSuite2.MSSDocument Information on the document is stored in this table, including data on the order associated to the document, document type, etc.
MoversSuite2.MSSDocumentImage This table links the MSSDocument table to an image file stored the MoversSuite2Docs database. Prior to the addition of the MoversSuite2Docs database, the application stored images within this table. This no longer occurs, and a tool is available as part of the Upgrade Process that allows you to move images from this table to the MoversSuite2Docs database.
MoversSuite2Docs.DocumentImage Image content associated to the MSSDocument is stored in this table.
Note: The name of the MoversSuite database is typically “MoversSuite2” and therefore the associated document database is named “MoversSuite2Docs.” However, the naming of the MoversSuite and MoversSuite Document databases may differ between systems.
|
|
MoversSuite Document Library |
These are the documents physically stored within the MoversSuite database (within the MSSDocumentImage table). |
The following table provides a complete list of all methods that are available and a brief description of each.
|
Document API Method |
Description |
|
This method returns the document metadata for all documents of a specified order. | |
|
This method returns the document metadata for the one document for a specific document name. | |
|
This method returns the document metadata for the one document for a specific document ID. | |
|
This method returns “true” when the specified order is associated to at least one document, otherwise, “false” returns. | |
|
Add metadata for a specified document (does not add the content of a document). | |
|
Update metadata for a specified document (does not update the content of a document). | |
|
This method adds a new document to the MoversSuite Document Library. Documents added to the library will not be visible until metadata exits for them (see Add Document Metadata). | |
|
Use this method to update (replace) the content of a document within the MoversSuite Document Library. | |
|
This method retrieves the content for a specific document by name. | |
|
This method returns a list of metadata for all documents for a given date range and document type. |
Additional services associated to Document API include the following:
Basic Order Information Request
The following table describes the method available through the Invoices API service.
|
Invoices API Methods |
Description |
|
This method returns metadata for all invoices for a specified order. | |
|
This method returns metadata for an invoice for a specified invoice number and order. | |
|
This method returns metadata for an invoice for a specified invoice ID. | |
|
This method returns the actual image for an invoice for a specified invoice ID. |
RELATED TOPICS:
Basic Order Information Request