GET api/Files

Retrieves a list of matters managed or supervised by a particular member.

Request

Parameters

Name Description Default
member Unique member ID. Omit to retrieve matters for the current user.
deptWorkgroup Filter by workgroup ID (positive value), department ID (negative value) or all workgroups (zero). 0
includeArchived Whether to include archived files. false

Response

Body

Content Type: application/xml or application/json
Data set containing the matters, or an error message.

XML JSON
<Response>                                   
  <Result>                                   <!--Array of 'Item'--> 
    <Item>                                   
      <Client>long</Client>                  <!--Contact number (unique ID) of the primary client--> 
      <File>long</File>                      <!--Unique ID of the file--> 
      <Matter>string</Matter>                <!--Matter description--> 
      <CreatedDate>datetime</CreatedDate>    <!--Date on which the file was opened--> 
      <MgrSupr>string</MgrSupr>              <!--Concatenation of the member codes for the file manager and supervisor--> 
      <Unbilled>decimal</Unbilled>           <!--Value of unbilled time/charges (WIP)--> 
      <Trust>decimal</Trust>                 <!--Trust balance--> 
      <Debtors>decimal</Debtors>             <!--Debtors balance--> 
      <Disbs>decimal</Disbs>                 <!--Value of unbilled disbursements--> 
      <IsClosed>bool</IsClosed>              <!--Whether the file is closed or ready for archival--> 
      <IsActive>bool</IsActive>              <!--Whether the file is active--> 
      <IsArchived>bool</IsArchived>          <!--Whether the file is archived--> 
      <FileNumber>string</FileNumber>        <!--Human-readable file number--> 
      <FileAs>string</FileAs>                <!--File-as name for the primary client--> 
    </Item>                                  
  </Result>                                  
  <Message>string</Message>                  <!--Error message--> 
</Response>                                  
{                                   
   "Result": [{                     
      "Client": "long",             // Contact number (unique ID) of the primary client
      "File": "long",               // Unique ID of the file
      "Matter": "string",           // Matter description
      "CreatedDate": "datetime",    // Date on which the file was opened
      "MgrSupr": "string",          // Concatenation of the member codes for the file manager and supervisor
      "Unbilled": "decimal",        // Value of unbilled time/charges (WIP)
      "Trust": "decimal",           // Trust balance
      "Debtors": "decimal",         // Debtors balance
      "Disbs": "decimal",           // Value of unbilled disbursements
      "IsClosed": "bool",           // Whether the file is closed or ready for archival
      "IsActive": "bool",           // Whether the file is active
      "IsArchived": "bool",         // Whether the file is archived
      "FileNumber": "string",       // Human-readable file number
      "FileAs": "string"            // File-as name for the primary client
   }],                              
   "Message": "string"              // Error message
}                                   
                                    

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid member ID.
401 Unauthorized Access token is invalid, expired or not specified.
403 ForbiddenThe user does not have permission to view the other member's files.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.