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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"matterDocumentList":[{"documentId":0,"documentName":"String","version":"String","size":"String","lastUpdateDate":"String","lastUpdatedBy":"String","matterNumber":"String","matterId":0,"link":"String","extension":"String","rowNumber":0}],"totalCount":0}