GetSbisObject (API3)

Полное имя метода: 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 объектов.

Если объект не получен в следствие ошибки, в массиве будет присутствовать описание ошибки. Пример результата для объекта Склад:

[
    {
        "ИдСБИС": "11234",
        "ИмяСБИС": "Склад",
        "Название": "Склад на Витебской",
    },
    {
        "ИдСБИС": "11235",
        "error": {
            "message": "Ошибка чтения объекта.",
            "code": "100",
            "detail": "Ошибка чтения объекта. Возможно он был удален.",
            "action": "Склад.get_sbis_object",
            "stack": []
        }
    }
]

В случае ошибки (не ошибки получения объекта, указанной выше), метод возвращает словарь.

result: {
    error: {
        action: "API3.GetSbisObject",
        code: 100,
        detail: "",
        message: "Выгрузка данного типа объекта не поддерживается",
        stack: [...]
    }
}

Структуру API3 объекта с описание обязательных и не обязательных полей можно посмотреть в соответствующем разделе.