AccessControlController

АВТОРИЗАЦИЯ - позволяет провести идентификацию, аутентификацию и выход из приложения. Для взаимодействия через API с помощью ключа, не требуется выше перечисленных действий. Для работы через API необходимо в Headers http запроса отправить key Authorization равным выданному токену. Токен можно получить на вкладке Администрирование -> раздел API, в кабинете юридического лица.

Метод Описание
GET api/LP/v3/AccessControl/Identification

Распознавание пользователя (номера телефона). При вызове данного метода отправляется СМС с кодом подтверждения на указанные номер телефона. При работе через API, не требуется вызов данного метода.

GET api/LP/v3/AccessControl/Authentication

Аутентификации пользователя. На вход принимает номер телефона и верификационный код из смс, а также Cookies c IMEI .

GET api/LP/v3/AccessControl/Logout

Выход пользователя из информационной системы. После вызова данного метода, разрушаются сессия связанная с этим токеном. Метод не требует параметров, а токен берет из Cookies или Headers http запроса http запроса из ключа Authorization.

ApplicationController

Метод Описание
GET api/LP/v3/Application/Init

Описание отсутствует.

AppointmentController

Работа с тайм слотами компании, позволяет получить свободные даты, на которые можно записаться. Позволяет получить тайм слоты по продукту, отфильтровать доступность по сотруднику и по филиалу.

Метод Описание
GET api/LP/v3/Appointment/GetAppointmentsDates

Получение дат, на которые есть записи для предоставления услугу. Данным методом можно вывести календарь и отметить даты на нем, где нужно обслуживать клиентов.

GET api/LP/v3/Appointment/GetAvailableDates

Описание отсутствует.

GET api/LP/v3/Appointment/Get

Получение детальной информации по дате, какой клиент, записался на какую услугу.

GET api/LP/v3/Appointment/Delete

Удаление записи клиента.

GET api/LP/v3/Appointment/GetAvailableParams

Описание отсутствует.

GET api/LP/v3/Appointment/GetTimeSlots

Описание отсутствует.

POST api/LP/v3/Appointment/Add

Описание отсутствует.

AdminController

Управление базовыми сущностями приложения. Получение списка компаний, добавление новой компании, удаление компании, получение списка городов, добавление или обновление города, удаление города, получить параметры для отзывов, обновить параметры для отзывов. Контроллер позволяет администрировать базовыми справочниками приложения

Метод Описание
GET api/LP/v3/Admin/GetCompanies

Вернуть список компаний

POST api/LP/v3/Admin/AddCompany

Добавить компанию

GET api/LP/v3/Admin/DeleteCompany

Удалить компании

GET api/LP/v3/Admin/UpdateCompanyOrder

Обновить значение для ручной сортировки компании

GET api/LP/v3/Admin/GetLocalities

Получить города

POST api/LP/v3/Admin/AddOrUpdateLocality

Обновить город, поменять долготу, широту и сопутствующие реквизиты

GET api/LP/v3/Admin/DeleteLocality

Удалить город

GET api/LP/v3/Admin/GetRecallParameters

Получить параметры отзыва. У отзыва настраиваемый список параметров, его можно расширять

POST api/LP/v3/Admin/UpdateRecallParameters

Переименовать параметр

POST api/LP/v3/Admin/UploadWiteList

Обновить список номеров через файл Excel, разрешенным доступ в приложение

POST api/LP/v3/Admin/UpdateWiteList

Обновить список номеров, разрешенным доступ в приложение

GET api/LP/v3/Admin/GetWhiteList

Получить список номеров, разрешенным доступ в приложение

GET api/LP/v3/Admin/DeleteWhiteListPhoneNumber

Удаление номера телефона из списка разрешенных

GET api/LP/v3/Admin/AddNewPhoneNumber

Добавление номера телефона в список разрешенных

GET api/LP/v3/Admin/GetUserFields

Получить массив полей пользователя

POST api/LP/v3/Admin/AddOrUpdateUserFields

Добавление и обновление полей пользователя

GET api/LP/v3/Admin/GetMobileAppButton

Получение настроек мобильного приложение (кнопки плюс и бокового меню)

POST api/LP/v3/Admin/SaveMobileConfig

Описание отсутствует.

GET api/LP/v3/Admin/GetPaymentTypes

Описание отсутствует.

