Передача пакета сведений об аннулировании извещений о принятии к распоряжения к исполнению

Атрибут	Значение
Название	zhkh-smev2-import-cancellation
Тип	Адаптер для сервиса СМЭВ 2
Наименование 1	Передача пакета сведений об аннулировании извещений о принятии к распоряжения к исполнению
Наименование 2	Сведения о внесении платы кредитными организациями
Мнемоника	MNSV10KOSVED
Версия	1.10
Версия МР	2.5.x
Версия СМЭВ	СМЭВ2

Переменные окружения

Название	Описание
CA_CERT	сертификат центра сертификации для подключения к rabbitmq
CLIENT_CERT	сертификат, используемый для подключения к rabbitmq
CLIENT_KEY	ключ, используемый для подключения к rabbitmq
SMEV_KEY	Ключ СМЭВ 2 для режима экспорта ключа
SMEV_CERT	Сертификат СМЭВ 2 для режима экспорта ключа
CRYPTO_PROVIDER	Способ подписания (cryptopro/trojan/openssl)
CRYPTOPRO_KPS	Имя сертификата для поиска для режима КриптоПРО
CRYPTOPRO_PIN	Пин доступа к токену для режима КриптоПРО
SIGNER_URL	Адрес сервиса подписания для режима trojan
SIGNER_SRV_CERT	Сертификат сервиса подписания
SIGNER_CLIENT_CERT	Сертификат для подключения к сервису подписания
SIGNER_CLIENT_KEY	Ключ для подключения к сервису подписания

Переменные для конфигурирования подключения к БД:

DATABASE_HOST, DATABASE_PORT, DATABASE_NAME, DATABASE_USER, DATABASE_PASS.

Принимаемые параметры

Параметр	Название	Обязательное	Пример
organization_id	Идентификатор организации, через которую производится внесение платы, присвоенный данной организации в системе	+	c901756b-40c7-41dc-85c2-f95bbd15b5b6
cancellations	Пакет данных об отмене извещений	+	Набор составных элементов Cancellation

Структура элемента Cancellation

Параметр	Название	Обязательное	Пример
order_id	Уникальный идентификатор распоряжения	+	10475017799000003006201614682555
date	Дата аннулирования	+	2020-02-01
comment	Комментарий	-	Тест
transport_id	Транспортный идентификатор	+	b6abd0bd-d7af-4b87-9ff4-9eade9a89f05

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

Сервис возвращает последовательность элементов вида:

Параметр	Название	Обязательное	Пример
TransportID	Транспортный идентификатор	+	fe3e9fc1-7b64-47f1-a7d9-5755cd662086
Description	Описание результата выполнения	-	При добавлении извещения произошла ошибка
ErrorMessage	Ошибка	-¹	Составной элемент Error
UpdateDate	Дата модификации	-¹	2020-02-14T12:56:50.570+03:00

1 - должен присутствовать один из элементов

Структура элемента Error

Параметр	Название	Обязательное	Пример
ErrorCode	Код ошибки	+	SRV012001
Description	Описание ошибки	+	Документ «Извещение о принятии к исполнению распоряжения» ранее размещен в системе: Уникальный номер платежа (идентификатор операции): 10475017799000003006201614682552; Дата внесения платы: 12.02.2020.
StackTrace	Отладочная информация в случае возникновения исключения	-

Примеры

Для проверки настройки сервиса можно отправить в консоли отправки панели администрирования следующий запрос:

{
  "organization_id": "c901756b-40c7-41dc-85c2-f95bbd15b5b6",
  "cancellations": [
    {
      "order_id": "00000000000000000000000000007777",
      "date": "2020-02-17",
      "comment": "Тест",
      "transport_id": "f28d6455-e3a7-4fb8-9d44-74dc94cd64fd"
    },
    {
      "order_id": "10475017799000003006201614682555",
      "date": "2020-02-17",
      "comment": "Тест",
      "transport_id": "2824fa31-48c7-44f7-bbd7-7aa4a568617a"
    }
  ]
}

В случае корректной настройки должен прийти ответ вида:

[
  {
    "TransportID": "f28d6455-e3a7-4fb8-9d44-74dc94cd64fd",
    "UpdateDate": "2020-02-17T14:00:57.278+03:00",
    "Description": "Операция завершилась успешно"
  },
  {
    "TransportID": "2824fa31-48c7-44f7-bbd7-7aa4a568617a",
    "UpdateDate": "2020-02-17T14:00:59.203+03:00",
    "Description": "Операция завершилась успешно"
  }
]

В случае возникновения ошибок можно получить ответ вида:

[
  {
    "TransportID": "f28d6455-e3a7-4fb8-9d44-74dc94cd64fd",
    "ErrorMessage": {
      "ErrorCode": "SRV012003",
      "Description": "По указанному уникальному номеру платежа (идентификатору операции) 00000000000000000000000000007777 в системе не найдено аннулируемое извещение."
    },
    "Description": "При выполнении операции произошла ошибка"
  },
  {
    "TransportID": "2824fa31-48c7-44f7-bbd7-7aa4a568617a",
    "ErrorMessage": {
      "ErrorCode": "SRV012003",
      "Description": "По указанному уникальному номеру платежа (идентификатору операции) 10475017799000003006201614682555 в системе не найдено аннулируемое извещение."
    },
    "Description": "При выполнении операции произошла ошибка"
  }
]