Публичное API для работы с КС (REST)

• Для получения текущей информации о КС необходимо выполнить запрос типа GET на URL:

  /system/info

  Результат:
  

  Название поля	Тип	Описание	Примечания
  version	строка	версия кассового сервера
  buildNumber	число	номер сборки
  buildDate	строка	дата сборки
  commit	строка	версия проекта в текущий момент времени
  versionREst	число	версия REST
  dictThreadPoolSize	число	кол-во одновременно выполняемых задач на генерацию справочников
  saleThreadPoolSize	число	кол-во одновременно выполняемых задач на загрузку продаж
  exchangeThreadPoolSize	число	кол-во одновременно выполняемых задач по взаимодействию с кассой
  salerunThreadPoolSize	число	кол-во одновременно выполняемых задач по инициализации выгрузки продаж на кассе
  salesLoadModes	массив	БД для загрузки продаж	Данные получаются из Настроек сервера (подраздел "Продажи")

• Для получения текущего состояния КС надо выполнить запрос типа GET на URL:

  /system/state

  Результат:

  Название поля	Тип	Описание
  bonusActive	логический	активность взаимодействия с бонусным сервером
  licenseManagmentActive	логический	активность управления лицензиями
  generateDictionarySchedulerWork	логический	активность расписания генерации справочников
  salesSchedulerWork	логический	активность расписания загрузки продаж
  dictionaryRunSchedulerWork	логический	активность расписания сигналов справочников
  saleRunSchedulerWork	логический	активность расписания сигналов справочников

• Для получения списка магазинов на КС надо выполнить запрос типа GET на URL:

  /shops

  Результатом является коллекция объектов следующего содержания:

  Название поля	Тип	Описание
  id	строка	идентификатор магазина
  title	строка	отображаемое имя магазина
  clusterId	строка	идентификатор кластера (если есть)
  exchange	объект	информация по используемому типу обмена в магазине
  cashes	коллекция	список идентификаторов касс в данном магазине
  parentGroup	строковой	идентификатор группы, к которой принадлежит магазин

  Если в качестве GET запроса указать URL:

  /shops/<идентификатор магазина>

  , то результатом будет эта же информация для конкретного магазина.

• Для получения списка касс на КС надо выполнить запрос типа GET на URL:

  /cashes

  Результатом является коллекция объектов следующего содержания:

  Название поля	Тип	Описание
  id	строка	идентификатор кассы (д.б. уникальным на уровне КС)
  password	строка	пароль для кассы (не используется)
  clusterId	строка	идентификатор кластера (если есть)
  ip	строка	ip-адрес кассы (может быть задан в виде доменного имени)
  title	строка	отображаемое имя кассы
  exchange	коллекция объектов	информация по используемым типам обмена в кассе
  cashCode	строка	код кассы (д.б. уникальным в пределах одного кластера)
  parentShop	строка	идентификатор магазина, к которому принадлежит касса

  Если в качестве GET запроса указать URL:

  /cashes/<идентификатор кассы>

  , то результатом будет эта же информация для конкретной кассы.

