ПланФикс API:Проекты

Список функций позволяющий манипулировать с проектами.

progect.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>{true|false}</hidden><!-- Скрытый -->
		<HasEndDate>{true|false}</HasEndDate>
		<EndDate><!-- Дата завершения проекта --></EndDate>
	</project>
</request>

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

Ответ при успешном создании проекта:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
	<project>
		<id></id>
	</project>
</response>

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>{true|false}</hidden><!-- Скрытый -->
		<HasEndDate>{true|false}</HasEndDate>
		<EndDate><!-- Дата завершения проекта --></EndDate>
	</project>
</request>

Результатом удачного выполнения запроса является следующий ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
	<project>
		<id></id>
	</project>
</response>
</sorce>

project.get Получить информацию о проекте

Запрос на получение информации о проекте

<?xml version="1.0" encoding="UTF-8"?>
<request method="project.get">
	<account><!-- имя аккаунта --></account>
	<sid><!-- ключ сессии, полученный после аутентификации --></sid>
	<id><!-- идентификатор проекта --></id>
</request>

Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
	<project>
		<id></id>
		<title></title>
		<description></description>
		<!-- Автор проекта -->
		<owner>
			<id></id>
			<name></name>
		</owner>
		<!-- контрагент -->
		<client>
			<id></id>
			<name></name>
		</client>
		<!-- статус проекта -->
		<status></status>
		<hidden>{true|false}</hidden><!-- Скрытый -->
		<hasEndDate>{true|false}</hasEndDate>
		<endDate><!-- Дата завершения проекта --></endDate>
		<beginDate><!-- дата создания проекта --></beginDate>
		<isOverdued><!-- просроченный ли проект --></isOverdued>
		<!-- осталось 25% времени до завершения или прошло 75% отведенного времени на выполнение его -->
		<isCloseToDeadline>{true|false}</isCloseToDeadline>
	</project>
</response>

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

Используемые константы

Статусы проектов

• DRAFT - черновик
• COMPLETED - завершен
• ACTIVE - активен

Возвращаемые ошибки

• 2001 - проект не существует

Перейти

ПланФикс API