События¶
Карточка события¶
URI: /BumsTimeApiV01/Event/card.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID события. Обязательный параметр |
Выходные данные¶
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID события |
Description |
string |
Описание события |
Name |
string |
Название события |
TimeCreated |
datetime |
Дата и время создания |
StartTime |
datetime |
Начало события |
Duration |
integer |
Продолжительность события |
IsPersonal |
boolean |
Личное дело? |
EventCategory |
string |
Категория события |
Participants |
object (Id, Name) |
Список участников |
Contractors |
object (Id, Name |
Список контрагентов |
Reminders |
object (Transport, TimeBefore) |
Напоминания |
HasTodo |
boolean |
Имеет дела? |
HasCommunication |
boolean |
Имеет коммуникации? |
TodoLisId |
integer |
Код списка дел, в котором находится событие |
Position |
integer |
Порядковый номер события внутри списка дел |
Owner |
integer |
Id пользователя, создавшего событие |
IsFinished |
boolean |
Является ли событие завершенным |
Place |
string |
Место события |
IsFavorite |
bool |
Добавлено ли событие в избранное |
TimeUpdated |
datetime |
Время последней модификации события |
CanEdit |
bool |
Можно ли редактировать событие |
IsOverdue |
bool |
Просрочено ли событие |
Пример ответа в JSON-формате¶
{
"status":
{
"code":"ok",
"message":null
},
"data":
{
"Id":1001128,
"Description":"Meeting preparation",
"Name":"Meeting preparation",
"TimeCreated":"2011-05-17 19:26:23",
"StartTime":"2011-05-18 10:00:00",
"Duration":60,
"IsPersonal":false,
"EventCategory":"",
"Participants":[],
"Contractors":[],
"HasTodo":false,
"HasCommunication":false
}
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>
<code>ok</code>
<message></message>
</status>
<data>
<id>1001128</id>
<description>Meeting preparation</description>
<name>Meeting preparation</name>
<time_created>2011-05-17 19:26:23</time_created>
<start_time>2011-05-18 10:00:00</start_time>
<duration>60</duration>
<is_personal></is_personal>
<event_category></event_category>
<participants/>
<contractors/>
<has_todo></has_todo>
<has_communication></has_communication>
</data>
</response>
Список категорий события¶
URI: /BumsTimeApiV01/Event/categories.api|xml
Входные параметры¶
Отсутствуют
Выходные данные¶
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
Id категории |
Name |
string |
Название категории |
Пример ответа в JSON-формате¶
{
"status":
{
"code":"ok",
"message":null
},
"data":
{
"categories":
[
{
"Id":1001128,
"Name":"Праздник"
},
{
"Id":1001160,
"Name":"Звонок"
}
]
}
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>
<code>ok</code>
<message></message>
</status>
<data>
<categories>
<item>
<id>1001128</id>
<name>Праздник</name>
</item>
<item>
<id>1001160</id>
<name>Звонок</name>
</item>
</categories>
</data>
</response>
Создание события¶
URI: /BumsTimeApiV01/Event/create.api|xml
Входные параметры¶
Выходные данные¶
В выходных данных будет два блока: event и communication или todo, в зависимости от того, что было создано - коммуникация или дело.
Информация о событии (event):
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID события |
Name |
string |
Название события |
From |
date или datetime |
Дата начала события |
To |
date или datetime |
Дата завершения события |
Информация о коммуникации (communication):
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID коммуникации |
Name |
string |
Название коммуникации |
Place |
object |
Место проведения коммуникации |
Информация о деле (todo):
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID дела |
Name |
string |
Название дела |
TodoList |
object |
Список дел, к которому привязано новое дело |
Удаление события¶
URI: /BumsTimeApiV01/Event/delete.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
Код события, которое нужно удалить. При удалении события удаляются связанные с ним дела/коммуникации |
Выходные параметры¶
отсутствуют
Завершение/возобновление события¶
URI: /BumsTimeApiV01/Event/finish.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
Код события, которое нужно завершить |
Finish |
boolean |
Завершить/возобновить событие. По умолчанию true - завершить |
Result |
string |
Результат |
SendLetter |
boolean |
Отправить результат и прикреплённые файлы участникам. По умолчанию false |
Выходные параметры¶
отсутствуют
Список событий¶
URI: /BumsTimeApiV01/Event/list.api|xml
Входные параметры¶
Поле |
Тип |
Допустимые значения |
Описание |
|---|---|---|---|
TodoListId |
integer |
Id списка дел к которому должно относиться событие |
|
Limit |
integer |
Сколько выбрать событий(LIMIT) |
|
Offset |
integer |
Начиная с какого выбирать события (OFFSET) |
|
OnlyActual |
boolean |
Только не завершенные события (true) или все события (false). По умолчанию true |
|
Search |
string |
Поиск по названию события |
Если TodoListId не задан, то будет возвращён полный список событий.
В случае использования параметра Search, параметр OnlyActual игнорируется.
Выходные данные¶
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
Id события |
Description |
string |
Описание события |
Name |
string |
Название события |
TimeCreated |
datetime |
Дата и время создания |
StartTime |
datetime |
Начало события |
Duration |
integer |
Продолжительность события |
IsPersonal |
boolean |
Личное дело? |
EventCategory |
string |
Категория события |
Participants |
object (Id, Name) |
Список участников |
Contractors |
object (Id, Name) |
Список контрагентов |
Reminders |
object (Transport, TimeBefore) |
Напоминания |
HasTodo |
boolean |
Имеет дела? |
HasCommunication |
boolean |
Имеет коммуникации? |
TodoLisId |
integer |
Код списка дел, в котором находится событие |
Position |
integer |
Порядковый номер события внутри списка дел |
Owner |
integer |
Id пользователя, создавшего событие |
IsFinished |
boolean |
Является ли событие завершенным |
Place |
string |
Место события |
IsFavorite |
bool |
Добавлено ли событие в избранное |
TimeUpdated |
datetime |
Время последней модификации события |
CanEdit |
bool |
Можно ли редактировать событие |
IsOverdue |
bool |
Просрочено ли событие |
Пример ответа в JSON-формате¶
{
"status":
{
"code":"ok",
"message":null
},
"data":
[
{
"Id":1001128,
"Description":"Meeting preparation",
"Name":"Meeting preparation",
"TimeCreated":"2011-05-17 19:26:23",
"StartTime":"2011-05-18 10:00:00",
"Duration":60,
"IsPersonal":false,
"EventCategory":"",
"Participants":[],
"Contractors":[],
"HasTodo":false,
"HasCommunication":false
},
{
"Id":1001160,
"Name":"Meeting",
"TimeCreated":"2011-05-17 19:38:28",
"StartTime":"2011-05-18 11:00:00",
"Duration":60,
"IsPersonal":false,
"EventCategory":"Совещание",
"Participants":
[
{
"Id": "1234"
"Name": "Ivanov Ivan"
},
{
"Id": "1235"
"Name": "Lee Bruce"
}
],
"Contractors":
[
{
"Id": "4321"
"Name": "Petr Petrov"
}
],
"HasTodo":false,
"HasCommunication":true
}
]
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>
<code>ok</code>
<message></message>
</status>
<data>
<item>
<id>1001128</id>
<description>Meeting preparation</description>
<name>Meeting preparation</name>
<time_created>2011-05-17 19:26:23</time_created>
<start_time>2011-05-18 10:00:00</start_time>
<duration>60</duration>
<is_personal></is_personal>
<event_category></event_category>
<participants/>
<contractors/>
<has_todo></has_todo>
<has_communication></has_communication>
</item>
<item>
<id>1001160</id>
<name>Meeting</name>
<time_created>2011-05-17 19:38:28</time_created>
<start_time>2011-05-18 11:00:00</start_time>
<duration>60</duration>
<is_personal></is_personal>
<event_category>Совещание</event_category>
<participants>
<item>
<id>1234</id>
<name>Ivanov Ivan</name>
</item>
<item>
<id>1235</id>
<name>Lee Bruce</name>
</item>
</participants>
<contractors>
<item>
<id>4321</id>
<name>Petr Petrov</name>
</item>
</contractors>
<has_todo></has_todo>
<has_communication>1</has_communication>
</item>
</data>
</response>
Список мест для проведения коммуникации¶
URI: /BumsTimeApiV01/Event/places.api|xml
Входные параметры¶
Отсутствуют
Выходные данные¶
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
Id места |
Name |
string |
Название места |
Пример ответа в JSON-формате¶
{
"status":
{
"code":"ok",
"message":null
},
"data":
{
"places":
[
{
"Id":1001128,
"Name":"Первая переговорная"
},
{
"Id":1001160,
"Name":"Вторая переговорная"
}
]
}
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>
<code>ok</code>
<message></message>
</status>
<data>
<places>
<item>
<id>1001128</id>
<name>Первая переговорная</name>
</item>
<item>
<id>1001160</id>
<name>Вторая переговорная</name>
</item>
</places>
</data>
</response>
Обновление события¶
URI: /BumsTimeApiV01/Event/update.api|xml
Входные параметры¶
* если при редактировании вы указываете новых участников события, участники будут добавлены к уже существующим
Выходные данные¶
В выходных данных будет два блока: event и communication или todo, в зависимости от того, что было обновлено - коммуникация или дело.
Информация о событии (event):
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID события |
Name |
string |
Название события |
From |
date или datetime |
Дата начала события |
To |
date или datetime |
Дата завершения события |
Информация о коммуникации (communication):
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID коммуникации |
Name |
string |
Название коммуникации |
Place |
object |
Место проведения коммуникации |
Информация о деле (todo):
Поле |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID дела |
Name |
string |
Название дела |
TodoList |
object |
Список дел, к которому привязано новое дело |