• Для получения списка справочников на КС надо выполнить запрос типа GET на URL:

  /dicts

  Результат:

  Название поля	Тип	Описание
  dictId	строка	идентификатор справочника
  caption	строка	название справочника
  classes	коллекция строк	внутренние названия выгружаемых классов справочников

   Классы, используемые для выгрузки справочников

  Класс	Описание
  su.artix.artixinterchange.unload.AgerestrictDictionary.java	Выгрузка возрастных ограничений по процентному содержанию алкоголя
  su.artix.artixinterchange.unload.BarcodeDictionary.java	Выгрузка штрих-кодов
  su.artix.artixinterchange.unload.ButtonDictionary.java	Выгрузка кнопок
  su.artix.artixinterchange.unload.CardDictionary.java	Выгрузка современных карт
  su.artix.artixinterchange.unload.CardGroupDictionary.java	Выгрузка современных групп карт
  su.artix.artixinterchange.unload.CashUserDictionary.java	Выгрузка кассиров
  su.artix.artixinterchange.unload.CatalogDictionary.java	Выгрузка каталогов
  su.artix.artixinterchange.unload.ClientDictionary.java	Выгрузка современных клиентов
  su.artix.artixinterchange.unload.CmactionDictionary.java	Выгрузка действий
  su.artix.artixinterchange.unload.CommandDictionary.java	Выгрузка команд
  su.artix.artixinterchange.unload.CurrencyDictionary.java	Выгрузка валюты
  su.artix.artixinterchange.unload.DeptDictionary.java	Выгрузка отделов
  su.artix.artixinterchange.unload.DiscountKitDictionary.java	Выгрузка комплектов
  su.artix.artixinterchange.unload.DiscSystemDictionary.java	Выгрузка дисконтных систем
  su.artix.artixinterchange.unload.HotKeyDictionary.java	Выгрузка горячих клавиш
  su.artix.artixinterchange.unload.InventGroupDictionary.java	Выгрузка групп товаров
  su.artix.artixinterchange.unload.InventItemDictionary.java	Выгрузка товаров
  su.artix.artixinterchange.unload.InventItemShortDictionary.java	Выгрузка товаров без ограничений и дополнительных цен
  su.artix.artixinterchange.unload.InventItemShortGlobalPricesLocalDictionary.java
  su.artix.artixinterchange.unload.KbKeyDictionary.java	Выгрузка клавиш
  su.artix.artixinterchange.unload.LDiscCardDictionary.java	Выгрузка старых дисконтных карт
  su.artix.artixinterchange.unload.LDiscFixedDictionary.java	Выгрузка старых фиксированных скидок
  su.artix.artixinterchange.unload.LDiscSchemeDictionary.java	Выгрузка старых схем скидок
  su.artix.artixinterchange.unload.LVatDictionary.java	Выгрузка налогов
  su.artix.artixinterchange.unload.MCashUserDictionary.java	Выгрузка старых пользователей
  su.artix.artixinterchange.unload.MacroDictionary.java
  su.artix.artixinterchange.unload.MenuDictionary.java	Выгрузка меню
  su.artix.artixinterchange.unload.PriceDictionary.java	Выгрузка цен
  su.artix.artixinterchange.unload.RoleDictionary.java	Выгрузка ролей
  su.artix.artixinterchange.unload.ShopDictionary.java	Выгрузка магазинов
  su.artix.artixinterchange.unload.TimerestrictDictionary.java	Выгрузка возрастных ограничений по процентному содержанию алкоголя
  su.artix.artixinterchange.unload.TmcrequiredquantityDictionary.java
  su.artix.artixinterchange.unload.TmcvisualverifyDictionary.java
  su.artix.artixinterchange.unload.UnitDictionary.java	Выгрузка единиц измерения

• Для запуска генерации справочников необходимо отправить запрос типа POST на URL:

  http://<хост>:<порт>/CSrest/rest/v2/treeObjects/unload?

  Параметры запроса:

  Наименование	Тип данных	Описание	Примечания
  ids	строка	Идентификатор объекта, на котором необходимо запустить генерацию справочников (магазин, касса, категория)
  username	строка	Логин пользователя с кассового сервера

  В теле запроса передается массив объектов, содержащих следующие поля:

  Наименование	Тип данных	Возможные значения	Описание	Примечания
  dictionary	строка		Имя задачи на выгрузку
  unloading	логический	true false	Флаг полной выгрузки	При значении true будет произведена полная выгрузка

  Пример запроса на запуск генерации справочников на магазине с id = _shop_1_53cf17d3 с последующей выгрузкой на кассы:

  POST http://192.169.1.200:8080/CSrest/rest/v2/treeObjects/unload?ids=_shop_1_53cf17d3&username=admin
  [ {
  "dictionary": "discount",
  "unloading": true
  } ]

• Для отправки сигнала на кассу для запуска загрузки справочников необходимо выполнить запрос типа POST на URL:

  http://<хост>:<порт>/cashes/<идентификатор кассы>/dicts/startLoad

  Тело запроса должно быть пустым.

