GET api/Files/{id}/Related

Retrieves a list of related files.

Request

Parameters

Name Description Default
id Unique ID of the file

Response

Body

Content Type: application/xml or application/json
List of related files or an error message.

XML JSON 
<Response>                                       
  <Result>                                       <!--Array of 'Item'--> 
    <Item>                                       
      <ID>long</ID>                              <!--Unique ID of related file--> 
      <FileNumber>string</FileNumber>            <!--Human-readable file number--> 
      <Matter>string</Matter>                    
      <PrimaryClientID>long</PrimaryClientID>    
      <CompanyID>long</CompanyID>                
    </Item>                                      
  </Result>                                      
  <Message>string</Message>                      <!--Error message--> 
</Response>                                      
{                                   
   "Result": [{                     
      "ID": "long",                 // Unique ID of related file
      "FileNumber": "string",       // Human-readable file number
      "Matter": "string",           
      "PrimaryClientID": "long",    
      "CompanyID": "long"           
   }],                              
   "Message": "string"              // Error message
}

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 ForbiddenUser does not have permission.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.