wm.tn.doc.viewAll
Retrieves a list of documents (envelope information) from the database; the service verifies that the client invoking the service is either the sending or receiving partner of the document being viewed or a Trading Networks administrator. Optionally, the service can retrieve the raw document contents, attributes, and errors.
Input Parameters
internalIds | String List The internal document IDs of the documents to retrieve. These are unique IDs that Trading Networks assigns to documents. |
getContents | String List (optional) Retrieves the document contents and envelope information. Valid values are: true - Retrieve the document contents. false - Default. Do not retrieve the document contents. |
getAttributes | String (optional) Retrieves the document attributes and envelope information. Valid values are: true - Retrieve the document attributes. false - Default. Do not retrieve the document attributes. |
getErrors | String (optional) Retrieves the document errors and envelope information. Valid values are: true - Retrieve the document errors. false - Default. Do not retrieve the document errors. |
Output Parameters
bizdocs | Document List Documents this service retrieved from the database. For the structure of bizdoc, see
wm.tn.rec:BizDocEnvelope. The service populates the Content attribute within each bizdoc if getContents, getAttributes, and getErrors is set as true. |
Usage Notes
If you are invoking this service from a Java program, in addition to returning bizdocs as IS documents (IData object), the service returns bizdocs as an instance of com.wm.app.tn.doc.BizDocEnvelope.