• Для отправки сигнала на кассу для запуска выгрузки продаж необходимо выполнить запрос типа PUT на URL:

  http://<host>:<port>/CSrest/rest/sales/unload/cashid/{cashId}/kick

  Параметры запроса:

  Наименование	Тип данных	Описание	Примечания
  cashId	string	Идентификатор кассы, на которую нужно отправить сигнал на выгрузку продаж

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

  При успешном добавлении сигнала возвращается статус HTTP "200". При ошибке возвращается код ошибки.

Для любого планировщика со страницы http://<host>:<port>/CS/CashServerWeb/timetable доступны следующие операции: получить состояние, остановить, запустить.

Для всех задач, перечисленных выше, для управления ею нужно использовать следующие запросы:

Для всех задач, перечисленных выше, для управления ею нужно использовать следующие запросы:

Для приостановки выполнения задачи "Загрузка продаж в БД" можно выполнить curl-запрос вида:

curl -I -XPUT "http://localhost:8080/CSrest/rest/schedulers/loadSales/pause

Обработка запросов на поиск чека. Поиск чека ведется по идентификатору и коду магазина.

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

/sales/document/<identifier>[?shopId=<id магазина>&clusterId=<id кластера>&idType=<тип id документа>]

, где identifier – идентификатор документа, shopId – id магазина, clusterId – id кластера, idType – тип id документа, sourceidentifier – идентификационный номер документа-основания для операций, fiscalidentifier – фискальный идентификатор документа. Параметры shopId, clusterId и idType являются необязательными строковыми параметрами.

Параметр idType может принимать значение:

• -1 –  по полю sourceidentifier в таблице document,

• 0 – по полю identifier в таблице document,

• 1 – по полю fiscalidentifier в таблице document,

• 2 – по номеру карты клиента, поле number в таблице carditem,

• 3 – по номеру телефона клиента, поле phone в таблице client

Возможны следующие варианты запросов:

1. Ни один из параметров shopId и clusterId не указан, тогда поиск документа будет осуществляться в БД documentsAll.
2. Если указать параметр shopId (id магазина), то поиск документа будет осуществляться в БД documents<номер магазина>.
3. Магазин находится в кластере, тогда для него необходимо в запросе указать параметр clusterId, при этом:

• Если shopId указан, то поиск документа будет осуществляться в БД <номер кластера>documents<номер магазина>
• Если shopId НЕ указан, то поиск документа будет осуществляться в БД  <номер кластера>documentsAll

Результатом запроса будет массив json-объектов, это связано с тем что identifier не является уникальным значением.

[{
	"documentid":16,
	"cashCode":"13",
	"docNum":2,
	"docType":13,
	"userCode":"4",
	"timeBeg":1425548174000,
	"timeEnd":1425548174000,
	"discPerc":0.00,
	"discAbs":0.00,
	"docSum":15.20,
	"closed":1,
	"sumcash":0.00,
	"baseSum":0.00,
	"modSum":0.00,
	"sum2m":0.00,
	"inventPositions":[],
	"bonusPositions":[],
	"moneyPositions":
	[{
		"userCode":"4",
		"posTime":1425548174000,
		"opCode":44,
		"valCode":1,
		"sumB":15.20,
		"reverseOperation":0,
		"nrate":0.0000,
		"bond":0.0000,
		"bond_quant":0,
		"vsum":15.20,
		"sumn":15.20,
		"sume":15.20,
		"docNum":2,
		"c_link":0,
		"frnum":0,
		"cardnum":""
	}],
	"stornoPositions":[],
	"cardPositions":[],
	"identifier":"333:13:2:2",
	"vatsum":0.00,
	"summode":0,
	"sumtype":0,
	"dateincrement":0,
	"deptCode":0,
	"c_link":0,
	"sumn":15.20,
	"sume":15.20,
	"vbrate":1.0000,
	"verate":1.0000,
	"docSumm":15.20
}]

Статусы акцизных марок

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

