Contact

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

APIОписание
GET api/v2/contact/{searchString}/find

Получение по поисковой строке списка контактов для отправки

DraftGroup

Управление группами черновиков

APIОписание
GET api/v2/draftgroup?StartIndex={StartIndex}&Count={Count}&Contractor={Contractor}&ContractorId={ContractorId}&DepartmentId={DepartmentId}&Department={Department}&StartCreateDate={StartCreateDate}&EndCreateDate={EndCreateDate}&Title={Title}&Search={Search}&ContractorInn={ContractorInn}&IsImportant={IsImportant}

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

GET api/v2/draftgroup/{draftGroupId}

Получение группы черновиков

POST api/v2/draftgroup

Создание группы черновиков

PUT api/v2/draftgroup/{draftGroupId}

Обновление группы черновиков

DELETE api/v2/draftgroup/{draftGroupId}

Удаление группы черновиков

PUT api/v2/draftgroup/{draftGroupId}/send

Отправка черновика

GET api/v2/draftgroup/autosave

Получение автосохраненной группы документов

File

Управление группами документами

APIОписание
GET api/v2/file/{fileId}

Получить содержимое файла

GET api/v2/file/shelf/{shelfId}

Получить содержимое файла

GET api/v2/file/draft/{draftId}

Получить содержимое файла

GET api/v2/file/SignerCertificate/{fileId}

Получить содержимое файла

POST api/v2/file/shelf

Загрузить содержимое файла

Auth

Контроллер авторизации

APIОписание
GET api/v2/auth/secret

Получение уникальной строки для авторизации по сертификату

POST api/v2/auth

Авторизация по логину и паролю

POST api/v2/auth/cert

Авторизация по сертификату

POST api/v2/auth/detachedsignature

Авторизация по отсоединённой подписи

POST api/v2/auth/recovery

Запросить восстановление паролья

POST api/v2/auth/changePassword

Сменить забытый пароль по токену

GET api/v2/auth/recovery/{token}

Проверка токена восстановления пароля

PUT api/v2/auth/setactiveorganization

Выбор активной организации при авторизации с несколькими организациями

FeedBackWithoutAuth

Контроллер обратной связи без авторизации

APIОписание
POST api/v2/feedbackwithoutauth/Landing

Отправка письма с лендинга сайта

ExtendedDocuments

Расширенный поиск

APIОписание
GET api/v2/extendedDocument?SearchString={SearchString}&StartIndex={StartIndex}&Count={Count}&ContractorFilter={ContractorFilter}&DepartmentName={DepartmentName}&SentTimeFrom={SentTimeFrom}&SentTimeTo={SentTimeTo}&ReceivedTimeFrom={ReceivedTimeFrom}&ReceivedTimeTo={ReceivedTimeTo}&UpdateTimeFrom={UpdateTimeFrom}&UpdateTimeTo={UpdateTimeTo}&Status={Status}&IsImportant={IsImportant}&Inn={Inn}&Kpp={Kpp}&SenderName={SenderName}&ReceiverName={ReceiverName}&OriginSection={OriginSection}&DocumentType={DocumentType}

Список групп документов

Profile

Управление сотрудниками

APIОписание
GET api/v2/profile/employee

Получение данных о сотруднике

PUT api/v2/profile/employee

Получение данных о сотруднике

PUT api/v2/profile/avatar

Сохранить аватар

PUT api/v2/profile/setdefaultavatar

Установить аватар по умолчанию

GET api/v2/profile/getnotificationsettings

Получить настройки генерации уведомлений

PUT api/v2/profile/savenotificationsettings

Сохранить настройки генерации уведомлений

GET api/v2/profile/{email}/isemailexists

проверить, не занят ли email

GET api/v2/profile/employee/certificate?State={State}

Получение списка сертификатов сотрудника

GET api/v2/profile/employee/certificate/{thumbprint}

Скачать сертификат сотрудника

Dss

АПИ для работы с облачной подписью

APIОписание
GET api/v2/dss/{thumbprint}/auth

Начало работы с сертификатом DSS

POST api/v2/dss/confirm

Отправка кода подтверждения для облачного сертификата

GET api/v2/dss/{thumbprint}/check

Проверить активна ли сессия для облачного сертификата

