Zola Suite Client Portal API

<back to all web services

GetDocumentSharedByClientPortalUsers

Requires Authentication
The following routes are available for this service:
GET/api2/Matter/{MatterId}/ClientDocuments/
GetDocumentSharedByClientPortalUsers Parameters:
NameParameterData TypeRequiredDescription
MatterIdpathintNo
PageNumberqueryintNo
PageSizequeryint?No
GetDocumentsResponse Parameters:
NameParameterData TypeRequiredDescription
MatterDocumentListformList<DocumentObject>No
TotalCountformintNo
DocumentObject Parameters:
NameParameterData TypeRequiredDescription
DocumentIdformintNo
DocumentNameformstringNo
VersionformstringNo
SizeformstringNo
LastUpdateDateformstringNo
LastUpdatedByformstringNo
MatterNumberformstringNo
MatterIdformintNo
LinkformstringNo
ExtensionformstringNo
RowNumberformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api2/Matter/{MatterId}/ClientDocuments/ HTTP/1.1 
Host: zolacaseway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDocumentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClientPortalService">
  <MatterDocumentList>
    <DocumentObject>
      <DocumentId>0</DocumentId>
      <DocumentName>String</DocumentName>
      <Extension>String</Extension>
      <LastUpdateDate>String</LastUpdateDate>
      <LastUpdatedBy>String</LastUpdatedBy>
      <Link>String</Link>
      <MatterId>0</MatterId>
      <MatterNumber>String</MatterNumber>
      <RowNumber>0</RowNumber>
      <Size>String</Size>
      <Version>String</Version>
    </DocumentObject>
  </MatterDocumentList>
  <TotalCount>0</TotalCount>
</GetDocumentsResponse>