Запрос доступных постов
Структура URL-запроса get-post-set определяется форматом:
Если структура URL-запроса get-post-set соответствует требованиям, сервер, после успешной обработки запроса, возвращает ответ с HTTP-кодом 200. Тело ответа содержит application/JSON-документ get_post-set_rbody-200 с параметрами:
"status" :: uint16_t. Содержит 200.
"result" :: char[][37]. Массив. Каждый элемент содержит глобальный идентификатор поста.
Пример get_post-set_rbody-200:
{
"status": 200,
"result":
[
"a51d1532-466f-490a-8b06-753cfef7de28"
]
}
Структура URL-запроса get_post-set2 определяется форматом:
Сервер, после успешной обработки запроса get_post-set2, возвращает ответ с HTTP-кодом 200. Тело ответа содержит application/JSON-документ get_post-set2_rbody-200 с параметрами:
"status" :: uint16_t. Содержит 200.
"result" :: struct[]. Массив. Каждый элемент содержит параметры поста архива событий.
"Name" :: char[256]. Имя.
"Guid" :: char[37]. Глобальный идентификатор.
Пример get_post-set2_rbody-200:
{
"status": 200,
"result":
[
{
"Name": "UA-03",
"Guid": "a51d1532-466f-490a-8b06-753cfef7de28",
}
]
}
Запрос параметров поста
Структура URL-запроса get-post-args определяется форматом:
GET /api/v1/post/<post-guid>
где <post-guid> :: char[37] — глобальный идентификатор поста; возможны значения согласно get_post-set_rbody-200 (см. Запрос доступных постов выше).
Пример URL-запроса:
GET /api/v1/post/a51d1532-466f-490a-8b06-753cfef7de28
Сервер, после успешной обработки запроса get-post-args, возвращает ответ с HTTP-кодом 200. Тело ответа содержит application/JSON-документ get_post-args_rbody-200 с параметрами:
"status" :: uint16_t. Содержит 200.
"result" :: struct. Параметры поста архива событий.
"Name" :: char[]. Имя поста.
"Guid" :: char[37]. Guid поста.
Пример get_post-args_rbody-200:
{
"status": 200,
"result":
{
"Name": "UA-03",
"Guid": "a51d1532-466f-490a-8b06-753cfef7de28"
}
}
Запрос доступных каналов поста
Структура URL-запроса get-post-channel-set определяется форматом:
GET /api/v1/post/<post-guid>/channel
где <post-guid> — глобальный идентификатор поста.
Если структура URL-запроса get-post-channel-set соответствует требованиям, сервер, после успешной обработки, возвращает ответ с HTTP-кодом 200. Тело ответа содержит application/JSON-документ get_post-channel-set_rbody-200 с параметрами:
"status" :: uint16_t. Содержит 200.
"result" :: int32_t[]. Массив. Каждый элемент содержит номер канала поста архива событий. Элементы массива не упорядочены.
Пример get_post-channel-set_rbody-200:
{
"status": 200,
"result": [0]
}
Структура URL-запроса get-post-channel-set2 определяется форматом:
GET /api/v1/post/<post-guid>/channel?full
где <post-guid> — глобальный идентификатор поста.
Если структура URL-запроса get-post-channel-set2 соответствует требованиям, сервер, после успешной обработки, возвращает ответ с HTTP-кодом 200. Тело ответа содержит application/JSON-документ get_post-channel-set2_rbody-200 с параметрами:
"status" :: uint16_t. Содержит 200.
"result" :: struct[]. Массив. Каждый элемент содержит параметры канала поста.
"PostGuid" :: char[37]. Глобальный идентификатор поста.
"Channel" :: int32_t. Номер канала поста.
Пример get_post-channel-set2_rbody-200:
{
"status": 200,
"result":
[
{
"PostGuid": "a51d1532-466f-490a-8b06-753cfef7de28",
"Channel": 0
}
]
}
Запрос параметров канала поста
Структура URL-запроса get-post-channel определяется форматом:
GET /api/v1/post/<post-guid>/channel/<channel-no>
где
- <post-guid> :: char[37] — глобальный идентификатор поста; возможны значения согласно get_post-set_rbody-200 (см. Запрос доступных постов выше);
- <channel-no> :: int32_t — номер канала поста; возможны значения согласно get_post-channel-set_rbody-200 (см. Запрос доступных каналов поста выше).
Если структура URL-запроса put-post-channel соответствует требованиям, сервер после успешной обработки возвращает ответ с HTTP-кодом 200. Тело ответа содержит application/JSON-документ get_post-channel_rbody-200 с параметрами:
"status" :: uint16_t. Содержит 200.
"result" :: struct. Параметры канала поста:
"PostGuid" :: char[37]. Глобальный идентификатор поста.
"Channel" :: int32_t. Номер канала поста.
Пример тела ответа:
{
"status": 200,
"result":
{
"PostGuid": "a51d1532-466f-490a-8b06-753cfef7de28",
"Channel": 0
}
}