Документация Связаться с нами

Списки дел¶

Список списков дел¶

URI: /BumsTimeApiV01/TodoList/list.api|xml

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

Поле	Тип	Описание
OnlyActual	boolean	Возвращает только актуальные. По умолчанию true

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

Поле	Тип	Описание
Id	integer	Id списка дел
Name	string	Название списка дел
TodoCount	integer	Количество незавершенных дел в списке

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

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "data":
  [
    {
      "Id":88,
      "Name":"TestList",
      "TodosCount":0
    },
    {
      "Id":89,
      "Name":"RealList",
      "TodosCount":5
    }
  ]
}

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

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <data>
    <item>
      <id>88</id>
      <name>TestList</name>
      <todos_count>0</todos_count>
    </item>
    <item>
      <id>89</id>
      <name>RealList</name>
      <todos_count>5</todos_count>
    </item>
  </data>
</response>

Создание списка дел¶

URI: /BumsTimeApiV01/TodoList/create.api|xml

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

Параметр	Тип	Описание
Name	string	Название списка дел

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

Поле	Тип	Описание
Id	integer	Id созданного списка

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

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "Name":"TestList"
  },
  "data":
  {
    "Id":88
  }
}

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

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
    <name>TestList</name>
  </params>
  <data>
    <id>88</id>
  </data>
</response>

Редактирование списка дел¶

URI: /BumsTimeApiV01/TodoList/edit.api|xml

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

Параметр	Тип	Описание
Id	integer	Id списка дел
Name	string	Новое имя списка

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

Поле	Тип	Описание
Id	integer	Id измененного списка

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

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "Id":88,
    "Name":"TestList"
  },
  "data":
  {
    "Id":88
  }
}

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

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
    <id>88</id>
    <name>TestList</name>
  </params>
  <data>
    <id>88</id>
  </data>
</response>

Удаление списка дел¶

URI: /BumsTimeApiV01/TodoList/delete.api|xml

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

Параметр	Тип	Описание
Id	integer	Id списка дел

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

Поле	Тип	Описание
Id	integer	Id удаленного списка

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

{
  "status":
  {
    "code":"ok",
    "message":null
  },
  "params":
  {
    "Id":88
  },
  "data":
  {
    "Id":88
  }
}

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

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>
    <code>ok</code>
    <message></message>
  </status>
  <params>
    <id>88</id>
  </params>
  <data>
    <id>88</id>
  </data>
</response>