GET Notes/File/{noteFileID}/{includePayload}

Request Information

URI Parameters

Name	Description	Type	Additional information
noteFileID		integer	Required
includePayload		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

NoteFileDTO

Name	Type	Additional information
NoteFileID	integer	None.
NoteFileKey	string	None.
NoteID	integer	None.
NoteTypeID	integer	None.
FileTypeID	integer	None.
FileTypeName	string	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.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
Summary	string	None.

Response Formats

application/json, text/json

Sample:

{
  "noteFileID": 1,
  "noteFileKey": "sample string 2",
  "noteID": 3,
  "noteTypeID": 4,
  "fileTypeID": 5,
  "fileTypeName": "sample string 6",
  "binaryID": 7,
  "description": "sample string 8",
  "fileName": "sample string 9",
  "fileExtension": "sample string 10",
  "fileSize": 11,
  "fileDateUtc": "2024-12-04T07:55:02.3145028+00:00",
  "comments": "sample string 13",
  "dataCompressionType": 1,
  "dataProps": [],
  "recordState": 1,
  "createdByUserID": 15,
  "lastUpdatedByUserID": 16,
  "created": {
    "dateUtc": "2024-12-04T07:55:02.3145028+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:55:02 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:55:02.3145028+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:55:02 AM"
  },
  "summary": "sample string 9"
}

application/xml, text/xml

Sample:

<NoteFileDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <BinaryID>7</BinaryID>
  <Comments>sample string 13</Comments>
  <Created>
    <DateUtc>2024-12-04T07:55:02.3145028+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <CreatedByUserID>15</CreatedByUserID>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
  <DataAsString i:nil="true" />
  <DataCompressionType>None</DataCompressionType>
  <DataProps xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" />
  <Description>sample string 8</Description>
  <FileDateUtc>2024-12-04T07:55:02.3145028+00:00</FileDateUtc>
  <FileExtension>sample string 10</FileExtension>
  <FileName>sample string 9</FileName>
  <FileSize>11</FileSize>
  <FileTypeID>5</FileTypeID>
  <FileTypeName>sample string 6</FileTypeName>
  <LastUpdated>
    <DateUtc>2024-12-04T07:55:02.3145028+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <LastUpdatedByUserID>16</LastUpdatedByUserID>
  <NoteFileID>1</NoteFileID>
  <NoteFileKey>sample string 2</NoteFileKey>
  <NoteID>3</NoteID>
  <NoteTypeID>4</NoteTypeID>
  <Props xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
  <RecordState>Active</RecordState>
</NoteFileDTO>

application/pdf, image/jpeg, image/png, image/bmp, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel, application/msexcel, application/x-msexcel, application/x-ms-excel, application/x-excel, application/x-dos_ms_excel, application/xls, application/x-xls, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/msword, ext/csv, application/octet-stream, application/zip

Sample:

application/x-compressed-json

Sample:

��QKN�0�J�-)������
�0ɀ,�vd����Xp$����"HX�c7��3��׷R�����r���
Đ岮 ���Q��A�t妩[���ѻ>a�o��A��'=�M���`#j'���KMZ����e�����x�~B:��rWx9�4�:���Y�1L��f�.�0f8�-%(g��gK�����F�n��o�����>F
mʵ�[�0����-�v�~o�.����Flr�0�և��.��n��gr�V��tZD}vtr���f���fZ��]�X��