Изменения методов API в версии lmxR4 (2022.2)
В таблице отражены изменения в методах API в версии Системы lmxR4 (2022.2) по сравнению с версией 2022.1.
- или + обозначают добавление или удаление метода или параметра;
v1.X обозначает версии v1, v1.1 и v1.2;
(required) — обязательность параметра.
| HTTP-методы | Метод | Удалены параметры (тип данных) | Добавлены параметры (тип данных) |
| GET | /v1.X/OAuth/Applications Возвращает список OAuth-приложений. | + filter.aliasSubStr (string) | |
| GET | /v1.X/{entityType}/attributes Возвращает все атрибуты типа сущности. | + filter.from (integer) + filter.count (integer) + filter.key (string) + filter.attributeType (string) + filter.name (string) + filter.isDeleted (boolean) | |
| GET | /v1.X/{entityType}/{entityId}/attributes Возвращает значения атрибутов сущности. | + filter.from (integer) + filter.count (integer) + filter.key (string) + filter.attributeType (string) + filter.name (string) + filter.isDeleted (boolean) | |
| + POST | + v1.X/{entityType}/attributes/{attributeId} Обновляет название атрибута и его описание. | + entityType(string) (required) + attributeId (string) (required) + model (string) (required) | |
| + POST | + /v1.X/{entityType}/attributes/{attributeId}/archive Архивирует атрибут сущности. | + entityType(string) (required) + attributeId (string) (required) | |
| + POST | + /v1.X/{entityType}/attributes/{attributeId}/restore Восстанавливает из архива атрибут сущности. | + entityType(string) (required) + attributeId (string) (required) | |
| POST | /v1.X/{entityType}/{entityId}/attributes/{attributeId} Обновляет значение атрибута сущности. | - attributeId (integer) (required) - value (string) (required) | + model (required) + attributeId (string) (required) |
| + GET | + /v1.X/oauth/providers Возвращает список провайдеров аутентификации. | + includeDeleted (boolean) (required) | |
| + POST | + /v1.X/oauth/providers Создает провайдер аутентификации. | + model (required) | |
| + PUT | + /v1.X/oauth/providers/{id} Обновляет провайдер аутентификации. | + id (integer) (required) + model (required) | |
| + PUT | + /v1.X/oauth/providers/{id}/restore Восстанавливает провайдер аутентификации. | + id (integer) (required) | |
| + DELETE | + /v1.X/oauth/providers/{id}/delete Удаляет провайдер аутентификации. | + id (integer) (required) | |
| + GET | + /v1.X/batchCustomersDelete Возвращает список пакетных удалений клиентов. | + state (string) (required) + from (integer) + count (integer) | |
| + DELETE | + /v1.X/batchCustomersDelete Выполняет пакетное удаление клиентов. | + description (string) (required) + file (file) (required) | |
| + GET | + /v1.X/batchCustomersDelete/{id}/operations Возвращает список операций по внутреннему идентификатору пакетного удаления. | + id (integer) (required) + state (string) (required) + from (integer) + count (integer) | |
| - GET | - /v1.X/emissions/booklets/{id} Получить выпуск буклетов по id. | - id (integer) (required) | |
| - GET | - /v1.X/emissions/booklets/{id}/export Получить выпуск в виде CSV файла. | - id (integer) (required) | |
| - GET | - /v1.X/emissions/booklets Получить список выпусков буклетов. | - from (integer) - count (integer) | |
| - PUT | - /v1.X/emissions/booklets Создать выпуск буклетов. | - emission (required) | |
| + POST | + /v1.X/CallCenter/CancelBeginRegistration Отмены начатой регистрации Клиента. | + model (required) | |
| GET | /v1.X/Cards/byParams Возвращает список карт по параметрам. | + emissionId (integer) | |
| + POST | + /v1.X/Cards/{cardId}/Block Блокирует карту. | + cardId (integer) (required) + reason (string) | |
| + POST | + /v1.X/Cards/{cardId}/Unblock Разблокирует карту. | + cardId (integer) (required) + password (string) (required) + reason (string) | |
| GET | /v1.X/emissions/cards Возвращает список выпусков карт. | - filter.activationType (boolean) | |
| + POST | + /v1.X/emissions/cards Обновляет информацию о выпуске карт. | + model (required) | |
| + GET | + /v1.X/Cards/BatchPack/{batchId} Возвращает информацию о пакете фасованных карт. | + batchId (integer) (required) | |
| + GET | + /v1.X/Cards/BatchPack/{id}/operations Возвращает список операций пакета фасованных карт. | + id (integer) (required) + state (string) + from (integer) + count (integer) | |
| + POST | + /v1.X/Cards/BatchPack Фасует и привязывает карты пакетно. | + file (file) (required) | |
| GET | /v1.X/communicationOffers/{id}/availableMerchantInfos Возвращает список магазинов, доступных для таргетированного контента. | - filter.сategoryID (integer) | + filter.сategoryId (integer) |
| + GET | + /v1.X/configurations/ui Возвращает список настроек АРМ. | ||
| + GET | + /v1.X/emissions/coupons/{id}/progress Получить информацию по фоновому процессу создания купонов для указанной очереди. | + id (integer) (required) | |
| GET | /v1.X/emissions/coupons Возвращает список существующих выпусков купонов. | + filter.isDynamic (boolean) | |
| + PUT | + /v1.X/coupons/enqueueByEmission/{emissionId} Переводит созданные купоны в состояние "В очереди на выдачу" и возвращает номера купонов. | + emissionId (integer) (required) + count (integer) | |
| + POST | + /v1.X/coupons/link/batch Выполняет пакетную привязку купонов клиентам. | + emissionUid (string) (required) + couponLinks (array) (required) | |
| POST | /v1.X/users Возвращает список клиентов. | + properties (array) | |
| + GET | + /v1.X/customers/code/{code}/attributes/{attributeLogicalName} Возвращает значение атрибута по номеру карты или телефона клиента. | + code (string) (required) + attributeLogicalName (string) (required) | |
| + GET | + /v1.X/customers/code/{code}/attributes Возвращает список значений атрибутов по номеру карты или телефона клиента. | + code (string) (required) + filter.from (integer) + filter.count (integer) + filter.attributeName (string) + filter.logicalName (string) | |
| + GET | + /v1.X/users/{personId}/attributesValues Возвращает список значений атрибутов клиента. | + personId (integer) (required) + filter.from (integer) + filter.count (integer) + filter.attributeName (string) + filter.logicalName (string) | |
| + GET | + /v1.X/Devices Возвращает кассы, доступные пользователю АРМ. | + deviceTypeId (integer) | |
| + GET | + /v1.X/deviceEmulation/purchases Возвращает информацию о покупках. | - from (integer) | + docId (integer) + getNextPage (boolean) |
| GET | - /v1.X/deviceEmulation/devices/{deviceID} | - deviceID (integer) | + deviceId (integer) |
| + /v1.X/deviceEmulation/devices/{deviceId} Возвращает информацию о кассе по внутреннему идентификатору. | |||
| + GET | + /v1.X/Filters/FiltersTree Возвращает список доступных фильтров для заданного типа сущности. | + getFiltersTreeModel.offerId (integer) + getFiltersTreeModel.offerVersion (string) + getFiltersTreeModel.chainId (integer) + getFiltersTreeModel.filterDestinationType (string) + getFiltersTreeModel.eventType (string) + getFiltersTreeModel.exclusionType (string) | |
| + GET | + /v1.X/History/{purchaseUid} Получить записи из истории. | + purchaseUid (string) (required) | |
| GET | /v1.X/LoyaltyPrograms Возвращает список Программ лояльности. | + filter.onlyCommonForPartners (boolean) | |
| + GET | + /v1.X/notifyTemplates Возвращает список шаблонов уведомлений. | + requestModel.applicationFilter.getAll (boolean) + requestModel.applicationFilter.applicationId (integer) | |
| + GET | + /v1.X/offers/GetChanges Возвращает список изменений в акции по сравнению с предыдущей версией. | + getOfferVersionChangesModel.versionId (integer) + getOfferVersionChangesModel.viewMode (string) | |
| GET | /v1.X/offers/AvailablePartners Возвращает список Партнеров. | + loyaltyProgramId (integer) + sortingIds (integer) | |
| - GET | - /v1.X/operationPay Информация какими способами оплачена покупка. | - purchaseId (integer) (required) | |
| GET | /v1.X/partners/{partnerId}/devices Возвращает список касс Партнера с детальной информацией. | + deviceTypeId (integer) | |
| GET | /v1.X/partners/{partnerId}/deviceInfo Возвращает список касс Партнера. | + deviceTypeId (integer) | |
| - GET | - /v1.X/purchases/{purchaseId}/operations Получить список операций по покупке. | - purchaseId (integer) (required) | |
| + GET | + /v1.X/purchases/History/{purchaseId} Возвращает информацию о покупке из истории. | + purchaseId (integer) (required) + withCoupons (boolean) | |
| - GET | - /v1.X/purchases/{purchaseId}/chequePositions Получить чековые позиции по покупке. | - purchaseId (integer) (required) - showCanceledOperations (boolean) | |
| + GET | + /v1.X/purchases/{purchaseId}/details Получить список операций, чековых позиций и описание типа оплаты по покупке. | + purchaseId (integer) (required) + showCanceledOperations (boolean) | |
| + POST | + /v1.X/purchases/count Возвращает количество покупок, согласно условиям из фильтра. | + filter (required) | |
| GET | /v1.X/SystemUsers Возвращает список всех пользователей. | + isDeleted (boolean) | |
| POST | /v1.X/SystemUsers/{id}/ChangePassword Обновляет пароль пользователя. | - changePasswordModel (required) | + changeUserPasswordModel (required) |
| + POST | + /v1.X/auth/session/terminate Завершение сессии отложенное на 5 секунд. | + token (string) (required) | |
| + DELETE | + /v1.X/auth/session Завершение сессии текущего пользователя. | ||
| + PATCH | + /v1.X/auth/session Отмена отложенного завершения сессии. | ||
| + POST | + /v1.X/auth/AuthenticationCodes Верификация по коду аутентификации. | + authenticationCode (string) (required) | |
| + POST | + /v1.X/auth/logout Завершение сессии текущего клиента. | ||
| + GET | + /v1.2/users/code/{identifier}/cards/{cardNumber}/qrcode Генерирует QR-код для карты клиента по номеру карты (OAuth). | + identifier (string) (required) + cardNumber (string) (required) + isConvertToServerTimeNeeded (boolean) | |
| + GET | + /v1.2/customers/{personId}/attributes Возвращает список значений атрибутов клиента. | + filter.logicalName (string) | |
| + GET | + /v1.2/purchases/{purchaseId}/chequeSum Получить сумму чека с учетом скидок для покупки. | + purchaseId (integer) (required) |