API - Список словарей

Материал из WebHMI
Перейти к: навигация, поиск

Для получения списка всех словарей необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/dictionaries.

Для получения информации о конкретном словаре необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/dictionaries/1. Здесь 1 - это ID нужного словаря.

В заголовках запроса необходимо передать API key. Например:

X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7

Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом JSON.

Accept: application/json
Content-Type: application/json

Пример запроса списка всех словарей:

URL: http://192.168.1.1/api/dictionaries
Method: GET

Заголовки:

Accept: application/json
Content-Type: application/json
Accept-Encoding: gzip, deflate, sdch
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7

Пример ответа:

[
  {
    "id": "1",
    "title": "Рецепты",
    "value": "1,Green Tea<br>2,Black Tea<br>3,Lemon Grass"
  },
  {
    "id": "2",
    "title": "Режим подогрева",
    "value": "0,Выкл.<br>1,Вкл.<br>2,Авария"
  }
]

Пример запроса информации о словаре номер 2:

URL: http://192.168.1.1/api/dictionaries/2
Method: GET

Заголовки:

Accept: application/json
Content-Type: application/json
Accept-Encoding: gzip, deflate, sdch
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7

Пример ответа:

{
  "id": "2",
  "title": "Режим подогрева",
  "value": "0,Выкл.<br>1,Вкл.<br>2,Авария"
}

Атрибуты словаря:

  • id int Уникальный идентификатор словаря
  • title string Название словаря
  • value string Содержание словаря. Записи словаря разделены тегом
    . Каждая запись содержит пару ключ-значение разделенные запятой. Например: 1,Green Tea. Это значит что при значении регистра = 1 будет отображаться строка "Green Tea"