GET api/Documents/Search

Searches documents, matching a particular term.

Request

Parameters

Name Description Default
term Search term.
matchType How the search term is matched. all
fileID Filter by unique file ID. Omit to search across all matters.

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>                                             
      <DocumentID>long</DocumentID>                    <!--Document number (unique ID)--> 
      <DocumentDate>datetime</DocumentDate>            <!--Document date (primary date)--> 
      <FileID>long</FileID>                            <!--Unique file ID--> 
      <ContactID>long</ContactID>                      <!--Contact number (primary contact)--> 
      <DocumentName>string</DocumentName>              <!--Document description--> 
      <Attributes>int</Attributes>                     <!--Document attributes (flags)--> 
      <Folder>string</Folder>                          <!--Folder path--> 
      <DocumentExtension>string</DocumentExtension>    <!--File extension--> 
      <Pages>int</Pages>                               <!--Page count (if known)--> 
      <DocumentType>string</DocumentType>              <!--Name of document type--> 
      <FileNumber>string</FileNumber>                  <!--Human-readable file number--> 
      <FileAs>string</FileAs>                          <!--File-as name (primary contact)--> 
      <Url>string</Url>                                <!--Location--> 
    </Item>                                            
  </Result>                                            
  <Message>string</Message>                            <!--Error message--> 
</Response>                                            
{                                       
   "Result": [{                         
      "DocumentID": "long",             // Document number (unique ID)
      "DocumentDate": "datetime",       // Document date (primary date)
      "FileID": "long",                 // Unique file ID
      "ContactID": "long",              // Contact number (primary contact)
      "DocumentName": "string",         // Document description
      "Attributes": "int",              // Document attributes (flags)
      "Folder": "string",               // Folder path
      "DocumentExtension": "string",    // File extension
      "Pages": "int",                   // Page count (if known)
      "DocumentType": "string",         // Name of document type
      "FileNumber": "string",           // Human-readable file number
      "FileAs": "string",               // File-as name (primary contact)
      "Url": "string"                   // Location
   }],                                  
   "Message": "string"                  // Error message
}

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid search term.
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.

Remarks

The response may contain obfuscated results if the user does not have permission to view the document(s).

The match type can be one of the following values:

Value Description
all Match all words in the search term.
any Match any words in the search term.