POST api/LP/v3/Admin/UpdatePaymentTypes

Описание отсутствует.

PromoController

Метод Описание
POST api/LP/v3/Promo/AddGroup

Сохранение группы промокодов

GET api/LP/v3/Promo/GetGroups

Описание отсутствует.

GET api/LP/v3/Promo/GetCodes

Описание отсутствует.

GET api/LP/v3/Promo/GetParticipants

Описание отсутствует.

StatementController

Работа с заявками

Метод Описание
GET api/LP/v3/Statement/GetTypes

Описание отсутствует.

GET api/LP/v3/Statement/GetType/{id}

Описание отсутствует.

POST api/LP/v3/Statement/AddType

Описание отсутствует.

POST api/LP/v3/Statement/UpdateType

Описание отсутствует.

GET api/LP/v3/Statement/DeleteType/{id}

Описание отсутствует.

GET api/LP/v3/Statement/GetStatuses

Описание отсутствует.

GET api/LP/v3/Statement/GetFields

Описание отсутствует.

GET api/LP/v3/Statement/Get

Описание отсутствует.

GET api/LP/v3/Statement/GetById/{id}

Описание отсутствует.

POST api/LP/v3/Statement/Add

Описание отсутствует.

POST api/LP/v3/Statement/Update

Описание отсутствует.

GET api/LP/v3/Statement/UpdateEmployee/{id}

Описание отсутствует.

IOController

Метод Описание
GET api/LP/v3/IO/Get/{id}

Описание отсутствует.

KeyController

Метод Описание
GET api/LP/v3/Key/Add

Описание отсутствует.

GET api/LP/v3/Key/Get

Описание отсутствует.

GET api/LP/v3/Key/Delete

Описание отсутствует.

PollController

Метод Описание
GET api/LP/v3/Poll/Get

Получить список опросов

POST api/LP/v3/Poll/Add

Добавить новый опрос

POST api/LP/v3/Poll/Update

Обновить опрос

GET api/LP/v3/Poll/Delete

Удаление опроса

GET api/LP/v3/Poll/ListedOptionRating

Метод который возвращает пользователей, которые прошли опрос

ActionController

Метод Описание
GET api/LP/v3/Action/Get

Получить список акций

POST api/LP/v3/Action/Add

Добавить новую акцию

POST api/LP/v3/Action/Update

Обновить акцию

GET api/LP/v3/Action/Delete

Удалить безвозвратно существующую акцию

GET api/LP/v3/Action/UpdateUsedAction

Запустить процесс обновления привязки акции с пользователями в зависимости от типа внешней системы.

GET api/LP/v3/Action/GetActionParticipants

Описание отсутствует.

AttachmentController

Контроллер для загрузки файлов на сервер.

Метод Описание
POST api/LP/v3/Attachment/UploadImage

Загрузка файла на сервер и получение результата в виде строки(Применятся для загрузки аватара, когда не нужен результат объекта). Формат запроса должен MIME

POST api/LP/v3/Attachment/UploadAttachment

Загрузка фала на сервер, формат запроса должен MIME

BranchController

Управление филиалами компании - получение филиалов, получение детальной информации, получение параметров доставки, получение информации о шлюзах оплаты, добавление нового филала, обновление филиала, удаление филиала

Метод Описание
GET api/LP/v3/Branch/Get

Получить список доступных филиалов

GET api/LP/v3/Branch/Get/{id}

Получить детальную информацию по филиалу

GET api/LP/v3/Branch/GetDeliveryParams

Получить параметры доставки

GET api/LP/v3/Branch/GetPaymentGateways

Получить список платеженых шлюзов

POST api/LP/v3/Branch/Add

Добавить новый филиал

POST api/LP/v3/Branch/Update

Обновить существующий филиал

GET api/LP/v3/Branch/Delete

Удалить существующий филиал

CallbackController

Работа с функциональностью Call-Back. Получить call-back, обновить, взять на себя и обработать.

Метод Описание
GET api/LP/v3/Callback/Get

Получить список call-back

POST api/LP/v3/Callback/Update

Обновить Call-Back

GET api/LP/v3/Callback/TakeOver

Взять call-back на себя (в обработку)

CatalogController

Работа с каталогом компании: управление структурой, управление товарами

Метод Описание
GET api/LP/v3/Catalog/GetCatalog

Получить каталог товаров / услуг

