Голосования (votings)

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/uc/selectors/<id>/votings

Создание нового голосования

GET

/rest/v1/uc/selectors/<id>/votings

Получение списка голосований

GET

/rest/v1/uc/selectors/<id>/votings/<id_vot>

Получение данных голосования

PATCH

/rest/v1/uc/selectors/<id>/votings/<id_vot>

Изменение данных голосования

DELETE

/rest/v1/uc/selectors/<id>/votings/<id_vot>

Удаление голосования


Создание нового голосования

Запрос

Описание полей: selector’s voting entity

Пример запроса
POST /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/votings HTTP/1.1
Content-Type: application/json; charset=utf-8

selector’s voting entity

Ответ

Описание полей: selector’s voting entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "7f50172f-016d-6263-9795-50e54938780c",
  "name": "Голосование 1",
  "subject": "Вопрос о назначении даты для проведения стратегической сессии: 12.10.2019",
  "cases": {
    "0": "Против",
    "1": "За",
    "2": "Воздерживаюсь"
  }
}

Получение списка голосований

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода. Доступные поля для выдачи: id, name, result, state,.

offset

int

Смещение в списке ресурсов, подлежащих выдаче.

limit

int

Максимальное количество ресурсов в списке.

order

array<object|str>

Порядок сортировки ресурсов в списке.

flat

bool

Преобразование в плоский вид составных полей.

Пример запроса
GET /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/votings?mask=id,state HTTP/1.1

Ответ

Описание полей: selector’s voting entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "7f50172f-016d-6263-9795-50e54938780c",
    "name": "Голосование 1",
    "subject": "Вопрос о назначении даты для проведения стратегической сессии: 12.10.2019",
    "state": "inited"
  },
  {
    "id": "a6247b8e-016d-6263-2fbc-50e54938780c",
    "name": "Голосование 2",
    "subject": "Вопрос о выборе новой системы",
    "state": "inited"
  }
]

Получение данных голосования

Запрос

Table 2. Параметры запроса
Имя Тип Описание

mask

str

Список полей для вывода.

flat

bool

Преобразование в плоский вид составных полей.

Пример запроса
GET /rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/votings/a6247b8e-016d-6263-2fbc-50e54938780c HTTP/1.1

Ответ

Описание полей: selector’s voting entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "7f50172f-016d-6263-9795-50e54938780c",
  "name": "Голосование 1",
  "subject": "Вопрос о назначении даты для проведения стратегической сессии: 12.10.2019",
  "state": "closed",
  "cases": {
    "0": "Против",
    "1": "За",
    "2": "Воздерживаюсь"
  },
  "results": {
    "83d41cb6-016d-5d75-6341-50e54938780c": "2",
    "83d41cb6-016d-5d75-6341-50e54938780c": "2"
  }
}

Изменение данных голосования

Поля запрещенные для изменения: id

Запрос

Описание полей: selector’s voting entity

Пример запроса
PATCH rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/votings/a6247b8e-016d-6263-2fbc-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

selector’s voting entity

Ответ

Описание полей: selector’s voting entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "7f50172f-016d-6263-9795-50e54938780c",
  "name": "Голосование 1",
  "subject": "Вопрос о назначении даты для проведения стратегической сессии: 12.10.2019",
  "state": "inited",
  "cases": {
    "0": "Против",
    "1": "За",
    "2": "Воздерживаюсь"
  },
  "results": {}
}

Удаление голосования

Запрос

Пример запроса
DELETE rest/v1/uc/selectors/2c51f8a2-016d-5d72-d44a-50e54938780c/votings/a6247b8e-016d-6263-2fbc-50e54938780c HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

Связанные композитные ресурсы