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” returns. This method does not return documents stored with a Source of “Invoices.” Refer to the Source property description within Response Return section in Get All Metadata by Order.

 

 

HTTPS Verb/Method:

GET 

URL Format:

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

Returns:

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

An error returns if the document metadata does not exist.

 

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.