ПланФикс API file.download

Материал из ПланФикс
Перейти к: навигация, поиск

Функция скачивания файла. Формат запроса:

<?xml version="1.0" encoding="UTF-8"?>
<request method="file.download">
  <account></account>
  <sid></sid>
  <file>
    <id></id>
    <uniqueId></uniqueId>
  </file>
  <signature></signature>
</request>
Название Тип Значение Примечание
file.id int идентификатор файла
file.uniqueId int уникальный идентификатор файла
signature string(32) подпись

При вызове функции можно использовать один из параметров id или uniqueId. Наличие параметра id исключает использование параметра uniqueId

Результат выполнения функции расшифровывается по коду HTTP ответа

Значение Описание Примечание
200 тело ответа - файл
302 прямая ссылка на файл находится в заголовке Location
403 доступ запрещен тело ответа - стандартный XML-ответ с расшифровкой ошибки
404 такого файла не существует тело ответа - стандартный XML-ответ с расшифровкой ошибки

Тело ответа с ошибкой:

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


Перейти