Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

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

Структура url

get_post-set

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

Code Block
GET /api/v1/post

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

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

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

Пример get_post-set_rbody-200:

Code Block
{
 "status": 200,
 "result":
 [
]>

   "a51d1532-466f-490a-8b06-753cfef7de28"
 ]
}

get_post-set2

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

Code Block
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[]. Массив. Каждый элемент содержит guid параметры поста архива событий.

Пример тела ответа
    1. "Name" :: char[256]. Имя.

    2. "Guid" :: char[37]. Глобальный идентификатор.

Пример get_post-set2_rbody-200:


Code Block
{
 "status": 200,
 "result":
 [
   {
     "Name": "UA-03",
     "Guid": "a51d1532-466f-490a-8b06-753cfef7de28",
   }
 ]
}

Запрос параметров поста (get_post-args)

Структура urlURL-запроса get-_post-args определяется форматом:

Code Block
GET /api/v1/post/<post-guid>

где <post-guid>  — guid поста.Пример url:: char[37] — глобальный идентификатор поста; возможны значения согласно get_post-set_rbody-200 (см. Запрос доступных постов выше).

Пример URL-запроса:


Code Block
GET /api/v1/post/a51d1532-466f-490a-8b06-753cfef7de28

Сервер, после успешной обработки запроса get-_post-args, возвращает ответ с httpHTTP-кодом 200. Тело ответа содержит application/jsonJSON-документ get_post-args_rbody-200 с параметрами:

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

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

    1. "

  3. Guid
    1. Name"

  4. <char
    1. :: char[

  5. 37
    1. 256]

  6. >
    1. .

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

    2. "

  8. Name
    1. Guid"

  9. <char
    1. :: char[37]

  10. >
    1. .

  11. Имя
    1.  Глобальный идентификатор поста.

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

Code Block
{
  "status": 200,
  "result":
  {
    "Name": "UA-03",
    "Guid": "a51d1532-466f-490a-8b06-753cfef7de28"
  }
}

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

Структура url

get_post-channel-set

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

Code Block
GET /api/v1/post/<post-guid>/channel

где <post-guid> — guid — глобальный идентификатор поста.

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

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

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

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

Code Block
{
 "status": 200,
 "result": [0]
}
Структура url

get_post-channel-set2

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


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

где <post-guid>  guid  глобальный идентификатор поста.


Если структура url URL-запроса get-_post-channel-set2 соответствует требованиям, сервер, после успешной обработки, возвращает ответ с httpHTTP-кодом 200. Тело ответа содержит application/jsonJSON-документ с get_post-channel-set2_rbody-200 с параметрами:
  1. "status" <uint16:: uint16_t>t. Содержит 200.

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

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

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

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

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

Запрос параметров канала поста (get_post-channel)

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

Code Block
GET /api/v1/post/<post-guid>/channel/<channel-no>

где

  • <post-guid>
 guid поста; <channel-no>  номер канала поста. Возможны значения в интервале [0; 2147483647].
Пример url-запроса:
Code Block
GET /api/v1/post/a51d1532-466f-490a-8b06-753cfef7de28/channel/0
Если структура url
  • :: char[37]  глобальный идентификатор поста; возможны значения согласно get_post-set_rbody-200 (см. Запрос доступных постов выше);
  • <channel-no> :: int32_t — номер канала поста; возможны значения согласно get_post-channel-set_rbody-200 (см. Запрос доступных каналов поста выше).

Если структура URL-запроса put-post-channel соответствует требованиям, сервер после успешной обработки возвращает ответ с

http

HTTP-кодом 200. Тело ответа содержит application/

json

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:: int32_t>t. Номер канала поста.

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

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