Запрос доступных постов

Структура url-запроса get-post-set определяется форматом:

GET /api/v1/post

Если структура url-запроса get-post-set соответствует требованиям, сервер, после успешной обработки запроса, возвращает ответ с http-кодом 200. Тело ответа содержит application/json-документ get_post-set_rbody-200 с параметрами:

1. "status" :: uint16_t. Содержит 200.

2. "result" :: char[][37]. Массив. Каждый элемент содержит глобальный идентификатор поста.

Пример тела ответа: get_post-set_rbody-200:

{
 "status": 200,
 "result":
 [
   "a51d1532-466f-490a-8b06-753cfef7de28"
 ]
}

Структура url-запроса get_post-set2 определяется форматом:

GET /api/v1/post?full

Сервер, после успешной обработки запроса get_post-set2, возвращает ответ с http-кодом 200. Тело ответа содержит application/json-документ get_post-set2_rbody-200 с параметрами:

1. "status" :: uint16_t. Содержит 200.

2. "result" :: struct[]. Массив. Каждый элемент содержит параметры поста архива событий.

1. "Name" :: char[256]. Имя.

2. "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

1. "status" <uint16:: uint16_t>t. Содержит 200.

2. "result" <struct>:: struct. Параметры поста архива событий.

   1. "

Guid

3. 1. Name"

<char

4. 1. :: char[

37

5. 1. ]

>

6. 1. .

Guid

7. 1.  Имя поста.
      

   2. "

Name

8. 1. Guid"

<char

9. 1. :: char[37]

>

10. 1. .

Имя

11. 1. 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> — guid — глобальный идентификатор поста.

Если структура url-запроса get-post-channel-set соответствует требованиям, сервер, после успешной обработки, возвращает ответ с http-кодом 200. Тело ответа содержит application/json-документ get_post-channel-set_rbody-200 с параметрами:

1. "status" <uint16:: uint16_t>t. Содержит 200.

2. "result" <uint32:: uint32_t[]>. Массив. Каждый элемент содержит номер канала поста архива событий. Элементы массива не упорядочены.

Пример тела ответа get_post-channel-set_rbody-200:

{
 "status": 200,
 "result": [0]
}

Структура url-запроса get-post-channel-set2 определяется форматом:

GET /api/v1/post/<post-guid>/channel?full

1. "status" <uint16:: uint16_t>t. Содержит 200.

2. "result" <struct:: struct[]>. Массив. Каждый элемент содержит параметры канала поста.

1. "PostGuid" <char:: char[37]>. Guid  Глобальный идентификатор поста.

2. "Channel" <uint32:: uint32_t>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> — guid поста;:: char[37] — глобальный идентификатор поста. Возможны значения согласно get_post-set_rbody-200 (см. Запрос доступных постов выше). <channel-no> — номер :: int32_t — номер канала поста. Возможны значения в интервале [0; 2147483647].

Возможные значения согласно get_post-channel-set_rbody-200 (см. Запрос доступных каналов поста выше).

Если структура url-запроса put-post-channel соответствует требованиям, сервер после успешной обработки возвращает ответ с http-кодом 200. Тело ответа содержит application/json-документ get_post-channel_rbody-200 с параметрами:

1. "status" <uint16:: uint16_t>t. Содержит 200.

2. "result" <struct>:: struct. Параметры канала поста:

1. "PostGuid" <char:: char[37]>. Guid  Глобальный идентификатор поста.

2. "Channel" <uint32:: uint32_t>t. Номер канала поста.

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

{
  "status": 200,
  "result":
  {
    "PostGuid": "a51d1532-466f-490a-8b06-753cfef7de28",
    "Channel": 0
  }
}