GET api/LP/v3/Catalog/GetCatalogs

Получить все каталоги

POST api/LP/v3/Catalog/AddCatalog

Добавить новый каталог

POST api/LP/v3/Catalog/UpdateCatalog

Обновить каталог

GET api/LP/v3/Catalog/DeleteCatalog

Удалить каталог

POST api/LP/v3/Catalog/UpdateCatalogContents

Обновить сотав продуктов в каталоге

GET api/LP/v3/Catalog/GetProduct

Получить продукт

GET api/LP/v3/Catalog/GetProducts

Получить продукты каталога

GET api/LP/v3/Catalog/GetProducts

Получить продукты каталога, с возможностью применения фильтра по продукт / услуга и возможностью установить фильтр сотруднику, котрый обслуживает

POST api/LP/v3/Catalog/AddProduct

Добавить новый продукт

POST api/LP/v3/Catalog/UpdateProduct

Обновить продукт

GET api/LP/v3/Catalog/DeleteProduct

Удалить продукт

GET api/LP/v3/Catalog/GetGroupProps

Описание отсутствует.

POST api/LP/v3/Catalog/AddPropsGroup

Описание отсутствует.

POST api/LP/v3/Catalog/UpdatePropsGroup

Описание отсутствует.

GET api/LP/v3/Catalog/DeletePropsGroup

Описание отсутствует.

CheckInController

Работа с позиционированием клиента в филиале или компании - оставить информацию о клиенте, где он был

Метод Описание
GET api/LP/v3/CheckIn/Get

Получить список Check-in

GET api/LP/v3/CheckIn/TakeOver

Обработать Check-In

ClientController

Работа с клиентами

Метод Описание
GET api/LP/v3/Client/Get

Получить список клиентов

GET api/LP/v3/Client/Info

Получить информацию о клиенте

POST api/LP/v3/Client/UpdateInfo

Обновить анкету клиента

GET api/LP/v3/Client/GetBonusCard

Получить бонусную карту

GET api/LP/v3/Client/SetDiscount

Установить скидку клиенту

GET api/LP/v3/Client/UpdateBalance

Обновить баланс клиента

GET api/LP/v3/Client/SetBalance

Установить баланс клиента

GET api/LP/v3/Client/GetGroups

Получить список групп

POST api/LP/v3/Client/AddGroup

Добавить группу

POST api/LP/v3/Client/UpdateGroup

Обновить группу

GET api/LP/v3/Client/DeleteGroup

Удалить группу

GET api/LP/v3/Client/AddGroupMember

Добавление клиентов в группу

GET api/LP/v3/Client/DeleteGroupMember

Удалить участника группы

GET api/LP/v3/Client/GetActions

Получить акции группы

GET api/LP/v3/Client/DownloadGroupMembers

Описание отсутствует.

GET api/LP/v3/Client/AttachAction

Прикрепить акцию к группе

GET api/LP/v3/Client/DetachAction

Снять акцию с группы

POST api/LP/v3/Client/WriteGroup

Написать группе

POST api/LP/v3/Client/WriteUser

Написать пользователю

GET api/LP/v3/Client/GetMessages

Получить сообщения отправленные группе

GET api/LP/v3/Client/RecountNumberParticipants

Запустить пересчет участников в группах

POST api/LP/v3/Client/AddHistoryActivity

Добавление события в историю взаимодействия с клиентом

GET api/LP/v3/Client/RequestToRecall

Отправить запрос на отзыв группе

ConversationController

Работа с сообщениями

Метод Описание
POST api/LP/v3/Conversation/Add

Описание отсутствует.

GET api/LP/v3/Conversation/Get

Получить беседу

GET api/LP/v3/Conversation/Get

Получить список бесед

GET api/LP/v3/Conversation/GetParticipants

Получить сотрудников, которые являются участниками беседы

POST api/LP/v3/Conversation/SendMessage

Отправить сообщение

GET api/LP/v3/Conversation/GetMessages

Получить сообщение

GET api/LP/v3/Conversation/AddEmployee

Добавить сотрудника в беседу

GET api/LP/v3/Conversation/Leave

Выйти из безеседы

GET api/LP/v3/Conversation/RequestToRate

Запрос отзыва об беседе

GET api/LP/v3/Conversation/RequestToRecall

Запрос отзыва об беседе

GET api/LP/v3/Conversation/NotificationReadMessage

