Planfix API file.getListForClient

Function for obtaining a list of files for a counterparty/customer. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="file.getListForClient">
  <account></account>
  <sid></sid>
  <client>
    <id></id>
  </client>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <signature></signature>
</request>

Name	Type	Value	Note
client.id	int	counterparty/customer identifier
pageCurrent	int	current page	numbering starts from 1. 0 - is used to get the quantity
pageSize	int	requested page size
signature	string(32)	signature

Result of successful function execution:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <files count="count" totalCount="totalCount">
    <file>
      <id></id>
      <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>
    </file>
    <file>
      <!-- ... -->
    </file>
    <!-- ... -->
  </files>
</response>

Name	Type	Value	Note
files
files count	int	number of files returned by the request
files totalCount	int	number of files satisfying the request
file		node describing the file
id	int	file identifier
name	string	file name
version	int	version
description	string	description
date	DateTime	file upload date
sourceType	enum	file types	see the list of acceptable values in file types
size	int	size in bytes
task		within which task was it uploaded
task.id	int	task identifier
task.title	string	task name
project		within which project was the file 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

Otherwise, an error response will be returned:

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

Go To