ShGetStores

Назначение	Получение списка складов
Тип запроса	Асинхронный
Поддерживаемая версия агента, SH	v1(SH4, SH5), v2(SH5)

В SH5 нет групп складов. Вместо складов используются подразделения. Поэтому создается одна статическая группа – «Подразделения». В эту группу добавляются все подразделения, которые есть в SH5. В SH5 не возвращаются атрибуты склада.

Формат запроса

{
  "taskType": "ShGetStores",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    }
  }
}

CODE

Параметр	Тип	Обязательный	Описание
taskType	string	+	Тип задачи
async			Асинхронный вызов метода (либо синхронный, либо асинхронный)
sync			Синхронный вызов метода (либо синхронный, либо асинхронный)
timeout	int	-	Время ожидания ответа от агента в секундах, по умолчанию 120 секунд
objectId	int	+	Код ресторана в системе лицензирования

Формат ответа

{ 
   "responseCommon":{ 
      "taskGuid": "guid",
      "taskType": "ShGetStores",
      "objectId": number
   },
   "error":{ 
      "wsError":{ 
         "code": "string",
         "desc": "string"
      }
   }
}

CODE

Параметр	Тип	Описание
taskGuid	guid	Уникальный код этой задачи используется при получении задачи через очередь
taskType	string enum	Тип задачи
objectId	int	Код ресторана в системе лицензирования
error		Контейнер ошибок, см Описание ошибок

Формат асинхронного ответа

// Успешный ответ
{
   "taskResponse":{
      "storeGroups":[
         {
            "stores":[
               {
                  "attributes":[
                     {
                        "name": "string",
                        "value":"string"
                     }
                  ],
                  "rid": number,
                  "name": "string",
                  "kppList": [
                      {
                          "rid": number,
                          "kpp": "string",
                          "isDefault": boolean,
                          "isClosed": boolean,
                          "externalCode": "string"
                      }
                  ]               
               }
            ],
            "rid": number,
            "name": "string",
            "parent": "number"
         }
      ]
   },
   "responseCommon":{
      "taskGuid": "string",
      "taskType": "ShGetStores",
      "objectId": number
   }
}
   
// Ответ с ошибкой
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "ShGetStores",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

CODE

Параметр	Тип параметра	Обязательный	Описание
storeGroups	array
rid	int		rid группы складов
name	string		Название группы складов
parent	int?		rid группы складов, в которую вложена текущая (если корневая группа, то возвращается пустая строка)
stores	array
rid	int		rid склада
name	string		Название склада
attributes	array
name	string		Название атрибута
value	string		Значение атрибута
kppList	array	-	Список КПП подразделения (получателя). Значения кэшируются в файл на диске "C:\ProgramData\UCS\WhiteServerAgent\Obj_<objectId>\Cache\shGetStores.kpp.cache.json" Обновляется при старте агента и каждые 60 мин. Подставляются из кэша при выполнении запроса.
rid	int	+	rid КПП
kpp	string	+	Значение КПП, чаще всего 9 символов
isDefault	boolean	-	Значение по умолчанию
isClosed	boolean	-	Значение флага "Закрыт"
externalCode	string	-	Внешний код
error	string enum		Контейнер ошибок, см. Описание ошибок