• 0 – Марка не зарегистрирована в БД,
• 1 – Товар с такой маркой продан,
• 2 – Товар с такой маркой возвращен,
• 3 – Марка зарезервирована в чеке продажи,
• 4 – Марка снята с резерва в чеке продажи,
• 5 – Марка зарезервирована в чеке возврата (чеке возврата по чеку продажи),
• 6 – Марка снята с резерва в чеке возврата (чеке возврата по чеку продажи),
• 7 – Акцизная марка отсутствует в списке разрешенных к продаже,
• 8 – Связка кода и алкокода товара отсутствует,
• 9 – Товар отсутствует на остатке,
• 10 – Штрих-код для проверки в белом списке не передан,
• 11 – Соответствие акцизной марки и штрих-кода в белом списке не найдено,
• 12 – Магазин для проверки остатков не найден,
• 13 – Штрих-код для проверки остатков не заполнен,
• 14 – Код товара для проверки остатков не заполнен,
• 15 – Справочник остатков для товара, по которому проверяем остатки, заполнен не корректно.

Получение статуса акцизной марки

Для получения информации о статусе регистрации акцизной марки нужно выполнить запрос:

• типа POST на URL:

  http://<host>:<port>/CSrest/rest/sales/exciseMark/status/?doctype=<тип документа>&identifier=<идентификатор чека>[?shopcode=<код магазина>&cashcode=<код кассы>&tmccode=<код товара>&barcode=<штрих-код товара>&additionalexcisemark=<дополнительный штрих-код акцизной марки>&excisetype=<тип акцизной марки>&reserveid=<идентификатор запроса, по которому выполнялось резервирование>]

  Параметры shopcode, cashcode, tmccode, barcode, additionalexcisemark, excisetype, reserveid являются необязательными параметрами.

  Параметры tmccode (код товара), barcode (штрих-код товара), additionalexcisemark (дополнительный штрих-код акцизной марки) используются для проверки наличия связки кода и алкокода акцизных товаров (статус 8).

  При выполнении повторного запроса на резервирование акцизной марки в чеке продажи/возврата будет осуществлена проверка на соответствие идентификатора чека и идентификатора запроса на резервирование акцизной марки (GUID, БД Documents таблица Excisemarks поле reserveid):

  • если идентификатор чека и идентификатор запроса резервирования акцизной марки (GUID) совпадают с соответствующими значениями предыдущего запроса, то статус акцизной марки будет изменен (для чека продажи – статус 4, для чека возврата – статус 6),
  • если идентификатор чека и идентификатор запроса резервирования акцизной марки (GUID) не совпадают с соответствующими значениями предыдущего запроса, то статус акцизной марки не будет изменен (для чека продажи останется статус 3, для чека возврата – статус 5).

  Тело запроса состоит из массива строк, содержащих идентификаторы акцизных марок.

  Пример тела запроса

  [
      "sdgf8734t",
      "22N000003L82ID9EYWS0A4K50821001000478QSGD2PXY2RZSFS0A18SKXXR4Q87AKT0",
      "22N000000HM5B96KYYP01DP408150020199076KX6B38AR2SWXBDJV5PU8H5H1C0X66Y",
      "20N000004RI5YQIBC2T0DFU40211002010451AD623AXDL7OUSAPNT6Y8SUAYMUAEZGD",
      "12QWERTYUIOPLKJHGFDSAZX11111234567890QWERTYUIOPQWERTYUIOPQWERTYUIOPQ"
  ]

  Результатом запроса является массив объектов, содержащих информацию об идентификаторах акцизных марок и статусы их регистрации.

  Пример ответа

  [
      {
          "exciseMarkId": "12QWERTYUIOPLKJHGFDSAZX11111234567890QWERTYUIOPQWERTY7IOPQWERTYU1700",
          "status": 1,
          "tmccode": "46047016",
          "barcode": "222",
          "statusDate": "2016-12-22T10:21:53.000+0000",
          "exciseType": "ALCOHOL"
      }
  ]

