GET v1/Clients/{clientId}/EFiles/{eFileId}

Retrieves the requested E-File, including the E-File’s bytes.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Client identifier.	globally unique identifier	Required
eFileId	The E-File identifier.	integer	Required

Body Parameters

None.

Response Information

Resource Description

The EFileV1.

EFileV1

Name	Description	Type	Additional information
FacilityId	The Facility Id for the facility the E-File is associated with.	integer	None.
EFileApplicationReferenceId	The E-File Application Reference Id. Valid values can be retrieved from v1/Clients/{clientId}/References?type=EFileApplication.	integer	None.
FileName	The file name including file extension.	string	None.
DateOfFile	The Date of the E-File.	date	None.
Bytes	The bytes for the file.	Collection of byte	None.
Description	The file description.	string	None.
Tags	The list of Tags to apply to the file.	Collection of string	None.
SkipDuplicateFileName	A flag indicating whether or not the system should upload the provided file if there is already a file in the system with this name for this facility. If set to True, the file will NOT be uploaded if there is another file with this File Name in the system for the specified facility.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "FacilityId": 1,
  "EFileApplicationReferenceId": 2,
  "FileName": "sample string 3",
  "DateOfFile": "2025-05-13T09:07:19.1732923+00:00",
  "Bytes": "QEA=",
  "Description": "sample string 4",
  "Tags": [
    "sample string 1",
    "sample string 2"
  ],
  "SkipDuplicateFileName": true
}

application/xml, text/xml

Sample:

<EFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models">
  <Bytes>QEA=</Bytes>
  <DateOfFile>2025-05-13T09:07:19.1732923+00:00</DateOfFile>
  <Description>sample string 4</Description>
  <EFileApplicationReferenceId>2</EFileApplicationReferenceId>
  <FacilityId>1</FacilityId>
  <FileName>sample string 3</FileName>
  <SkipDuplicateFileName>true</SkipDuplicateFileName>
  <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Tags>
</EFile>