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

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

Запрос на создание проекта имеет следующий вид:

<request method="project.add">
  <account></account>
  <sid></sid>
  <project>
    <title></title>
    <description></description>
    <owner>
      <id></id>
    </owner>
    <client>
      <id></id>
    </client>
    <status></status>
    <hidden></hidden>
    <hasEndDate></hasEndDate>
    <endDate></endDate>
  </project>
  <signature></signature>
</request>

Если не передать автора (owner), или указать id=0, то будет использован в качестве автора пользователь текущей сессии. Контрагент не обязательный параметр. Вызывать функцию имеет право обычный пользователь (не контакт).

Название Тип Значение Примечание
sid string(32) ключ сесии выдается в результате прохождения аутентификации
title string Название проекта
description string Описание проекта которое задает пользователь
owner Данное поле не обязательно. В этом случае будет назначен владельцем пользователь, от имени которого выполняется запрос (определяется по sid)
owner.id int идентификатор пользователя, который будет считаться создателем проекта. допускается значение 0 (ноль). В этом случае будет назначен владельцем пользователь, от имени которого выполняется запрос (определяется по sid)
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>
Название Тип Значение Примечание
project.id int идентификатор созданного проекта

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

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


Перейти