• типа POST на URL:

  http://localhost:38051/CSrest/rest/sales/exciseMark/status/check

  Тело запроса состоит из объектов, которые позволяют получить статус марки и информацию из белого списка марок:

  Пример тела запроса

  [
  {"exciseMarkId": "111", "exciseType": "ALCOHOL"},
  {"exciseMarkId": "222", "exciseType": "TOBACCO"},
  {"exciseMarkId": "333", "exciseType": "SHOES"}
  ]

  Телом ответа является массив объектов, содержащих информацию об акцизных марках из белого списка и о статусе марок:

  Пример ответа

  [
      {
          "exciseType":"ALCOHOL",
          "exciseMarkId":"111",
          "exciseMarkWhite":{
              "excisemarkid":"111",
              "shopcode":"1",
              "inn":"777",
              "exciseType":"ALCOHOL",
              "serialnumber":"555",
              "barcode":"3333" 
          },
          "status":1
      },
      {
          "exciseType":"TOBACCO",
          "exciseMarkId":"222",
          "status":3
      },
      {
          "exciseType":"SHOES",
          "exciseMarkId":"222",
          "status":0
      }
  ]

Изменение статуса акцизной марки

Для получения изменения статуса регистрации акцизной марки с сервера касса выполняет запрос типа PUT на URL:

http://<host>:<port>/CSrest/rest/sales/exciseMark/status?identifier=<идентификатор чека>[?shopcode=<код магазина>&cashcode=<код кассы>&excisetype=<тип акцизной марки>&force=false&reserveid=<идентификатор запроса, по которому выполнялось резервирование>]

Параметры shopcode, cashcode, excisetype, reserveid, force являются необязательными параметрами.

Параметр force отвечает за установку статуса акцизных марок без дополнительных проверок:

• при значении true установка статуса будет без дополнительной проверки идентификатора чека и идентификатора запроса резервирования акцизной марки (GUID) на совпадение с соответствующими значениями предыдущего статуса,
• при значении false если пытаемся поменять статус акцизной марки, то будет учтен предыдущий статус акцизной марки, идентификатор чека и идентификатора запроса резервирования акцизной марки (GUID) с дополнительной проверкой на совпадение с соответствующими значениями предыдущего статуса.

Тело запроса состоит из массива строк, содержащих идентификаторы акцизных марок и присваиваемом статусе.

[
    {
        "status": 4,
        "tmccode": "111",
        "barcode": "11",
        "exciseMarkId": "12QWERTYUIOPLKJHGFDSAZX11111234567890QWERTYUIOPQWERTYUIOPQWERTYUIOPQ"
    },
    {
        "status": 4,
        "tmccode": "111",
        "barcode": "11",
        "exciseMarkId": "12QWERTYUIOPLKJHGFDSAZX11111234567890QWERTYUIOPQWERTYUIOPQWERTYUIOPW"
    }
]

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

Для получения списка каталогов необходимо направить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/catalogs

Для получения списка каталогов с информацией о странице данных необходимо направить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/catalogs/bypage

Параметры запроса:

[
	{
		"catalogid":42204230,
		"catalogname":"Каталог №1"
	}
]

{"content":
	[
		{
		"catalogid":1,
		"catalogname": "Каталог №1"
		},
		{
			"catalogid":3,
			"catalogname":"Каталог №2"
		}
	],
"firstPage":true,
"totalPages":46,
"numberOfElements":100,
"totalElements":4569,
"lastPage":false,
"size":100,"number":0
}

Сохранение данных о каталоге в БД КС

Для сохранения данных о каталоге необходимо направить запрос типа POST на URL:

http://<host>:<port>/CSrest/rest/dictionaries/catalogs

Параметры запроса:

{
	"catalogid":42204230,
	"catalogname":"Каталог результат"
}

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

Для получения количества каталогов с сервера необходимо выполнить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/catalogs/count

Параметры запроса:

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

Для удаления записи о каталоге необходимо направить запрос типа DELETE на URL:

http://<host>:<port>/CSrest/rest/dictionaries/catalogs/id/{id}

Параметры запроса:

id

Получение данных каталога по идентификатору

Для получения записи о каталоге необходимо направить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/catalogs/id/{id}

Параметры запроса:

id

Проверка идентификатора каталога

Для получения информации о наличии каталога с конкретным ID необходимо выполнить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/catalogs/{catalogId}/exists

Параметры запроса:

Получение списка софт-чеков с КС

