ShGetCorrs

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

В SH Pro нет групп корреспондентов, поэтому создаются три статических группы: «Юридические лица», «Физические лица» и «Спец. корреспонденты». В эти группы помещаются все корреспонденты в соответствии с их типом.

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

{
  "taskType": "ShGetCorrs",
  "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":"ShGetCorrs",
      "objectId": number
   },
   "error":{ 
      "wsError":{ 
         "code":"string",
         "desc":"string"
      }
   }
}

CODE

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

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

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

CODE

Параметр	Тип параметра	Обязательный	Описание
corrGroups	array
rid	int		rid группы корреспондентов
name	string		Название группы корреспондентов
parent	int?		rid группы корреспондентов, в которую вложена текущая (если корневая группа, то возвращается пустая строка). В SH Pro не заполняется
corrs	array
rid	int		rid корреспондента
type	int		1 - юр.лицо; 2 - физ.лицо; 3 - спец.корр;
attributes			В SH Pro эта группа тэгов всегда возвращается пустой
name	string		Название атрибута
value	string		Значение атрибута
kppList	array	-	Список КПП корреспондента (поставщика)
rid	int	+	rid КПП
kpp	string	+	Значение КПП, чаще всего 9 символов
isDefault	boolean	-	Значение по умолчанию
error	string enum		Контейнер ошибок, см. в статье