GET api/Files/{id}/Name

Retrieves the components of the name for a matter.

Request

Parameters

Name Description Default
id File number or unique file ID.

Response

Body

Content Type: application/xml or application/json
Name components or an error message.

XML JSON 
<Response>                                     
  <Result>                                     
    <Exists>bool</Exists>                      <!--Whether a file with this identifier exists--> 
    <FileNumber>string</FileNumber>            <!--Human-readable file number--> 
    <Matter>string</Matter>                    <!--Matter description--> 
    <CompanyID>long</CompanyID>                <!--Unique company ID--> 
    <PrimaryClientID>long</PrimaryClientID>    <!--Contact number (unique ID) of the primary client--> 
  </Result>                                    
  <Message>string</Message>                    <!--Error message--> 
</Response>                                    
{                                 
   "Result": {                    
      "Exists": "bool",           // Whether a file with this identifier exists
      "FileNumber": "string",     // Human-readable file number
      "Matter": "string",         // Matter description
      "CompanyID": "long",        // Unique company ID
      "PrimaryClientID": "long"   // Contact number (unique ID) of the primary client
   },                             
   "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.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.