Для получения списка софт-чеков с сервера необходимо выполнить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/softchecks

Для получения списка софт-чеков с информацией о странице данных необходимо направить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/softchecks/bypage

Параметры запроса:

Результатом запроса является массив объектов, содержащих информацию об идентификаторах софт-чеков, дате и времени их создания и товарных позициях.

[{
	"softcheckid": "1",
	"options": 123,
	"creationDate": "2017-01-30T05:09:00.000+0000",
	"softcheckposition": [{
			"softcheckpositionid": 1,
			"softcheckid": "1",
			"barcode": "1234567890",
			"quantity": 10.000,
			"name": "Творог",
			"code": "654748"
		},
		{
			"softcheckpositionid": 2,
			"softcheckid": "1",
			"barcode": "4515553460",
			"quantity": 9.000,
			"name": "Сметана",
			"code": "067815"
		}
	]
}]

Получение количества софт-чеков

Для получения количества софт-чеков с сервера необходимо выполнить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/softchecks/count

Параметры запроса:

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

Для получения софт-чека по идентификатору необходимо выполнить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/softchecks/id/{id}

Параметры запроса:

Получение софт-чека по его идентификатору с датой отгрузки

Для получения софт-чека по идентификатору с датой отгрузки необходимо выполнить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/softchecks/id/{id}/withStatus

Параметры запроса:

Результатом запроса является объект, содержащий информацию об идентификаторе софт-чека, дате и времени его создания и товарных позициях.

{
   "softcheckid": "111222333",
   "options": 7,
   "creationDate": "2016-03-04T04:37:20.000+0000",
   "status": 1,
   "statusDate": "2022-12-05T05:14:56.000+0000",
   "softcheckposition": [
       {
           "softcheckpositionid": 5,
           "softcheckid": "111222333",
           "barcode": "121456789",
           "quantity": 2.330,
           "code": "12",
           "deptNumber": 2,
           "price": 22.33
       }
   ]
}

Сохранение софт-чека

Для сохранения софт-чека на сервере необходимо выполнить запрос типа POST с данными софт-чека на URL:

http://<host>:<port>/CSrest/rest/dictionaries/softchecks

Параметры запроса:

Пример тела запроса:

{
	"softcheckid": "1",
	"options": 123,
	"creationDate": "2017-01-30T05:09:00.000+0000",
	"softcheckposition": [{
		"softcheckpositionid": 1,
		"softcheckid": "1",
		"barcode": "1234567890",
		"quantity": 10.000,
		"name": "Творог",
		"code": "654748"
	}, {
		"softcheckpositionid": 2,
		"softcheckid": "1",
		"barcode": "4515553460",
		"quantity": 9.000,
		"name": "Сметана",
		"code": "067815"
	}]
}

Удаление софт-чека

Для удаления софт-чека необходимо отправить запрос типа DELETE на URL:

http://<host>:<port>/CSrest/rest/dictionaries/softchecks/id/{id}

Параметры запроса:

Сохранение документа

Для сохранения документа необходимо выполнить запрос POST на URL:

http://<host>:<port>/CSrest/rest/dictionaries/pendingchecks/

Параметры запроса:

Параметры тела запроса:

{
    "cashcode": "str",
    "shopcode": "str",
    "documentid": "str",
    "document": "str",
    "state": "str"
}

При успешном выполнении запроса возвращается HTTP статус "200". Если при выполнении запроса произошла ошибка, то тело ответа будет содержать:

{
  "errorCode" : "int",
  "url" : "str",
  "message" : "str",
  "errorClassName" : "str"
}

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

Для получения документа необходимо выполнить запрос GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/pendingchecks/{documentid}

Параметры запроса:

В URL запрос может быть добавлена часть exists, которая будет проверять наличие запрашиваемых данных и возвращать true либо false. Если exists не указан в запросе, то при отсутствии запрашиваемых данных будет выводиться ошибка.

{
    "cashcode": "str",
    "shopcode": "str",
    "documentid": "str",
    "document": "str",
    "state": "str"
}

Изменение документа

Для изменения документа необходимо выполнить запрос PUT на URL:

