+7 (812) 335-77-33
+7 (8617) 67-76-65
office@rlisystems.ru

Общие интерфейсы

Получение списка терминалов (TerminalList)

Запрашивается операция TerminalList. В результате клиенту возвращается массив структур содержащих следующие поля:

  • TerminalCode (строковый) - код терминала, для использования в вызовах последующих опрераций
  • TerminalName (строковый) - читабельное название терминала

Возвращаемые коды терминалов являются постоянными, и в случае работы клиентского ПО с каким-либо конкретным терминалом могут быть один раз заданы, в процессе настройки ПО.

Получение информации о балансе и пороге отключения (Balance)

Данная операция позволяет отслеживать состояние счета. Возврацаемый результат содержит следующие поля:

  • Currency (строковый) - наименование валюты
  • Rest (вещественное число) - текущий остаток на счете клиента
  • MinRest (вещественное число) - порог отключения, установленный для счета коиента.

Интерфейс для получения ДУ

Операция получения ДУ состоит из двух этапов. На первом этапе по номеру контейнера запрашивается список документов учета, ему соответствующих (операция TDUInfoList). В возвращаемых данных содержится код документа учета, по которому можно запросить непосредственно сам документ в нужном представлении (операция TDURepresentation).

Получение списка документов учета по контейнеру (TDUInfoList)

Данная операция позволяет получить список существующих документов учета для указанного контейнера.

Операция принимает на вход два обязательных параметра:

  • SearchString (строковый) - номер контейнера в формате ABCD1234567 или 1234567
  • TerminalCode (строковый) - код терминала

На выходе возвращается список структур, состоящих из следующих полей:

  • TDUCode (целое число) - код документа учета, для его получения
  • TDUNumber (строковый) - номер документа учета
  • TDUDate (дата) - дата документа учета (формат YYYY-MM-DD)
  • ContainerNumber (строковый) - полный номер контейнера, по которому найден документ.

Получение документа учета (TDURepresentation)

Для получения непосредственно документа учета используется операция TDURepresentation. Данная операция принимает три входных параметра:

  • TDUCode (целое число) - код документа учета
  • TerminalCode (строковый) - код терминала
  • FormatCode (строковый) - код формата, для создания представления документа учета. Возможные варианты: PDF - печатное представление документа учета (документ Adobe PDF), XML - XML представление документа учета.

Ответ операции состоит из двух структур (TDUData и TDURepresentation).

Структура TDUData содержит общую информацию о полученном документе учета, а именно:

  • TDUDate (дата) - дата документа учета (формат YYYY-MM-DD)
  • TDUNumber (строковый) - номер документа учета
  • TDUContainerList (строковый) - массив номеров контейнеров (ContainerNumber), включенных в данный документ учета.

Структура TDURepresentation содержит запрошенное представление документа учета и состоит из следующих полей:

  • ContentType (строковый) - MIME тип представления (например text/xml для XML представления)
  • Data (бинарный, Base64) - бинарные данные представления документа учета в кодировке Base64 (содержимое PDF или XML файла).

Интерфейс для работы с предоставлением информации о контейнере в импорте

Добавление пользовательской группы (ImportEventsGroupAdd)

Данная операция предназначена для создания дополнительных групп. Операция на вход принимает один параметр:

  • Name (строковый) - название пользовательской группы контейнеров.

В случае успешного выполнения возвращается целое число, соответствующее коду вновь добавленной группы.

Удаление пользовательской группы (ImportEventsGroupDelete)

Удаляет группу, если в ней не содержится подписанных контейнеров (если группа пуста). В противном случае возвращает ошибку.

Данная операция принимает на вход один параметр:

  • GroupId (целое число) - код пользовательской группы, которую необходимо удалить.

Возвращаемых параметров нет.

Переименование пользовательской группы (ImportEventsGroupRename)

Переименовывает (меняет название) пользовательской группы. Содержимое группы не затрагивается.

Данная операция принимает на вход два параметра:

  • GroupId (целое число) - код пользовательской группы, которую необходимо переименовать.
  • Name (строковый) - новое название пользовательской группы.

Возвращаемых параметров нет.

Подписка на контейнер (ImportEventsContainerSubscribe)

Производит подписку на события по указанному контейнеру.

Входные параметры:

  • TerminalCode (строковый) - код терминала, с которого брать события по данному контейнеру.
  • ContainerNumber (строковый) - номер контейнера, для получения событий
  • GroupId (целое число) - код пользовательской группы для подписки. В случае, если данный параметр равен 0 подписка будет производиться "без группы".
  • UserInfo (строковый) - необязательные параметер, будет добавляться в качестве коментария к отсылаемым по почте событиям

Возвращает код подписанного контейнера(числовой)

Отмена подписки на контейнер (ImportEventsContainerUnsubscribe)

Отменяет подписку на контейнер.

Входные параметры:

  • TerminalCode (строковый) - код терминала, с которого брать события по данному контейнеру.
  • ContainerId (числовой) - код подписанного контейнера

Возвращаемых параметров нет.

Изменение пользовательской группы у подписанного контейнера (ImportEventsContainerGroupChange)

Изменяет пользовательскую группу, в которой числится указанный контейнер.

Входные параметры:

  • ContainerId (числовой) - код подписанного контейнера
  • GroupId (целое число) - код пользовательской группы.

Возвращаемых параметров нет.

Ссылки: