Справка по API

Описание методов API

Statement

контроллер обработки банковской выписки

API	Описание
POST api/Statements/InsertStatement?centerNumber={centerNumber}	Добавление выписки по указанному центру

Contracts

контроллер получения информации по договору

API	Описание
POST api/Contracts/AddNewContract	Добавление договора Берлио из внешних систем
GET api/Contracts/GetAllClientsContractsForCenter?centerNumber={centerNumber}	получить все договора указанного центра
GET api/Contracts/GetAllCenterContracts?centerNumber={centerNumber}	получить все договора указанного центра
GET api/Contracts/GetAllClientContracts?centerNumber={centerNumber}&contractNumber={contractNumber}	получить все поддоговора
GET api/Contracts/GetContractById?centerNumber={centerNumber}&id={id}	получение информации по договору по id
GET api/Contracts/GetContractInfo?centerNumber={centerNumber}&contractNumber={contractNumber}&contractSubNumber={contractSubNumber}	получить информацию по договору
GET api/Contracts/GetContractFullInfo?centerNumber={centerNumber}&contractNumber={contractNumber}&contractSubNumber={contractSubNumber}	получить полную информацию по договору
GET api/Contracts/GetContractInfoByUnp?centerNumber={centerNumber}&unp={unp}	получить информацию по договору по унп
GET api/Contracts/GetAllClientContractsByUnp?centerNumber={centerNumber}&unp={unp}	получить информацию по договорам по унп
GET api/Contracts/GetContractPhones?centerNumber={centerNumber}&contractNumber={contractNumber}	получить список телефонов договора
POST api/Contracts/AddContractPhone?centerNumber={centerNumber}&unp={unp}&phoneNumber={phoneNumber}&options={options}	добавить номер телефона на договор с указанным унп
POST api/Contracts/DeleteContractPhone?centerNumber={centerNumber}&unp={unp}&phoneNumber={phoneNumber}	удалить номер телефона с договора с указанным унп
GET api/Contracts/GetContractsByLkbAuth?login={login}&password={password}	получить информацию по договорам, через авторизацию Lkb
GET api/Contracts/GetContractUnpByCard?cardNumber={cardNumber}	получить унп договора по номеру карты
GET api/Contracts/GetCenterContractsByBeginDate?centerNumber={centerNumber}&dateFrom={dateFrom}&dateTo={dateTo}	получить все договора центра с датой начала договора за указанный период
GET api/Contracts/GetContractPeriodStatus?centerNumber={centerNumber}&contractNumber={contractNumber}&contractSubNumber={contractSubNumber}&beginDate={beginDate}	No documentation available.

Periods

контроллер получения информации по периодам

API	Описание
GET api/Periods/GetPeriods?centerNumber={centerNumber}	получить информацию по периодам
GET api/Periods/GetPeriodByDate?centerNumber={centerNumber}&date={date}

Realisations

контроллер получения информации о реализации по договору

API	Описание
GET api/Realisations/GetContractRealisations?centerNumber={centerNumber}&contractNumber={contractNumber}&contractSubNumber={contractSubNumber}&dateFrom={dateFrom}&dateTo={dateTo}	получение реализации по договору
GET api/Realisations/GetCenterRealisations?centerNumber={centerNumber}&dateFrom={dateFrom}&dateTo={dateTo}	получение реализации по центру
GET api/Realisations/UnloadCenterRealisation?centerNumber={centerNumber}&flagUnloadConfirm={flagUnloadConfirm}&flagChangedAll={flagChangedAll}&dateFrom={dateFrom}&dateTo={dateTo}	получение реализации по центру
GET api/Realisations/UnloadContractRealisation?centerNumber={centerNumber}&contractNumber={contractNumber}&contractSubNumber={contractSubNumber}&flagUnloadConfirm={flagUnloadConfirm}&flagChangedAll={flagChangedAll}&dateFrom={dateFrom}&dateTo={dateTo}	получение реализации по центру
GET api/Realisations/GetContractsRealisationByProduct?centerNumber={centerNumber}&date={date}	получить реализацию по договорам с группировкой по продуктам
GET api/Realisations/GetContractRealisationsByDay?centerNumber={centerNumber}&contractNumber={contractNumber}&contractSubNumber={contractSubNumber}&date={date}	получение реализации по договору за день
GET api/Realisations/GetCenterSelfCardsRealisations?centerNumber={centerNumber}&dateFrom={dateFrom}&dateTo={dateTo}	получение реализации по картам собственного центра на всех объектах (свои и внешние) за указанный период
GET api/Realisations/GetCenterOtherCardsRealisations?centerNumber={centerNumber}&dateFrom={dateFrom}&dateTo={dateTo}	получение реализации по картам внешних центров на наших объектах за указанный период
GET api/Realisations/GetSumRealisationsContracts?centerNumber={centerNumber}&dateFrom={dateFrom}&dateTo={dateTo}	получение суммарной реализации по договорам

Eschf

ЭСЧФ контроллер

API	Описание
POST api/Eschf/RealisationsByCheckSetCheckUNP?centerNumber={centerNumber}&objectNumber={objectNumber}&date={date}&checkNumber={checkNumber}&unp={unp}	Установить унп на реализации по чеку для дальнейшего выставления ЭСЧФ
GET api/Eschf/GetRealisationsByCheckWithCheckUnpInfo?centerNumber={centerNumber}&objectNumber={objectNumber}&date={date}&checkNumber={checkNumber}	Получить информацию по чеку
GET api/Eschf/GetChecksUnp?centerNumber={centerNumber}&unp={unp}	получение списка заявок на высталение ЭСЧФ по унп
GET api/Eschf/UnnulateChecksUnp?centerNumber={centerNumber}&checkUnpId={checkUnpId}	аннулирование заявок на высталение ЭСЧФ по унп
GET api/Eschf/GetChecksDetailUnpList?centerNumber={centerNumber}&unp={unp}	получение детального списка заявок на высталение ЭСЧФ по унп
GET api/Eschf/GetChecksUnpStatistics?centerNumber={centerNumber}&objectNumber={objectNumber}&beginDate={beginDate}&endDate={endDate}	получение
GET api/Eschf/GetUsersChecksUnpStatistics?centerNumber={centerNumber}&objectNumber={objectNumber}&beginDate={beginDate}&endDate={endDate}

LkbInteraction

контроллер взаимодействия с ЛКБ

API	Описание
GET api/LkbInteraction/ValidityUser?login={login}&password={password}	валидация пользователя
GET api/LkbInteraction/ValidityLkbUser?login={login}&password={password}	валидация пользователя

ContractRealizations

контроллер получения информации о реализации по договору

API	Описание
GET api/ContractRealizations/GetContractRealisations?centerNumber={centerNumber}&contractNumber={contractNumber}&contractSubNumber={contractSubNumber}&dateFrom={dateFrom}&dateTo={dateTo}	получение реализации по договору за указанный период

Cards

контроллер получения информации по картам

API	Описание
GET api/Cards/GetCenterCards?centerNumber={centerNumber}	получить список карт по указаному центру
GET api/Cards/GetContractCards?centerNumber={centerNumber}&contractNumber={contractNumber}&contractSubNumber={contractSubNumber}	получить список карт по указаному центру и договору
GET api/Cards/GetCardInfo?cardNumber={cardNumber}	получить информацию по карте
POST api/Cards/UpdateCard?centerNumber={centerNumber}&contractNumber={contractNumber}&cardNumber={cardNumber}&cardConditionsNumber={cardConditionsNumber}&cardCategoryNumber={cardCategoryNumber}&cardDoze={cardDoze}&cardPeriodLimit={cardPeriodLimit}&cardWeight={cardWeight}&cardBinding={cardBinding}	обновить карту по указанному центру и договору
POST api/Cards/UpdateCard?centerNumber={centerNumber}&contractNumber={contractNumber}	обновить карту по указанному центру и договору
POST api/Cards/UpdateCards?centerNumber={centerNumber}&contractNumber={contractNumber}	обновить список карт по указанному центру и договору
GET api/Cards/GetCardRealisations?cardNumber={cardNumber}&dateFrom={dateFrom}&dateTo={dateTo}	получить реализации по карте

Kapsch

контроллер работы с БУ

API	Описание
POST api/Kapsch/RegisterObu?centerNumber={centerNumber}&contractNumber={contractNumber}	регистрация БУ в системе Берлио (регистрация в Kapsch, происходит согласно регламента при передаче от Берлио файла CDX)
POST api/Kapsch/BlockObues?centerNumber={centerNumber}&contractNumber={contractNumber}&feedbackEmail={feedbackEmail}	блокировка БУ (блокируются БУ переданные в списке, все БУ непереданные в списке разблокируются)
GET api/Kapsch/GetContractObues?centerNumber={centerNumber}&contractNumber={contractNumber}	получение информации о БУ договора
GET api/Kapsch/GetContractObuesRealizations?centerNumber={centerNumber}&contractNumber={contractNumber}&beginDate={beginDate}&endDate={endDate}	получение проводок (реализации) по БУ

ContractReports

контроллер отчетов по договору

API	Описание
GET api/ContractReports/GetTxtReport?centerNumber={centerNumber}&contractNumber={contractNumber}&contractSubNumber={contractSubNumber}&beginTime={beginTime}&endDate={endDate}&userName={userName}	текстовый отчет по договору

ArisCards

контроллер работы с картами Арис

API	Описание
GET api/ArisCards/GetCardInfo?cardNumberAris={cardNumberAris}	получение информации по карте
POST api/ArisCards/InsertRealization	вставка реализации

Debitors

контроллер получения информации о дебиторской задолженности

API	Описание
GET api/Debitors/GetCenterDebitors?centerNumber={centerNumber}&currentDate={currentDate}	Дебиторская задолженность

VatUsers

