GET api/Files/Search

Searches matters, matching a particular term.

Request

Parameters

Name Description Default
term Search term.
matchType How the search term is matched (any/all). all
scope Matter scope (active/archived/all). active
company Filter by unique company ID.

Response

Body

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

XML JSON 
<Response>                                   
  <Result>                                   <!--Array of 'Item'--> 
    <Item>                                   
      <FileID>long</FileID>                  <!--Unique file ID--> 
      <Company>string</Company>              <!--Practice or subsidiary company name--> 
      <Client>string</Client>                <!--File-as name of primary client--> 
      <File>string</File>                    <!--Human-readable file number--> 
      <FileCode>string</FileCode>            <!--Historical code--> 
      <Matter>string</Matter>                <!--Matter description--> 
      <MgrSupr>string</MgrSupr>              <!--Concatenation of the manager and supervisor member codes--> 
      <WorkGroup>string</WorkGroup>          <!--Workgroup name--> 
      <ArchiveBoxNo>string</ArchiveBoxNo>    <!--Shelf location (if archived)--> 
      <AverageRank>int</AverageRank>         <!--Rank/relevance (higher is better)--> 
    </Item>                                  
  </Result>                                  
  <Message>string</Message>                  <!--Error message--> 
</Response>                                  
{                                  
   "Result": [{                    
      "FileID": "long",            // Unique file ID
      "Company": "string",         // Practice or subsidiary company name
      "Client": "string",          // File-as name of primary client
      "File": "string",            // Human-readable file number
      "FileCode": "string",        // Historical code
      "Matter": "string",          // Matter description
      "MgrSupr": "string",         // Concatenation of the manager and supervisor member codes
      "WorkGroup": "string",       // Workgroup name
      "ArchiveBoxNo": "string",    // Shelf location (if archived)
      "AverageRank": "int"         // Rank/relevance (higher is better)
   }],                             
   "Message": "string"             // Error message
}

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid search term, syntax error or term contains only noise words.
401 Unauthorized Access token is invalid, expired or not specified.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.