Document API

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 that is stored either in the MSSDocumentImage table in the MoversSuite database or externally (e.g. Microsoft SharePoint server, the Cloud, etc.)
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
Get All Metadata by Order	This method returns the document metadata for all documents of a specified order.
Get Document Metadata by Name	This method returns the document metadata for the one document for a specific document name.
Get Document Metadata by ID	This method returns the document metadata for the one document for a specific document ID.
Order has Documents	This method returns “true” when the specified order is associated to at least one document, otherwise, “false” is returned.
Add Document Metadata	Add metadata for a specified document (does not add the content of a document).
Update Document Metadata	Update metadata for a specified document (does not update the content of a document).
Add Document Content	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).
Update Document Content	Use this method to update (replace) the content of a document within the MoversSuite Document Library.
Get Document Content	This method retrieves the content for a specific document by name.
Get All Document Metadata	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 Orders API and Invoices API.

The following table describes the method available through the Orders API service.

Orders API Method	Description
Get Order Metadata	This method returns the metadata for a specified order.

The following table describes the method available through the Invoices API service.

Invoices API Methods	Description
Get All Invoice Metadata by Order	This method returns metadata for all invoices for a specified order.
Get Invoice Metadata by Number	This method returns metadata for an invoice for a specified invoice number and order.
Get Invoice Metadata by ID	This method returns metadata for an invoice for a specified invoice ID.
Get Invoice Image	This method returns the actual image for an invoice for a specified invoice ID.

RELATED TOPICS:

MSSApiService

MSSApiService Logging