ПланФикс API project.update

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

Функция обновления данных о проекте. Формат запроса:

<?xml version="1.0" encoding="UTF-8"?>
<request method="project.update">
  <account></account>
  <sid></sid>
  <project>
    <id></id>
    <title></title>
    <description></description>
    <owner>
      <id></id>
    </owner>
    <client>
      <id></id>
    </client>
    <status></status>
    <hidden></hidden>
    <hasEndDate></hasEndDate>
    <endDate></endDate>
  </project>
  <signature></signature>
</request>
Название Тип Значение Примечание
sid string(32) ключ сесии выдается в результате прохождения аутентификации
id int Идентификатор проекта который редактируется можно получить из функций получения списка или в результате выполнения функции добавления
title string Название проекта не обязательный параметр
description string Описание проекта которое задает пользователь не обязательный параметр
owner не обязательный параметр
owner.id int идентификатор пользователя, который будет считаться создателем проекта. допускается значение 0 (ноль). не обязательный параметр
client необязательное параметр
client.id int идентификатор контрагента допускается значение 0 (ноль).
status enum новый статус проекта перечень допустимых значений для данного поля смотри в разделе константы статусы проектов. не обязательный параметр
hidden bool скрытый не обязательный параметр
hasEndDate bool имеет ли дату окончания не обязательный параметр
endDate DateTime учитывается только в том случае, если параметр hasEndDate установлен в true. не обязательный параметр

Необязательные параметры можно не передавать в запросе. В этом случае сохраняется старое значение.

Результатом удачного выполнения запроса является следующий ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <project>
    <id></id>
  </project>
</response>
Название Тип Значение Примечание
id int идентификатор равен идентификатору переданному в запросе

В противном случае будет возвращен ответ с ошибкой:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>
Значение code Расшифровка
0000 неизвестная ошибка

Перейти