GET api/v2/dss/{thumbprint}/code

Получить код подтверждения на СМС

POST api/v2/dss/close

Закрыть соединение с облачной подписью

POST api/v2/dss/sign

Подпись файла облачным сертификатом

FeedBack

Контроллер отзывов

APIОписание
POST api/v2/feedback/beta

Отправка отзыва по beta-версии

GET api/v2/feedback/feedbackexists

Проверка был ли отзыв

Draft

Управление черновиками

APIОписание
GET api/v2/draft/{draftId}

Получение группы черновиков

POST api/v2/draft

Создание группы черновиков

PUT api/v2/draft/{draftId}

Обновление черновика

DELETE api/v2/draft/{draftId}

Удаление черновика

GET api/v2/draft/{draftId}/prepareforsend

Подготовка черновика к отправке

GET api/v2/draft/{draftId}/printform

Получение печатной формы черновика

POST api/v2/draft/{draftId}/important

Установка признака важности

Notifications

контроллер для работы с уведомлениями

APIОписание
GET api/v2/notification/countofnew

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

GET api/v2/notification/list?startIndex={startIndex}&count={count}

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

POST api/v2/notification/setnewasread

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

DocumentGroups

Управление группами документов

APIОписание
GET api/v2/documentGroups?DeletedFilter={DeletedFilter}&Direction={Direction}&StartIndex={StartIndex}&Count={Count}&Contractor={Contractor}&ContractorId={ContractorId}&Department={Department}&DepartmentId={DepartmentId}&EndSentDate={EndSentDate}&StartSentDate={StartSentDate}&Title={Title}&Search={Search}&State={State}&ContractorInn={ContractorInn}&StartReceiveDate={StartReceiveDate}&EndReceiveDate={EndReceiveDate}&IsImportant={IsImportant}

Список групп документов

GET api/v2/documentGroups/{groupId}

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

BudgetIntegration

Для интеграции с Барс-бюджет

APIОписание
GET api/v2/BudgetIntegration/GetInvoice/{guid}

Document

Управление документами

APIОписание
GET api/v2/document/{documentId}

Получить документ

GET api/v2/document/{documentId}/docflow

Получить документооборот

GET api/v2/document/{documentId}/docflow/report?responseType={responseType}

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

GET api/v2/document/docflow/transactionFiles/{transactionId}

Получить список файлов в транзакции

DELETE api/v2/document/{documentId}

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

PUT api/v2/document/{documentId}/restore

Восстановить документ

GET api/v2/document/{documentId}/printformpdf

Печатная форма в pdf

GET api/v2/document/response

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

GET api/v2/document/{documentId}/transactionsForResponse

Получение файлов извещений о получении

GET api/v2/document/{documentId}/transactionsForResponse/{thumbprint}

Получение файлов извещений о получении

POST api/v2/document/{documentId}/response

Отправка подписанного извещения о получении

GET api/v2/document/{documentId}/generateAcceptance

Формирование квитанции о приеме, которую нужно отправить для принятия документа

GET api/v2/document/{documentId}/generateAcceptance/{thumbprint}

Формирование квитанции о приеме, которую нужно отправить для принятия документа

POST api/v2/document/{documentId}/generateAcceptancewithprocuration

Формирование квитанции о приеме, которую нужно отправить для принятия документа

POST api/v2/document/{documentId}/generateAcceptancewithprocuration/{thumbprint}

Формирование квитанции о приеме, которую нужно отправить для принятия документа

POST api/v2/document/{documentId}/generateAcceptancewithauthority

Формирование квитанции о приеме, которую нужно отправить для принятия документа

POST api/v2/document/{documentId}/generateAcceptancewithauthority/{thumbprint}

Формирование квитанции о приеме, которую нужно отправить для принятия документа

POST api/v2/document/{documentId}/accept

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

POST api/v2/document/{documentId}/reject

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

GET api/v2/document/{documentId}/generateReject?description={description}

Формирование уведомления отказе, которое нужно отправить для принятия документа

GET api/v2/document/{documentId}/generateReject/{thumbprint}?description={description}

Формирование уведомления отказе, которое нужно отправить для принятия документа

POST api/v2/document/{documentId}/important

Установка признака важности