Versions Compared

Old Version 4

changes.mady.by.user Inna Kabanova (Unlicensed)

Saved on

compared with

New Version 5

changes.mady.by.user Inna Kabanova (Unlicensed)

Saved on

Key

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

Table of Contents

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

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

Code Block
GET /api/v1/post

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

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

  2. "result" <char[37][]>. Массив. Каждый элемент содержит guid поста архива событий.

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

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

Запрос параметров поста

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

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

где <post-guid> — guid поста.

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


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

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

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

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

    1. "Guid" <char[37]>. Guid поста.

    2. "Name" <char[]>. Имя поста.

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

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

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

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

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

где <post-guid> — guid поста.

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

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

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

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

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

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


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

где <post-guid> — guid поста.


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

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

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

    1. "PostGuid" <char[37]>. Guid поста.

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

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

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

Запрос параметров канала поста

Структура url-запроса 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-запроса put-post-channel соответствует требованиям, сервер после успешной обработки возвращает ответ с http-кодом 200. Тело ответа содержит application/json-документ с параметрами:

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

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

    1. "PostGuid" <char[37]>. Guid поста.

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

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

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