Глобальный поиск¶

URI: /BumsCommonApiV01/Search/quick.api|xml

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

Параметр	Тип	Описание
qs	string	Текст для поиска

Если параметр qs не указан либо пустой, то будет возвращена ошибка «Empty query». Если же, результатов соответствующих запросу не найдено, то в выходных данных будет возвращена ошибка «No results».

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

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

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

Поле	Тип	Описание
Name	string	Название события
From	string	Дата начала события
To	string	Дата окончания события
Participants	array<object> (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	Дата окончания дела. Дата будет пустой, если дело является нераспределенным

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

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "qs":"ivan"
  },
  "data":
  {
    "Employees":
    [
      {
        "Id":1087,
        "Name":"Denisov Ivan",
        "LastName":"Denisov",
        "FirstName":"Ivan",
        "MiddleName":"",
        "Position":
        {
          "Id":194,
          "Name":"Manager"
        },
        "Email":"denosov@megaplan.ru",
        "Status":
        {
          "Id":22,
          "Name":"In Office"
        },
        "TimeCreated":"2010-03-26 18:10:32"
      }
    ],
    "Tasks":
    [
      {
        "Id":841,
        "Name":"Test task",
        "Status":"cancelled",
        "Deadline":"",
        "Owner":
        {
          "Id":3,
          "Name":"Ivanov Ivan"
        },
        "Responsible":
        {
          "Id":651,
          "Name":"Medvedev Dima"
        },
        "Favorite":"",
        "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":"",
        "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"
      }
    ]
  }
}

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

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
    <qs>ivan</qs>
  </params>
  <data>
    <employees>
      <item>
        <id>1087</id>
        <name>Denisov Ivan</name>
        <last_name>Denisov</last_name>
        <first_name>Ivan</first_name>
        <middle_name></middle_name>
        <position>
          <id>194</id>
          <name>Manager</name>
        </position>
        <email>denosov@megaplan.ru</email>
        <status>
          <id>22</id>
          <name>In Office</name>
        </status>
        <time_created>2010-03-26 18:10:32</time_created>
      </item>
    </employees>
    <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></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>
        <deadline_type>medium</deadline_type>
        <owner>
          <id>3</id>
          <name>Ivanov Ivan</name>
        </owner>
        <responsible>
          <id>651</id>
          <name>Medvedev Dima</name>
        </responsible>
        <favorite></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>
  </data>
</response>