API - List of dictionaries

Материал из WebHMI Wiki
Версия от 14:08, 13 апреля 2018; Evgeniy.mozoliak (обсуждение | вклад) (Новая страница: «Example of querying information about the dictionary number 2:»)

Перейти к: навигация, поиск
Другие языки:
English • ‎русский

To get a list of all connections, you must perform a GET request on the URL like this: http://192.168.1.1/api/connections.

To obtain information about a particular register, you must perform a following GET request on a URL 'http://192.168.1.1/api/registers/1' . Here "1" is the ID of the desired register.

In the headers, it is necessary to pass API key. For example:

X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7

Also, in the headers, you must specify the desired data exchange format. Currently, only the JSON format is supported.

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


Example of querying a list of all dictionaries:

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

Headers:

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

Response example:

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


Example of querying information about the dictionary number 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,Авария"
}


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

idintУникальный идентификатор словаря
titlestringНазвание словаря
valuestringСодержание словаря. Записи словаря разделены тегом <br>. Каждая запись содержит пару ключ-значение разделенные запятой. Например: 1,Green Tea. Это значит что при значении регистра = 1 будет отображаться строка "Green Tea"