http://<host>:<port>/CSrest/rest/dictionaries/pendingchecks/{documentid}

Параметры запроса:

{
    "cashcode": "str",
    "shopcode": "str",
    "document": "str",
    "state": "str"
}

Поля document и state не обязательные. В запросе должно присутствовать как минимум одно из них. 

При успешном выполнении запроса возвращается HTTP статус "200". Если при выполнении запроса произошла ошибка, то тело ответа будет содержать:

{
  "errorCode" : "int",
  "url" : "str",
  "message" : "str",
  "errorClassName" : "str"
}

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

Для получения списка отложенных чеков необходимо выполнить запрос GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/pendingchecks[?cashid=<id_кассы>&page=<номер страницы>&size=<размер_страницы>&scope=<охват_записей>&states=<статусы_отложенных_чеков>]

Для получения списка отложенных чеков с информацией о странице данных необходимо направить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/pendingchecks/bypage[?cashid=<id_кассы>&page=<номер страницы>&size=<размер_страницы>&scope=<охват_записей>&states=<статусы_отложенных_чеков>]

Параметры запроса:

В результате обработки запроса сервер возвращает ответ вида:

{
  "number": 0,
  "size": 100,
  "lastPage": true,
  "totalElements": 2,
  "numberOfElements": 2,
  "totalPages": 1,
  "firstPage": true,
  "content": [
    {
        ... непосредственно объект
    },...следующие объекты страницы
  ]
}

Получение онлайн-чека

Для получения онлайн-чека для восстановления на кассе необходимо выполнить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/onlinechecks/{documentid}

Параметры запроса:

В URL запрос может быть добавлена часть exists, которая будет проверять наличие запрашиваемых данных и возвращать true либо false. Если exists не указан в запросе, то при отсутствии запрашиваемых данных будет выводиться ошибка.

http://<host>:<port>/CSrest/rest/dictionaries/onlinechecks/1/exist

{
    "cashcode": "str",
    "shopcode": "str",
    "documentid": "str",
    "document": "str",
    "state": "str"
}

Изменение онлайн-чека

Для изменения документа необходимо выполнить запрос PUT на URL:

http://<host>:<port>/CSrest/rest/dictionaries/onlinechecks/{documentid}

Параметры запроса:

{
    "cashcode": "str",
    "shopcode": "str",
    "document": "str",
    "state": "str"
}

Поля document и state не обязательные. В запросе должно присутствовать как минимум одно из них. 

При успешном выполнении запроса возвращается HTTP статус "200". Если при выполнении запроса произошла ошибка, то тело ответа будет содержать:

{
  "errorCode" : "int",
  "url" : "str",
  "message" : "str",
  "errorClassName" : "str"
}

Сохранение онлайн-чека

Для сохранения документа необходимо выполнить запрос POST на URL:

http://<host>:<port>/CSrest/rest/dictionaries/onlinechecks

Параметры запроса:

Параметры тела запроса:

{
    "cashcode": "str",
    "shopcode": "str",
    "documentid": "str",
    "document": "str",
    "state": "str"
}

При успешном выполнении запроса возвращается HTTP статус "200". Если при выполнении запроса произошла ошибка, то тело ответа будет содержать:

{
  "errorCode" : "int",
  "url" : "str",
  "message" : "str",
  "errorClassName" : "str"
}

Поиск и верификация карты

Для поиска и верификации карты на кассовом сервере необходимо выполнить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/ident/cards?number=111&idcardgroup=1[?phonenumber=<номер_телефона>&vertype=<тип_верификации>&cashid=<id_кассы>]

Параметры запроса:

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

В результате поиска и верификации карты сервер возвращает ответ:

[{"cardNumber":<номер_основной_карты>, "verificationCode":<код_верификации>,"verificationResult":<результат_верификации>}]

Результат верификации может принимать значения:

• 0 – SUCCESS – верификация прошла успешно, 
• 1 – INTERNAL_SERVER_ERROR – верификация не удалась по причине ошибки на сервере,
• 2 – EXTERNAL_PLUGIN_ERROR – верификация не удалась по причине ошибки во внешнем шлюзе (к примеру, шлюз посылки СМС возвратил ошибку)

