Обсуждения¶
Карточка обсуждения¶
URI: /BumsDiscussApiV01/Topic/card.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID обсуждения |
Выходные данные¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID обсуждения |
Subject |
string |
Тема обсуждения |
Content |
string |
Содержание обсуждения |
TimeCreated |
datetime |
Время создания обсуждения |
Owner |
object<Id,Name> |
Автор обсуждения |
Participants |
object<Id,Name> |
Пользователи, участвующие в обсуждении |
Пример ответа в JSON-формате¶
{
"status":
{
"code":"ok",
"message":null
},
"params":
{
"Id":1
},
"data":
{
"topic":
{
"Id":1,
"Subject":"Орг вопрос",
"Content":"У нашего администратора появился помощник, который берет на себя часть обязательств",
"Owner":
{
"Id":2,
"Name":"Director"
},
"Participants":
[
{
"Id": 123456,
"Name":"Иван Петров"
},
{
"Id": 123457,
"Name": "Петр Иванов"
}
],
"TimeCreated":"2007-12-13 12:24:12"
}
}
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>
<code>ok</code>
<message></message>
</status>
<params>
<id>1</id>
</params>
<data>
<topic>
<id>1</id>
<subject>Тема обсуждения</subject>
<content>Содержание обсуждения</content>
<owner>
<id>2</id>
<name>Director</name>
</owner>
<participants>
<item>
<id>3</id>
<name>Иван Петров</name>
<item>
<item>
<id>3</id>
<name>Петр Иванов</name>
<item>
</participants>
<time_created>2007-12-13 12:24:12</time_created>
</topic>
</data>
</response>
Создание обсуждения¶
URI: /BumsDiscussApiV01/Topic/create.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
||
Model[Subject] |
string |
Тема |
||
Model[Content] |
string |
Содержание |
||
Model[IsDiscussable] |
bollean |
Разрешены ли комментарии |
||
Model[Section] |
integer |
Раздел |
||
Model[Participants] |
string |
Для кого обсуждение.Возможные значения: Employees - все сотрудники, EmployeesInOffice - все, кроме внештатников или ID сотрудников через запятую |
||
Model[Attach] |
string |
Закрепить обсуждение. Возможные значения - „forever“ или дата в формате ГГГГ-ММ-ДД |
||
Model[Attaches] |
array |
Массив приложенных файлов, должен передаваться POST-запросом |
||
Model[Attaches][0…n][Content] |
string |
Данные(контент файла), закодированные с использованием MIME base64 |
||
Model[Attaches][0…n][Name] |
string |
Имя файла ( будет фигурировать при выводе обсуждения) |
Выходные данные¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID обсуждения |
Subject |
string |
Тема обсуждения |
Удаление обсуждения¶
URI: /BumsDiscussApiV01/Topic/delete.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID удаляемого обсуждения |
Редактирование обсуждения¶
URI: /BumsDiscussApiV01/Topic/edit.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
Model[Subject] |
string |
Тема |
Model[Content] |
string |
Содержание |
Model[IsDiscussable] |
bollean |
Разрешены ли комментарии |
Model[Section] |
integer |
Раздел |
Model[Participants] |
string |
Для кого обсуждение.Возможные значения: Employees - все сотрудники, EmployeesInOffice - все, кроме внештатников или ID сотрудников через запятую |
Model[Attach] |
string |
Закрепить обсуждение. Возможные значения - „forever“ или дата в формате ГГГГ-ММ-ДД |
Model[Attaches][Add] |
array<object(Content, Name)> |
Массив на добавление вложений в задачу. Content - файл закодированный по алгоритму MIME base64, Name - пользовательское имя файла |
Model[Attaches][Delete] |
array<string> |
Массив из уникальных имен файлов для удаления |
Выходные данные¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID обсуждения |
Subject |
string |
Тема обсуждения |
Список обсуждений¶
URI: /BumsDiscussApiV01/Topic/list.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
Section |
integer |
Категория обсуждения |
DateFrom |
datetime |
Дата создания больше или равна |
DateTo |
datetime |
Дата создания меньше или равна |
qs |
string |
Строка, по которой нужно искать |
Выходные данные (массив обсуждений с полями)¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
Идентификатор обсуждения |
Subject |
string |
Тема обсуждения |
Content |
string |
Содержание |
IsDiscussable |
boolean |
Открыто ли обсуждение |
Owner |
object<Id, Name> |
Автор обсуждения |
Section |
object<Id,Name> |
Категория обсуждения |
TimeCreated |
datetime |
Дата создания |
Пример ответа в JSON-формате¶
{
"status":
{
"code":"ok",
"message":null
},
"params":
{
"Section":"1"
},
"data":
{
"topics":
[
{
"Id":841,
"Subject":"Нам 10 лет!!!",
"Content":"Наша компания отмечает 10-летие",
"IsDiscussable": true,
"Owner":
{
"Id":2,
"Name":"Иван петров"
},
"Section":
{
"Id":1,
"Name":"Новости"
},
"Favorite":"",
"TimeCreated":"2007-12-13 12:24:12",
"Attach": "forever"
},
{
"Id":842,
"Subject":"Отпуск Марии Ивановой",
"Content":"Буду в отпуске с 1-10 августа",
"IsDiscussable": true,
"Owner":
{
"Id":3,
"Name":"Мария Иванова"
},
"Section":
{
"Id":1,
"Name":"Новости"
},
"Favorite":"",
"TimeCreated":"2011-07-13 12:24:12",
"Attach": "2011-08-10"
}
]
}
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>
<code>ok</code>
<message></message>
</status>
<params>
<section>1</section>
<date_from></date_from>
<date_to></date_to>
</params>
<data>
<topics>
<item>
<id>70</id>
<content>Супер пупер обсуждение, флудим по полной</content>
<is_discussable>1</is_discussable>
<owner>
<id>1</id>
<name>Иван Петров</name>
</owner>
<subject>Новая тема</subject>
<section>
<id>1</id>
<name>Новости</name>
</section>
<time_created>2012-07-17 13:54:44</time_created>
<attach>2012-07-27</attach>
</item>
<item>
<id>71</id>
<content>Супер пупер обсуждение, флудим по полной</content>
<is_discussable>1</is_discussable>
<owner>
<id>2</id>
<name>Сергей Иванов</name>
</owner>
<subject>Новая тема - 2</subject>
<section>
<id>1</id>
<name>Новости</name>
</section>
<time_created>2012-07-17 13:54:44</time_created>
<attach>2012-07-27</attach>
</item>
</topics>
</data>
</response>
Список разделов обсуждений¶
URI: /BumsDiscussApiV01/Topic/sectionList.api|xml
Выходные данные (массив категорий с полями)¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
Идентификатор категории |
Name |
string |
Название |
Color |
string |
Цвет метки категории |
Пример ответа в JSON-формате¶
{
"status":
{
"code":"ok",
"message":null
},
"data":
{
"sections":
[
{
"Id":"3",
"Name":"Новости",
"Color":"#ff4e00"
},
{
"Id":"2",
"Name":"Отдых",
"Color":"#000080"
}
]
}
}
Пример ответа в XML-формате¶
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>
<code>ok</code>
<message></message>
</status>
<data>
<sections>
<item>
<id>3</id>
<name>Новости</name>
<color>#ff4e00</color>
</item>
<item>
<id>2</id>
<name>Отдых</name>
<color>#000080</color>
</item>
</sections>
</data>
</response>
Открыть/Закрыть обсуждение¶
URI: /BumsDiscussApiV01/Topic/toggleTopic.api|xml
Входные параметры¶
Параметр |
Тип |
Описание |
|---|---|---|
Id |
integer |
ID обсуждения |
IsDiscussable |
boolean |
Открыть/Закрыть обсуждение (true - открыть, false - закрыть) |
Пример ответа в JSON-формате¶
{
"status":
{
"code":"ok",
"message":null
},
"params":
{
"Id":123
"IsDiscussable":"1",
}
}