Planfix API file.get

Function for obtaining information about a file. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="file.get">
  <account></account>
  <sid></sid>
  <file>
    <id></id>
    <uniqueId></uniqueId>
  </file>
  <returnDownloadLinks></returnDownloadLinks>
  <signature></signature>
</request>

Name	Type	Value	Note
file.id	int	file identifier
file.uniqueId	int	unique file identifier	ignored if id parameter is set
returnDownloadLinks	bool	whether to return permanent download links in the response	default value is 0
signature	string(32)	signature

Result of successful function execution:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <file>
    <id></id>
    <uniqueId></uniqueId>
    <name></name>
    <version></version>
    <description></description>
    <date></date>
    <sourceType></sourceType>
    <size></size>
    <task>
      <id></id>
      <title></title>
    </task>
    <project>
      <id></id>
      <title></title>
    </project>
    <user>
      <id></id>
      <name></name>
    </user>
    <downloadLink></downloadLink>
  </file>
</response>

Name	Type	Value	Note
id	int	file identifier
uniqueId	int	uniqu
name	string	file name
version	int	version
description	string	description
date	DateTime	file upload date
sourceType	enum	file types	see the list of permissible values in file types
size	int	size in kilobytes
task		task under which it was uploaded
task.id	int	task identifier
task.title	string	task name
project		project under which the file was uploaded
project.id	int	project identifier
project.title	string	project name
user		user who uploaded the file
user.id	int	user identifier
user.name	string	user name
downloadLink	string	download link for the file

Otherwise, an error response will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>

Go To