Задать вопрос

Избранное

Добавить в избранное

URI: /BumsCommonApiV01/Favorite/add.api|xml

Входные параметры

Поле Тип Допустимые значения Описание
SubjectType string task (задача), project (проект), comment (комментарий), event (событие) Тип объекта
SubjectId integer   ID объекта

Выходные данные

Нет выходных данных

Список избранного

URI: /BumsCommonApiV01/Favorite/list.api|xml

Входные параметры

Параметр Тип Допустимые значения Значение по умолчанию Описание
TimeUpdated string Дата/время в одном из форматов ISO 8601 нет Возвращать только те объекты, которые были изменены после указанный даты

Выходные данные

Поле Тип Описание
Tasks array Список задач, см. структуру в списке задач
Projects array Список проектов, см. структуру в списке проектов
Events array Список событий (структуру см. ниже)
To-dos array Список дел (структуру см. ниже)
Comments array Список комментариев (структуру см. ниже)

Список событий

Поле Тип Описание
Name string Название события
From string Дата начала события
To string Дата окончания события
Participants array (Id, Name) Список участников события
Owner object (Id, Name) Владелец события
Description string Описание события
TImeCreated string Время создания события

Список дел

Поле Тип Описание
Name string Название дела
TimeFinished string Дата завершения дела (если дата пустая, значит дело не завершено)
TimeCreated string Дата создания дела
OrderPos integer Порядковый номер дела в списке дел
TodoList object (Id, Name) Список дел, в котором находится дело
Owner object (Id, Name) Владелец дела
From string Дата начала дела. Дата будет пустой, если дело является нераспределенным
To string Дата окончания дела. Дата будет пустой, если дело является нераспределенным

Список комментариев

Поле Тип Описание
Text string Текст комментария
TextHtml string Текст комментария в формате HTML
Parent object (Id, Name) Родительский комментарий
TimeCreated string Время создани комментария
Work string Отработанное время
WorkDate string Дата списания отработанного времени

Пример ответа в JSON-формате

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "data":
  {
    "Tasks":
    [
      {
        "Id":841,
        "Name":"Test task",
        "Status":"cancelled",
        "Deadline":"",
        "Owner":
        {
          "Id":3,
          "Name":"Ivanov Ivan"
        },
        "Responsible":
        {
          "Id":651,
          "Name":"Medvedev Dima"
        },
        "Favorite":"1",
        "TimeCreated":"2011-02-08 17:57:51"
      }
    ],
    "Projects":
    [
      {
        "Id":847,
        "Name":"Test project",
        "Statement":"<p>In addition to providing easy access.<\/p>",
        "Status":"accepted",
        "Deadline":"",
        "Owner":
        {
          "Id":3,
          "Name":"Ivanov Ivan"
        },
        "Responsible":
        {
          "Id":651,
          "Name":"Medvedev Dima"
        },
        "Favorite":"1",
        "TimeCreated":"2011-02-09 18:40:12"
      }
    ],
    "Events":
    [
      {
        "Name":"Важная встреча",
    "From":"2012-01-05",
    "To":"2012-01-06",
    "Participants":
        [
          {
            "Id":8736,
            "Name":"Ivanov Petr"
          }
        ],
    "Owner":
        {
          "Id":732,
          "Name":"Pupkin Vasya"
        },
        "Description":"Очень важное совещание",
    "TimeCreated":"2012-01-01 15:00"
      }
    ],
    "To-dos":
    [
      {
        "Name":"Зайти в магазин",
        "TimeFinished":"2012-02-02 14:30",
        "TimeCreated":"2012-01-01 12:10",
        "OrderPos":1,
        "TodoList":108,
        "Owner":
        {
          "Id":326,
          "Name":"Petrov Petr"
        },
        "From":"2012-03-03 16:00",
        "To":"2012-03-03 17:00"
      }
    ],
    "Comments":
    [
      {
        "Text":"Текст комментария",
        "TextHtml":"<p>Текст комментария в HTML</p>",
        "Parent":
        {
          "Id":1237,
          "Name":"Текст родительского комментария"
        },
        "TimeCreated":"2012-04-04 13:53",
        "Work":"1 час",
        "WorkDate":"2012-02-02"
      }
    ]
  }
}

Пример ответа в XML-формате

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <data>
    <tasks>
      <item>
        <id>841</id>
        <name>Test task</name>
        <status>cancelled</status>
        <deadline></deadline>
        <owner>
          <id>3</id>
          <name>Ivanov Ivan</name>
        </owner>
        <responsible>
          <id>651</id>
          <name>Medvedev Dima</name>
        </responsible>
        <favorite>1</favorite>
        <time_created>2011-02-08 17:57:51</time_created>
      </item>
    </tasks>
    <projects>
      <item>
        <id>847</id>
        <name>Test project</name>
        <statement><p>In addition to providing easy access.<\/p></statement>
        <status>accepted</status>
        <deadline></deadline>
        <owner>
          <id>3</id>
          <name>Ivanov Ivan</name>
        </owner>
        <responsible>
          <id>651</id>
          <name>Medvedev Dima</name>
        </responsible>
        <favorite>1</favorite>
        <time_created>2011-02-09 18:40:12</time_created>
      </item>
    </projects>
    <events>
      <item>
        <name>Важная встреча</name>
        <from>2012-01-05</from>
        <to>2012-01-06</to>
        <participants>
          <item>
            <id>8736</id>
            <name>Ivanov Petr</name>
          </item>
        </participants>
        <owner>
          <id>732</id>
          <name>Pupkin Vasya</name>
        </owner>
        <description>Очень важное совещание</description>
        <time_created>2012-01-01 15:00</time_created>
      </item>
    </events>
    <to-dos>
      <item>
        <name>Зайти в магазин</name>
        <time_finished>2012-02-02 14:30<time_finished>
        <time_created>2012-01-01 12:10</time_created>
        <order_pos>1</order_pos>
        <todo_list>108</todo_list>
        <owner>
          <id>326</id>
          <name>Petrov Petr</name>
        </owner>
        <from>2012-03-03 16:00</from>
        <to>2012-03-03 17:00</to>
      </item>
    </to-dos>
    <comments>
      <item>
        <text>Текст комментария</text>
        <text-html><p>Текст комментария в HTML</p></text-html>
        <parent>
          <id>1237</id>
          <name>Текст родительского комментария</name>
        </parent>
        <time_created></time_created>
        <work>1 час</work>
        <work_date>2012-02-02</work_date>
      </item>
    </comments>
  </data>
</response>

Удалить из избранного

URI: /BumsCommonApiV01/Favorite/remove.api|xml

Входные параметры

Поле Тип Допустимые значения Описание
SubjectType string task (задача), project (проект), comment (комментарий), event (событие) Тип объекта
SubjectId integer   ID объекта

Выходные данные

Нет выходных данных