При результате верификации 0 выполняется проверка поля cardNumber на пустоту:

• если получен номер карты, то карта добавляется в чек,
• если номер карты пуст, то кассиру выводится ошибка, карта в чек не добавляется.

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

Для получения списка клиентов необходимо направить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/clients

Для получения списка клиентов с постраничной информацией необходимо направить запрос типа GET на URl:

http://<host>:<port>/CSrest/rest/dictionaries/clients/bypage

Параметры запроса:

 {
      "idclient": "1434b73a-3b2a-4ce9-b3a9-dabffaea7fdf",
      "name": "Иванов Иван Иванович",
      "text": "hgfg",
      "sex": 0,
	  "birthday": "1993-09-03",
      "specialdate1name": "",
      "specialdate2name": "",
      "specialdate3name": "",
      "zipcode": "77778",
      "address": "",
      "email": "222",
      "webpage": "",
      "phonenumber": "+79231233212",
      "inn": "",
      "document": "",
      "okpo": "",
      "okpd": "",
      "occupation": "",
      "extendedoptions": "",
      "codeword": ""
      "organizationcode": "1"
	  "subscriptionadj": 0
   },
      {
      "idclient": "14e61dfb-4fe9-4bed-ba04-a436d6352e32",
      "name": "Сидоров Петр Евгеньевич",
      "text": "",
      "sex": 0,
	  "birthday": "1960-10-31",
      "specialdate1name": "",
      "specialdate2name": "",
      "specialdate3name": "",
      "zipcode": "",
      "address": "",
      "email": "",
      "webpage": "",
      "phonenumber": "89662225233",
      "inn": "",
      "document": "",
      "okpo": "",
      "okpd": "",
      "occupation": "",
      "extendedoptions": "",
      "codeword": ""
      "organizationcode": "2"
	  "subscriptionadj": 1
   }

{
   "content":    [
            {
         "idclient": "2311212111111111",
         "name": "Иван Панченко
		 "sex": 0,
         "organizationcode": "1"
		 "subscriptionadj": 1
      },
            {
         "idclient": "ee71afa1-6985-4e85-9cca-2f37ce553269",
         "name": "Тестовый пользователь с кодом организации",
         "text": "",
         "sex": 0,
         "specialdate1name": "",
         "specialdate2name": "",
         "specialdate3name": "",
         "zipcode": "",
         "address": "",
         "email": "",
         "webpage": "",
         "phonenumber": "",
         "inn": "",
         "document": "",
         "okpo": "",
         "okpd": "",
         "occupation": "",
         "extendedoptions": "",
         "codeword": "",
         "organizationcode": "1"
		 "subscriptionadj": 0
      }
   ],
   "numberOfElements": 2,
   "totalElements": 2,
   "firstPage": true,
   "lastPage": true,
   "totalPages": 1,
   "size": 100,
   "number": 0
}

Сохранение данных о клиенте в БД КС

Для сохранения данных о клиенте необходимо направить запрос типа POST на URL:

http://<host>:<port>/CSrest/rest/dictionaries/clients

Параметры запроса:

Тело запроса:

{
	"idclient": "ff8081815b601935015b601ede1e0004",
	"name": "Свиридова Юлия Петровна",
	"sex": 1,
	"phonenumber": "79021234567"
}

Получение количества объектов (записей о клиентах) с КС

Для получения количества записей о клиентах необходимо направить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/clients/count

Параметры запроса:

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

Для удаления записи о клиенте необходимо направить запрос типа DELETE на URL:

http://<host>:<port>/CSrest/rest/dictionaries/clients/id/{id}

Параметры запроса:

id

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

Для получения записи о клиенте необходимо направить запрос типа GET на URL:

http://<host>:<port>/CSrest/rest/dictionaries/clients/id/{id}

В URL запрос может быть добавлена часть exists, которая будет проверять наличие запрашиваемых данных и возвращать true либо false. Если exists не указан в запросе, то при отсутствии запрашиваемых данных будет выводиться ошибка.

Параметры запроса:

id