GET Clients/File

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
IncludeError	boolean	None.
Match	MatchCriteriaStringType	None.
EntityFileIDs	Collection of integer	None.
EntityID	integer	None.
FileTypeID	integer	None.
FileTypes	Collection of integer	None.
EntityFolderID	integer	None.
BinaryID	integer	None.
Description	string	None.
FileName	string	None.
FileExtension	string	None.
FileSize	integer	None.
FileDateUtcMin	date	None.
FileDateUtcMax	date	None.
Props	Collection of Object	None.
Comments	string	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.
IncludePayload	boolean	None.
IncludeSystemFileTypes	boolean	None.

Body Parameters

None.

Response Information

Resource Description

Collection of EntityFileDTO

Name	Type	Additional information
EntityFileID	integer	None.
EntityFileKey	string	None.
EntityID	integer	None.
FileTypeID	integer	None.
FileTypeName	string	None.
EntityFolderID	integer	None.
BinaryID	integer	None.
Description	string	None.
FileName	string	None.
FileExtension	string	None.
FileSize	integer	None.
FileDateUtc	date	None.
Props	Collection of Object	None.
Comments	string	None.
Data	string	None.
DataCompressionType	CompressionType	None.
DataProps	Collection of Object	None.
RecordState	ClinicalRecordState	None.
RecordStateReason	string	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
Summary	string	None.

Response Formats

application/json, text/json

Sample:

[
  null,
  {
    "entityFileID": 1,
    "entityFileKey": "sample string 2",
    "entityID": 3,
    "fileTypeID": 4,
    "fileTypeName": "sample string 5",
    "entityFolderID": 1,
    "binaryID": 6,
    "description": "sample string 7",
    "fileName": "sample string 8",
    "fileExtension": "sample string 9",
    "fileSize": 10,
    "fileDateUtc": "2024-12-04T08:17:50.7593945+00:00",
    "comments": "sample string 12",
    "data": "",
    "recordState": 1,
    "createdByUserID": 0,
    "lastUpdatedByUserID": 0,
    "created": {
      "dateUtc": "0001-01-01T00:00:00Z",
      "summary": "Unknown on TBD"
    },
    "lastUpdated": {
      "dateUtc": "0001-01-01T00:00:00Z",
      "summary": "Unknown on TBD"
    },
    "summary": "sample string 8"
  }
]

application/xml, text/xml

Sample:

<ArrayOfEntityFileDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <EntityFileDTO i:nil="true" />
  <EntityFileDTO>
    <BinaryID>6</BinaryID>
    <Comments>sample string 12</Comments>
    <Created>
      <DateUtc>0001-01-01T00:00:00Z</DateUtc>
      <UserName i:nil="true" />
    </Created>
    <CreatedByUserID>0</CreatedByUserID>
    <Data xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO">
      <__identity i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/System" />
      <d3p1:_buffer />
      <d3p1:_capacity>0</d3p1:_capacity>
      <d3p1:_expandable>true</d3p1:_expandable>
      <d3p1:_exposable>true</d3p1:_exposable>
      <d3p1:_isOpen>true</d3p1:_isOpen>
      <d3p1:_length>0</d3p1:_length>
      <d3p1:_origin>0</d3p1:_origin>
      <d3p1:_position>0</d3p1:_position>
      <d3p1:_writable>true</d3p1:_writable>
    </Data>
    <DataAsString></DataAsString>
    <DataCompressionType i:nil="true" />
    <DataProps xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <Description>sample string 7</Description>
    <EntityFileID>1</EntityFileID>
    <EntityFileKey>sample string 2</EntityFileKey>
    <EntityFolderID>1</EntityFolderID>
    <EntityID>3</EntityID>
    <FileDateUtc>2024-12-04T08:17:50.7593945+00:00</FileDateUtc>
    <FileExtension>sample string 9</FileExtension>
    <FileName>sample string 8</FileName>
    <FileSize>10</FileSize>
    <FileTypeID>4</FileTypeID>
    <FileTypeName>sample string 5</FileTypeName>
    <LastUpdated>
      <DateUtc>0001-01-01T00:00:00Z</DateUtc>
      <UserName i:nil="true" />
    </LastUpdated>
    <LastUpdatedByUserID>0</LastUpdatedByUserID>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <RecordState>Active</RecordState>
    <RecordStateReason i:nil="true" />
  </EntityFileDTO>
</ArrayOfEntityFileDTO>

application/x-compressed-json

Sample:

��PKN�0�J�-	�ӄ4^V�Bb�db��Y8vd��P�d,8W`��i�y���x{��;��=�K߭�W�$�Ѹ�ȱ�U"p�J�����!z`ٵ;9�7�3r�M^Ņ��R3;�]��W[�zi􌟡���r^�x��)z>!6���U���|
��ID�'%^R���gi�ȓ�c�1�k�4p�����3�yȬ����Í���UW��npW������Et�N�a�I4D9�q>n�4�<T�I�g��~��[�8�����'�G�N