GET api/Files/{id}

Retrieves information for a matter.

Request

Parameters

Name Description Default
id File number or unique file ID.
notesFormat Desired format for the matter notes field. rtf
includeContacts Whether to embed definitions for contacts other than the primary client. true

Response

Body

Content Type: application/xml
Schema: http://download.overtech.com.au/schemas/XmlFile.xsd
Exported matter definition.

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid file ID.
401 Unauthorized Access token is invalid, expired or not specified.
403 ForbiddenThe user does not have permission to view the matter.
404 Not FoundFile not found.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.
501 Not ImplementedServer does not have the required plug-in.

Remarks

The notes format can be one of the following values:
ValueDescription
rtfRich Text Format.
htmlHTML Format.
textPlain Text Format.