Установка прочитанных сообщений

EmployeeController

Работа с сотрудниками

Метод Описание
GET api/LP/v3/Employee/Get

Получить сотрудника

POST api/LP/v3/Employee/Add

Добавить сотрудника

GET api/LP/v3/Employee/Delete

Удалить сотрудника

POST api/LP/v3/Employee/Update

Обновить сотрудника

GET api/LP/v3/Employee/Search

Поиск сотрудника

NewsController

Работа с новостями

Метод Описание
GET api/LP/v3/News/Get

Получить список новостей

POST api/LP/v3/News/Add

Добавление новости

POST api/LP/v3/News/Update

Обновление новости

GET api/LP/v3/News/Delete

Удаление новости

GET api/LP/v3/News/Publish

Опубликовать новость (Вконтакте, инстаграм и т д)

GET api/LP/v3/News/ListedCompanyNewsRating

Получить клиентов, которые проставили рейтинг новости

OrderController

Работа с заказами

Метод Описание
GET api/LP/v3/Order/Get

Получить заказа

GET api/LP/v3/Order/Get

Получить список заказов

POST api/LP/v3/Order/Update

Обновление заказа

POST api/LP/v3/Order/Add

Добавление нового заказа

RecallController

Работа с отзывами

Метод Описание
GET api/LP/v3/Recall/Get

Получить список отзывов

POST api/LP/v3/Recall/Update

Обновить отзыв

GET api/LP/v3/Recall/GetRecallParameter

Получить параметры отзывов

POST api/LP/v3/Recall/UpdateRecallParameter

Обновить параметры отзывов

RoleController

Работа с ролями в компании

Метод Описание
GET api/LP/v3/Role/Get

Получить список ролей

POST api/LP/v3/Role/Add

Добавить новую роль

GET api/LP/v3/Role/Delete

Удалить роль

POST api/LP/v3/Role/Update

Обновить роль

GET api/LP/v3/Role/ExcludeEmployee

Включить сотруднику роль

StatisticsController

Работа со статистикой компании - универсальный механизм получения статистических данных. Вся бизнес логика, которая предоставляет отчеты пишется на уровне функций базы данных на языке pl/pgsql. Данный контроллел универсальный, для вызова функции и предназначен для построение графиков. Все ответы универсальны.

Метод Описание
GET api/LP/v3/Statistics/GetReports

Получить список всех доступных отчетов

GET api/LP/v3/Statistics/GetReport

Получить результат отчета

SupportController

Работа со справочниками. Контроллел позволяет получить вспомагательные справочники для работы приложения. В основном используется для работы WEB приложения написанного на Angular

Метод Описание
GET api/LP/v3/Support/GetListSections

Получить роли

GET api/LP/v3/Support/GetCompanyCategories

Получить категории компании

GET api/LP/v3/Support/GetContactTypes

Получить типы контактов

GET api/LP/v3/Support/GetCurrency

Получить список валют

GET api/LP/v3/Support/GetUnitMeasurements

Получить единицы измерения

GET api/LP/v3/Support/GetFilterColumns

Получить сптсок колонок для фильтра

GET api/LP/v3/Support/SearchLocality

Получить список локаций

GET api/LP/v3/Support/GetBonusCardOperationType

Получить типы операций по бонусной карте

GET api/LP/v3/Support/GetCallbackStatuses

Получить статусы Call-Back

GET api/LP/v3/Support/GetOrderStatuses

Получить статусы заказа

GET api/LP/v3/Support/UploadImageToVK

Обновить логотип группы Вконтакте

GET api/LP/v3/Support/GetColumnTypes

Получить список типов колонок

GET api/LP/v3/Support/GetAvailablePaymentTypes

Получить список типов оплаты

GET api/LP/v3/Support/GetAvailableDeliveryTypes

Получить доступные способы доставки

GET api/LP/v3/Support/GetRecallType

Описание отсутствует.

UserController

Работа с сотрудниками системы

Метод Описание
GET api/LP/v3/User/GetCompany

Получить список компаний доступных пользователю

GET api/LP/v3/User/Info

Получить информацию об пользователе

POST api/LP/v3/User/Update

Обновить сотрудника

GET api/LP/v3/User/DetachOAuth

Отвязать внешнуюю авторизацию пользователя

GET api/LP/v3/User/CurrentCompany

Получить текущую компанию