r_keeper

События кассы

Важно! Функционал доступен при работе с агентом второй версии.
1
Подписка на события
2
Отписаться от события
3
Список подписок

Подписка на события

Чтобы подписаться на события требуется выполнить команду SubscribeToEvents
// Формат запроса
{
   "taskType":"SubscribeToEvents",
   "params":{
      "sync":{
         "objectId":0
      },
      "events":[
         "OrderCanceled",
         "OrderChanged",
         "OrderCompleted",
         "OrderCreated"
      ]
   }
}
// Формат ответа
{ 
   "responseCommon":{ 
      "taskGuid":"guid",
      "taskType":"SubscribeEvents",
      "objectId":0
   }
}

// Формат ответа с ошибкой
{ 
   "responseCommon":{ 
      "taskGuid":"guid",
      "taskType":"SubscribeEvents",
      "objectId":0
   },
   "error":{ 
      "wsError":{ 
         "code":"string",
         "desc":"string"
      }
   }
}
Получение событий

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

Отписаться от события

Чтобы отписаться от события требуется выполнить команду UnSubscribeToEvents
// Формат запроса
{
   "taskType":"UnSubscribeToEvents",
   "params":{
      "sync":{
         "objectId":0
      },
      "events":[
         "OrderCanceled",
         "OrderChanged",
         "OrderCompleted",
         "OrderCreated"
      ]
   }
}
// Формат ответа
{ 
   "responseCommon":{ 
      "taskGuid":"guid",
      "taskType":"UnSubscribeToEvents",
      "objectId":0
   }
}

// Формат ответа с ошибкой
{ 
   "responseCommon":{ 
      "taskGuid":"guid",
      "taskType":"UnSubscribeToEvents",
      "objectId":0
   },
   "error":{ 
      "wsError":{ 
         "code":"string",
         "desc":"string"
      }
   }
}

Получить список подписок

Получить список текущих подписок можно с помощью команды GetListOfSubscriptions
// Формат запроса
{
   "taskType":"GetListOfSubscriptions",
   "params":{
      "sync":{
         "objectId": 0
      }
   }
}
// Формат ответа
{ 
   "responseCommon":{
      "taskGuid":"guid",
      "taskType":"GetListOfSubscriptions",
      "objectId": 0
   },
   "taskResponse":{
      "events":[
         "OrderCanceled",
         "OrderChanged",
         "OrderCompleted",
         "OrderCreated"
      ]
   }
}

// Формат ответа с ошибкой
{ 
   "responseCommon":{ 
      "taskGuid":"guid",
      "taskType":"GetListOfSubscriptions",
      "objectId":0
   },
   "error":{ 
      "wsError":{ 
         "code":"string",
         "desc":"string"
      }
   }
}