Planfix API file.getListForClient

From Planfix
Jump to: navigation, search

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="file.getListForClient">
Name Type Value Note 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">
      <!-- ... -->
    <!-- ... -->
Name Type Value Note
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 int task identifier
task.title string task name
project within which project was the file uploaded int project identifier
project.title string project name
user user who uploaded the file int user identifier string user name

Otherwise, an error response will be returned:

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

Go To