API - Список словарей — различия между версиями
Материал из WebHMI Wiki
(не показаны 3 промежуточные версии 2 участников) | |||
Строка 1: | Строка 1: | ||
+ | <languages/> | ||
+ | <translate> | ||
+ | <!--T:1--> | ||
Для получения списка всех словарей необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/dictionaries'''. | Для получения списка всех словарей необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/dictionaries'''. | ||
+ | <!--T:2--> | ||
Для получения информации о конкретном словаре необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/dictionaries/1'''. Здесь 1 - это ID нужного словаря. | Для получения информации о конкретном словаре необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/dictionaries/1'''. Здесь 1 - это ID нужного словаря. | ||
+ | <!--T:3--> | ||
В заголовках запроса ноебходимо передать API key. Например: | В заголовках запроса ноебходимо передать API key. Например: | ||
<pre> | <pre> | ||
Строка 8: | Строка 13: | ||
</pre> | </pre> | ||
+ | <!--T:4--> | ||
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | ||
<pre> | <pre> | ||
Строка 16: | Строка 22: | ||
+ | <!--T:5--> | ||
Пример запроса списка всех словарей: | Пример запроса списка всех словарей: | ||
+ | <!--T:6--> | ||
'''URL''': http://192.168.1.1/api/dictionaries<br> | '''URL''': http://192.168.1.1/api/dictionaries<br> | ||
'''Method''': GET | '''Method''': GET | ||
+ | <!--T:7--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
Строка 29: | Строка 38: | ||
</pre> | </pre> | ||
+ | <!--T:8--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
Строка 34: | Строка 44: | ||
{ | { | ||
"id": "1", | "id": "1", | ||
− | "title": " | + | "title": "Рецепты", |
− | " | + | "value": "1,Green Tea<br>2,Black Tea<br>3,Lemon Grass" |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
}, | }, | ||
{ | { | ||
"id": "2", | "id": "2", | ||
− | "title": " | + | "title": "Режим подогрева", |
− | " | + | "value": "0,Выкл.<br>1,Вкл.<br>2,Авария" |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
} | } | ||
] | ] | ||
Строка 69: | Строка 57: | ||
− | Пример запроса информации | + | <!--T:9--> |
+ | Пример запроса информации о словаре номер 2: | ||
− | '''URL''': http://192.168.1.1/api/ | + | <!--T:10--> |
+ | '''URL''': http://192.168.1.1/api/dictionaries/2<br> | ||
'''Method''': GET | '''Method''': GET | ||
+ | <!--T:11--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
Строка 79: | Строка 70: | ||
Content-Type: application/json | Content-Type: application/json | ||
Accept-Encoding: gzip, deflate, sdch | Accept-Encoding: gzip, deflate, sdch | ||
− | X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7 | + | X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7 |
</pre> | </pre> | ||
+ | <!--T:12--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
{ | { | ||
"id": "2", | "id": "2", | ||
− | "title": " | + | "title": "Режим подогрева", |
− | " | + | "value": "0,Выкл.<br>1,Вкл.<br>2,Авария" |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
} | } | ||
</pre> | </pre> | ||
Строка 104: | Строка 85: | ||
− | Атрибуты | + | <!--T:13--> |
+ | Атрибуты словаря: | ||
+ | <!--T:14--> | ||
<table> | <table> | ||
− | <tr><td>'''id'''</td><td>int</td><td>Уникальный идентификатор | + | <tr><td>'''id'''</td><td>int</td><td>Уникальный идентификатор словаря</td></tr> |
− | <tr><td>'''title'''</td><td>string</td><td>Название | + | <tr><td>'''title'''</td><td>string</td><td>Название словаря</td></tr> |
− | <tr><td>''' | + | <tr><td>'''value'''</td><td>string</td><td>Содержание словаря. Записи словаря разделены тегом <br>. Каждая запись содержит пару ключ-значение разделенные запятой. Например: 1,Green Tea. Это значит что при значении регистра = 1 будет отображаться строка "Green Tea"</td></tr> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</table> | </table> | ||
− | + | </translate> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + |
Текущая версия на 07:22, 16 апреля 2018
Для получения списка всех словарей необходимо выполнить 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 | Содержание словаря. Записи словаря разделены тегом <br>. Каждая запись содержит пару ключ-значение разделенные запятой. Например: 1,Green Tea. Это значит что при значении регистра = 1 будет отображаться строка "Green Tea" |