Get Document Metadata by Name

 

This method returns the document metadata for the one document for a specific document name. 

 

Note

Only documents with a Source property of “Documents” will return.  Those stored with a Source of “Invoices” will not be returned with this method.  Refer to the Source property within Response Return section in Get All Metadata by Order.

 

 

HTTP Verb/Method:

GET 

URL Format:

http://server/api/documents/{OrderID}/{DocName}

Returns:

This method returns the metadata for the specific file and is the same as what is returned for a single document through the Get All Metadata by Order method.

An error is returned if the document metadata cannot be found.

 

The following table lists the parameters available for this method request.  Both parameters are contained within the document metadata (refer to Get All Metadata by Order).

 

Parameter

Description

OrderID

Enter the primary key of the requested MoversSuite order.

DocName

Enter the name of the document to retrieve metadata on.