Get download form
Retrieve a downloadable form associated with a specific TPA ID. This endpoint is typically used to obtain forms needed for various participant-related processes.
Request
-
tpaId string Required
A unique identifier used to identify your admin instance. This value is system generated when the admin instance was created.
-
fileKey integer <int32> Required
The unique identifier for the file being requested. This integer value is required to specify which file to download.
-
decrypt integer <int32>
Indicate if the URI parameters are encrypted or not. Use 1 for encrypted, 0 for decrypted (default is 0). This affects how the API interprets the incoming identifiers.
Response
-
FileKey integer <int32>
File Key
-
FileFormat enum<string>Possible values:
AllUnknownFixedCsvXmlPdfQifExcelJpegGifBmpFixedNachaDelimitedWordPngTiffExtFileFormat -
ContentLength integer <int32>
The file length, in bytes.
-
ContentType string
The MIME content type of the uploaded file.
-
FileName string
The name of the client's file, including the directory path.
-
InputStream string <byte>
A System.IO.Stream pointing to a file.
-
Base64 string
The string representation in Base 64 of the file content.
-
FileKey integer <int32>
File Key
-
FileFormat enum<string>Possible values:
AllUnknownFixedCsvXmlPdfQifExcelJpegGifBmpFixedNachaDelimitedWordPngTiffExtFileFormat -
ContentLength integer <int32>
The file length, in bytes.
-
ContentType string
The MIME content type of the uploaded file.
-
FileName string
The name of the client's file, including the directory path.
-
InputStream string <byte>
A System.IO.Stream pointing to a file.
-
Base64 string
The string representation in Base 64 of the file content.
No response yet.No response yet.