GET file/GetFile?FileID={FileID}&IncludePageData={IncludePageData}

Request Information

URI Parameters

Name	Description	Type	Additional information
FileID		integer	Required
IncludePageData		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

File

Name	Type	Additional information
FileID	integer	None.
FileName	string	None.
UniqueIdentifier	string	None.
CompanyUniqueIdentifier	string	None.
FileSize	integer	None.
CreatedDate	date	None.
LastModifiedDate	date	None.
FolderID	integer	None.
CompanyID	integer	None.
FileTypeID	integer	None.
FileExtensionID	integer	None.
FileExtensionName	string	None.
FileStatusID	integer	None.
CreatedUserID	integer	None.
CreatedBy	string	None.
LastModifiedBy	string	None.
Pages	integer	None.
Source	string	None.
Text	string	None.
BarcodeNumber	string	None.
ModifyTypeID	integer	None.
ModifyTypeName	string	None.
OriginFileID	integer	None.
FilePages	Collection of FilePage	None.
Roles	Collection of Role	None.
Folders	Collection of Folder	None.
TotalRows	integer	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Models.Role'. Path 'Roles[0].Controllers[0].Roles'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Models.Role'. Path 'Roles[0].Controllers[0].Roles'.

text/html

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/html'. Exception message: Self referencing loop detected with type 'Models.Role'. Path 'Roles[0].Controllers[0].Roles'.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[Models.File, Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'System.Collections.Generic.List`1[[Models.File, Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled.