Zola Suite Client Portal API

<back to all web services

GetAllDocumentsForMatter

Requires Authentication
The following routes are available for this service:
GET/api2/Matter/{MatterId}/Documents/
GetAllDocumentsForMatter Parameters:
NameParameterData TypeRequiredDescription
MatterIdpathintNo
PageNumberqueryintNo
PageSizequeryint?No
GetAllDocumentsForMatterResponse Parameters:
NameParameterData TypeRequiredDescription
SystemDocumentsformGetDocumentsResponseNo
ClientDocumentsformGetDocumentsResponseNo
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

GET /api2/Matter/{MatterId}/Documents/ HTTP/1.1 
Host: zolacaseway.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	systemDocuments: 
	{
		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
	},
	clientDocuments: 
	{
		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
	}
}