API центра идей

Версия API	1.0.0.1

Содержание

SOAP-сервис центра идей (UsersIdeas_1_0_0_1)

Сервис предназначен для работы центра идей приложений. Основная функциональность:

Получение списка идей с отборами
Добавление идей
Комментирование идей

Операция addIdea

Добавление новой идей.
Возвращаемое значение: boolean

Параметр	Тип	Описание
UserId	string	Идентификатор пользователя
HTMLText	string	Описание идеи в формате HTML
Attachments	AttachmentList	Вложения (кантинки к тексту HTML)
Subject	string	Имя предмета
Name	string	Наименование

▲ в начало

Операция addIdeaComment

Добавление комментария к идее.
Возвращаемое значение: boolean

Параметр	Тип	Описание
IdeaId	string	Идентификатор идеи
UserId	string	Идентификатор пользователя сервиса
CommentId	string	Идентификатор основного комментария (если текущий - это ответ)
Text	string	Текст комментария

▲ в начало

Операция addVote

Добавление голоса к идее.
Возвращаемое значение: boolean

Параметр	Тип	Описание
IdeaId	string	Идентификатор идеи
UserId	string	Идентификатор пользователя
Vote	int	Голос (1 - положительный, -1 - отрицательный)

▲ в начало

Операция deleteIdeaComment

Удаление комментария идеи.
Возвращаемое значение: boolean

Параметр	Тип	Описание
CommentId	string	Идентификатор комментария

▲ в начало

Операция getIdea

Получение идеи.
Возвращаемое значение: IdeaPresentation

Параметр	Тип	Описание
Id	string	Идентификатор идеи
UserId	string	Идентификатор пользователя
PageCommentNumber	int	Номер страницы комментариев
CountCommentsOnPage	int	Количество комментариев на страницу

▲ в начало

Операция getIdeas

Получение списка идей.
Возвращаемое значение: IdeaListPresentation

Параметр	Тип	Описание
StatusFilter	StatusFilter	Фильтр по состоянию
SubjectsFilter	SubjectFilterArray	Фильтр по предмету
Sort	SortType	Тип сортировки
PageNumber	int	Номер страницы
UserId	string	Идентификатор пользователя
CountIdeasOnPage	int	Количество идей на странице

▲ в начало

Операция searchIdeas

Поиск идей.
Возвращаемое значение: IdeaListPresentation

Параметр	Тип	Описание
Request	string	Поисковый запрос
StatusFilter	StatusFilter	Фильтр по состоянию
SubjectsFilter	SubjectFilterArray	Фильтр по предмету
Sort	SortType	Тип сортировки
PageNumber	int	Номер страницы
UserId	string	Идентификатор пользователя
CountIdeasOnPage	int	Количество идей на странице

▲ в начало

Классы параметов операций

Простые классы

Класс StatusFilter

Описывает перечисление состояний идей.

Значения перечисления:

plan – Запланированые
voiting – На голосовании
deviation – Отклоненные
realization – Реализованные
favorites – Избранные

▲ в начало

Класс SortType

Описывает перечисление типа сортировки.

Значения перечисления:

PlanMadeDate – Плановая дата реализации (только для запланированных к реализации)
CreateDate – Дата создания (только для идей на голосовании)
ClosingDate – Дата закрытия (отклоненные, реализованные)
CommentsCount – Количество комментариев (только для идей на голосовании)
Rating – Сумма голосов (только для идей на голосовании)
ChangingDate – Измененные идеи (только для избранных идей. Не используется)

▲ в начало

Отборы

Класс StatusFilterArray

Массив фильтров по состояниям идей.
Используется при получении списка идей операциями getIdeas и searchIdeas.

Свойство	Тип	Список	Описание
StatusFilterElement	StatusFilter	Да	Список статусов

▲ в начало

Класс SubjectFilterArray

Массив фильтров по предметам (разделам центра идей).
Используется при получении списка идей операциями getIdeas и searchIdeas

Свойство	Тип	Список	Описание
SubjectFilterElement	string	Да	Элемент филтра предметов (строка представления)

▲ в начало

Идеи

Класс IdeaListPresentation

Описывает представление списка идей

Свойство	Тип	Обязательное	Список	Описание
IdeasCount	int	Да		Количество идей
IdeasList	Idea		Да	Список идей
SubjectsList	string		Да	Список разделов

▲ в начало

Класс IdeaPresentation

Описывает представление идеи вместе с комментариями.

Свойство	Тип	Обязательное	Список	Описание
CommentsList	IdeaComment		Да	Список комментариев
Idea	Idea	Да		Идея
IdeaCommentsCount	int	Да		Количество комментариев

▲ в начало

Класс Idea

Описывает идею.

Свойство	Тип	Обязательное	Список	Описание
Attachments	Attachment		Да	Картинки описания
ClosingDate	dateTime	Да		Дата закрытия
CommentsCount	int	Да		Количество комментариев
CreateDate	dateTime	Да		Дата создания
DeveloperComment	string	Да		Комментарий разработчика о причинах отклонения
HTMLText	string	Да		Описание идеи в формате HTML
Id	string	Да		Идентификатор идеи
Name	string	Да		Наименование
NegativeVotesSum	int	Да		Количество отрицательных голосов
PlanMadeDate	dateTime	Да		Плановая дата реализации
PlanMadeDatePresentation	string	Да		Представление плановой даты реализации
PositiveVotesSum	int	Да		Количество положительных голосов
Rating	int	Да		Сумма голосов за идею (положительные минус отрицательные)
Status	string	Да		Состояние
Subject	string	Да		Раздел
Text	string	Да		Описание идеи
UserId	string	Да		Идентификатор пользователя
UserName	string	Да		Имя пользователя
Vote	int	Да		Голос текущего пользователя

▲ в начало

Вложения

Класс AttachmentList

Описывает список картинок к описанию идеи

Свойство	Тип	Список	Описание
AttachmentElement	Attachment	Да	Список вложений (картинок)

▲ в начало

Класс Attachment

Описывает картинку

Свойство	Тип	Обязательное	Описание
Data	base64Binary	Да	Данные картинки
Name	string	Да	Наименование картинки

▲ в начало

Комментарии к идеям

Класс IdeaComment

Описывает комментарий к идее.

Свойство	Тип	Обязательное	Описание
Date	dateTime	Да	Дата добавления
Id	string	Да	Идентификатор комментария
IsSupport	boolean	Да	Признак, что это комментарий службы поддержки
MainIdeaComment	IdeaComment	Да	Основной комментарий
Text	string	Да	Текст комментария
UserId	string	Да	Идентификатор пользователя
UserName	string	Да	Имя пользователя

▲ в начало