API - Список словарей — различия между версиями
Материал из WebHMI Wiki
| Строка 34: | Строка 34: | ||
{ | { | ||
"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: | Строка 47: | ||
| − | Пример запроса информации | + | Пример запроса информации о словаре номер 2: |
| − | '''URL''': http://192.168.1.1/api/ | + | '''URL''': http://192.168.1.1/api/dictionaries/2<br> |
'''Method''': GET | '''Method''': GET | ||
| Строка 79: | Строка 57: | ||
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> | ||
| Строка 86: | Строка 64: | ||
{ | { | ||
"id": "2", | "id": "2", | ||
| − | "title": " | + | "title": "Режим подогрева", |
| − | " | + | "value": "0,Выкл.<br>1,Вкл.<br>2,Авария" |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
} | } | ||
</pre> | </pre> | ||
| Строка 104: | Строка 71: | ||
| − | Атрибуты | + | Атрибуты словаря: |
<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> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Версия 10:22, 31 января 2015
Для получения списка всех словарей необходимо выполнить 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" |
