Skip to main content
Skip table of contents

List Documents

Definition 

Service Location: https://gateway.pharmx.com.au/Gateway3/DocumentManagement.asmx

Method name: ListDocuments

Parameters

userDetail UserDetail

User credentials to authenticate the request.

documentTypeId int

The type of documents to retrieve.

Returns

ListDocumentsResult ActionResult (with an array of GenericDocument)

Remarks

The method will return an array of GenericDocument documents for each document on the gateway that has not been marked as retrieved (refer MarkDocumentAsRetrieved) by this user. Using the DocumentId in the array of GenericDocument returned, the application can request GenericDocument documents by calling GetDocument.

The client application should assume documents of unknown value for <type> will be returned from time to time. Any document of unknown <type> should be marked as retrieved to ensure they are no longer returned by ListDocuments and consequently cannot interfere with document types of interest.

The <payload> node will be null for ListDocuments.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.