контроллер работы с пользователями сайта ЭСЧФ

API	Описание
POST api/VatUsers/Login	вход пользователя
POST api/VatUsers/Logout	выход пользователя
POST api/VatUsers/Refresh	обновление токена пользователя
POST api/VatUsers/RegisterUser	регистрация пользователя
POST api/VatUsers/ChangePassword	измение пароля пользователя
POST api/VatUsers/UpdateUser	регистрация пользователя
GET api/VatUsers/ValidityEmailKey?login={login}&emailKey={emailKey}	проверка ключа подтверждения ящика
GET api/VatUsers/GetVatUsersRegisteredByPeriod?beginDate={beginDate}&endDate={endDate}	получение списка пользователь зарегистрированных в указанный период

Payments

контроллер получения информации по платежам

API	Описание
GET api/Payments/GetContractPayments?centerNumber={centerNumber}&contractNumber={contractNumber}&contractSubNumber={contractSubNumber}&dateFrom={dateFrom}&dateTo={dateTo}	получить список платежей по указанному договору
GET api/Payments/GetCenterPayments?centerNumber={centerNumber}&dateFrom={dateFrom}&dateTo={dateTo}	получить список платежей по указанному сентру
GET api/Payments/UnloadDataPayments?centerNumber={centerNumber}&flagUnloadConfirm={flagUnloadConfirm}&flagChangedAll={flagChangedAll}&dateFrom={dateFrom}&dateTo={dateTo}	получить список платежей по указанному сентру

OnlineDevices

API	Описание
GET api/OnlineDevices	получить список устройств работающих онлайн
GET api/OnlineDevices?centerNumber={centerNumber}&objectNumber={objectNumber}	получить список устройств работающих онлайн
GET api/OnlineDevices?centerNumber={centerNumber}&objectNumber={objectNumber}&deviceNumber={deviceNumber}	получить список устройств работающих онлайн

ContractsCsv

API	Описание
GET api/ContractsCsv?centerNumber={centerNumber}	получить все договора указанного центра

ObjectCountries

API	Описание
GET api/ObjectCountries	получить все страны

PaymentsCsv

контроллер выгрузки данных по платежам в csv

API	Описание
GET api/PaymentsCsv?centerNumber={centerNumber}&flagUnloadConfirm={flagUnloadConfirm}&flagChangedAll={flagChangedAll}&dateFrom={dateFrom}&dateTo={dateTo}	получить список платежей по указанному сентру

DebitorsCsv

API	Описание
GET api/DebitorsCsv?centerNumber={centerNumber}&currentDate={currentDate}	Дебиторская задолженность

ObjectCities

API	Описание
GET api/ObjectCities	получить все города
GET api/ObjectCities?regionId={regionId}	получить регионы указанного региона

Mobile

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

API	Описание
POST api/Mobile?supportMessage={supportMessage}	отправить Email в тех. поддержку

TurnoverShift

контроллер работы с оборотной ведомостью

API	Описание
GET api/TurnoverShift?centerNumber={centerNumber}&currentDate={currentDate}	О

PeriodStatus

контроллер получения информации по периоду

API	Описание
GET api/PeriodStatus?centerNumber={centerNumber}&contractNumber={contractNumber}&contractSubNumber={contractSubNumber}&beginDate={beginDate}	информация о статусе периода по указанному договору

FuelTypes

API	Описание
GET api/FuelTypes	получить все виды топлива

ObjectServices

Сервисы объекта

API	Описание
GET api/ObjectServices	получить список сервисов доступных на АЗС

AzsOperators

API	Описание
GET api/AzsOperators	получить список операторов сетей АЗС

ObjectTypes

API	Описание
GET api/ObjectTypes	получить список типов объектов

PlatonPayments

контроллер платежей по Платон

API	Описание
POST api/PlatonPayments?CardNumber={CardNumber}&CardNumberExtended={CardNumberExtended}&RouteNumber={RouteNumber}&Summa={Summa}&IdTransaction={IdTransaction}	оплата маршрутной карты

ObjectPrices

API	Описание
GET api/ObjectPrices?centerNumber={centerNumber}&objectNumber={objectNumber}	получить цены с объекта

ObjectRegions

API	Описание
GET api/ObjectRegions	получить все регионы
GET api/ObjectRegions?countryId={countryId}	получить регионы указанной страны

Objects

контроллер получения информации по объектам

API	Описание
GET api/Objects	получить все объекты Берлио
GET api/Objects?centerNumber={centerNumber}	получить все объекты Берлио
GET api/Objects?centerNumber={centerNumber}&objectNumber={objectNumber}	получить все объекты Берлио

RealizationsCsv

контроллер выгрузки данных по реализации в csv

API	Описание
GET api/RealizationsCsv?centerNumber={centerNumber}&flagUnloadConfirm={flagUnloadConfirm}&flagChangedAll={flagChangedAll}&dateFrom={dateFrom}&dateTo={dateTo}	получение реализации по центру