GetSbisObject (API3) — различия между версиями
([) |
|||
Строка 14: | Строка 14: | ||
==Параметры== | ==Параметры== | ||
− | * Type – тип объекта | + | * Type – тип объекта (строка) |
* IdList - Массив идентификаторов (массив строк) | * IdList - Массив идентификаторов (массив строк) | ||
+ | |||
+ | Пример запроса для объекта Склад: | ||
+ | <source lang="javascript"> | ||
+ | requirejs(['Types/source'], function(blo) { | ||
+ | blo = blo.SbisService; | ||
+ | new blo({ | ||
+ | endpoint: { | ||
+ | contract: 'API3', | ||
+ | address: '/service/' | ||
+ | } | ||
+ | }).call('GetSbisObject', { | ||
+ | 'Type': 'Склад', | ||
+ | 'IdList': ['11234', '11235'] | ||
+ | }) | ||
+ | }); | ||
+ | </source> | ||
==Результат== | ==Результат== |
Текущая версия на 12:30, 10 июля 2020
Полное имя метода: API3.GetSbisObject
Содержание
Описание
Метод получает массив API3 структур объектов СБИС по их типу и списку идентификаторов.
Алгоритм
1. Перебираем список идентификаторов объекта.
2. Получаем данные объекта со СБИС по идентификатору и формируем структуру API3 объекта.
3. Добавляем структуру объекта в массив.
4. Если во время получения объекта возникла ошибка она будет добавлена в массив с указанием идентификатора объекта.
Параметры
- Type – тип объекта (строка)
- IdList - Массив идентификаторов (массив строк)
Пример запроса для объекта Склад:
requirejs(['Types/source'], function(blo) {
blo = blo.SbisService;
new blo({
endpoint: {
contract: 'API3',
address: '/service/'
}
}).call('GetSbisObject', {
'Type': 'Склад',
'IdList': ['11234', '11235']
})
});
Результат
Метод возвращаем массив структур API3 объектов. Если объект не получен в следствии ошибки в массиве будет присутствовать описание ошибки. Структуру API3 объекта с описание обязательных и не обязательных полей можно посмотреть в соответствующем разделе.
Пример результата для объекта Склад:
[
{
"ИдСБИС": "11234",
"ИмяСБИС": "Склад",
"Название": "Склад на Витебской",
},
{
"ИдСБИС": "11235",
"error": {
"message": "Ошибка чтения объекта.",
"code": "100",
"detail": "Ошибка чтения объекта. Возможно он был удален.",
"action": "Склад.get_sbis_object",
"stack": []
}
}
]