OMNIDESK API
Категории предложений
Создание категории
POST  |  https://[domain].omnidesk.ru/api/ideas_category.json
Создание категории.
Параметры
Запрос
{
  "ideas_category" : {
    "category_title" : "Test category",
  }
}
Ответ
{
  "ideas_category" : {
    "category_id" : 234,
    "category_title" : "Test category",
    "active" : true,
  }
}
Пример кода
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X POST -d '{ "ideas_category": { "category_title":"Test category" }}' https://[domain].omnidesk.ru/api/ideas_category.json
Получение списка категорий
GET  |  https://[domain].omnidesk.ru/api/ideas_category.json
Получение списка категорий.
Параметры
Ответ
{
    "0" : {
      "ideas_category" : {
        "category_id" : 234,
        "category_title" : "Test category 1",
        "active" : true,
      }
    },
    "1" : {
      "ideas_category" : {
        "category_id" : 235,
        "category_title" : "Test category 2",
        "active" : false,
      }
    },
    "total_count":10
}
Пример кода
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X GET https://[domain].omnidesk.ru/api/ideas_category.json?limit=50&page=2
Просмотр категории
GET  |  https://[domain].omnidesk.ru/api/ideas_category/[id].json
Просмотр категории.
Ответ
{
  "ideas_category" : {
    "category_id" : 234,
    "category_title" : "Test category",
    "active" : true,
  }
}
Пример кода
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X GET https://[domain].omnidesk.ru/api/ideas_category/234.json
Редактирование категории
PUT  |  https://[domain].omnidesk.ru/api/ideas_category/[id].json
Редактирование категории.
Параметры
Запрос
{
  "ideas_category" : {
    "category_title" : "Test category 2",
  }
}
Ответ
{
  "ideas_category" : {
    "category_id" : 234,
    "category_title" : "Test category 2",
    "active" : true,
  }
}
Пример кода
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X PUT -d '{ "ideas_category": { "category_title":"Test category 2" }}' https://[domain].omnidesk.ru/api/ideas_category/234.json
Выключение категории
PUT  |  https://[domain].omnidesk.ru/api/ideas_category/[id]/disable.json
Выключение категории.
Ответ
{
  "ideas_category" : {
    "category_id" : 234,
    "category_title" : "Test category 2",
    "active" : false,
  }
}
Пример кода
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X PUT -d '' https://[domain].omnidesk.ru/api/ideas_category/234/disable.json
Включение категории
PUT  |  https://[domain].omnidesk.ru/api/ideas_category/[id]/enable.json
Включение категории.
Ответ
{
  "ideas_category" : {
    "category_id" : 234,
    "category_title" : "Test category 2",
    "active" : true,
    "created_at" : Mon, 05 May 2014 00:15:17 +0300,
    "updated_at" : Tue, 23 Dec 2014 10:55:23 +0200
  }
}
Пример кода
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X PUT -d '' https://[domain].omnidesk.ru/api/ideas_category/234/enable.json
Удаление категории
DELETE  |  https://[domain].omnidesk.ru/api/ideas_category/[id].json
Удаление категории.
Ответ
HTTP Status: 200 OK
Пример кода
curl -u [staff_email]:[api_key] -H "Content-Type: application/json" -X DELETE https://[domain].omnidesk.ru/api/ideas_category/234.json