ПланФикс API project.add: различия между версиями
Материал из Planfix
Seva (обсуждение | вклад) Нет описания правки |
Seva (обсуждение | вклад) Нет описания правки |
||
| Строка 18: | Строка 18: | ||
<hasEndDate></hasEndDate> | <hasEndDate></hasEndDate> | ||
<endDate></endDate> | <endDate></endDate> | ||
<group> | |||
<id></id> | |||
</group> | |||
<auditors> | |||
<id></id> | |||
<id></id> | |||
<!-- ... --> | |||
</auditors> | |||
<managers> | |||
<id></id> | |||
<id></id> | |||
<!-- ... --> | |||
</managers> | |||
<workers> | |||
<id></id> | |||
<id></id> | |||
<!-- ... --> | |||
</workers> | |||
</project> | </project> | ||
<signature></signature> | <signature></signature> | ||
| Строка 36: | Строка 54: | ||
|owner.id || int || идентификатор пользователя, который будет считаться создателем проекта. || допускается значение 0 (ноль). В этом случае будет назначен владельцем пользователь, от имени которого выполняется запрос (определяется по sid) | |owner.id || int || идентификатор пользователя, который будет считаться создателем проекта. || допускается значение 0 (ноль). В этом случае будет назначен владельцем пользователь, от имени которого выполняется запрос (определяется по sid) | ||
|- | |- | ||
|client || || || | |client || || ||необязательный параметр | ||
|- | |- | ||
|client.id || int || идентификатор контрагента || допускается значение 0 (ноль). | |client.id || int || идентификатор контрагента || допускается значение 0 (ноль). | ||
| Строка 47: | Строка 65: | ||
|- | |- | ||
|endDate ||DateTime || ||учитывается только в том случае, если параметр '''hasEndDate''' установлен в ''true'' | |endDate ||DateTime || ||учитывается только в том случае, если параметр '''hasEndDate''' установлен в ''true'' | ||
|- | |||
|group || || ||необязательный параметр | |||
|- | |||
|group.id || int || идентификатор группы проектов || | |||
|- | |||
|auditors || || аудиторы проекта ||необязательный параметр | |||
|- | |||
|auditors.id || int || идентификатор аудитора проекта || | |||
|- | |||
|managers || || менеджеры проекта ||необязательный параметр | |||
|- | |||
|managers.id || int || идентификатор менеджера проекта || | |||
|- | |||
|workers || || исполнители по умолчанию проекта ||необязательный параметр | |||
|- | |||
|workers.id || int || идентификатор исполнителя по умолчанию проекта || | |||
|- | |- | ||
|} | |} | ||
Версия от 06:48, 24 сентября 2012
Запрос на создание проекта имеет следующий вид:
<?xml version="1.0" encoding="UTF-8"?>
<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>
<group>
<id></id>
</group>
<auditors>
<id></id>
<id></id>
<!-- ... -->
</auditors>
<managers>
<id></id>
<id></id>
<!-- ... -->
</managers>
<workers>
<id></id>
<id></id>
<!-- ... -->
</workers>
</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 | |
| group | необязательный параметр | ||
| group.id | int | идентификатор группы проектов | |
| auditors | аудиторы проекта | необязательный параметр | |
| auditors.id | int | идентификатор аудитора проекта | |
| managers | менеджеры проекта | необязательный параметр | |
| managers.id | int | идентификатор менеджера проекта | |
| workers | исполнители по умолчанию проекта | необязательный параметр | |
| workers.id | int | идентификатор исполнителя по умолчанию проекта |
Ответ при успешном создании проекта:
<?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>