Описание
Данный шаг был разработан для расширения возможностей взаимодействия Вашего ресурса и нашего основного сайта. У каждого и запрашиваемых Вами товаром есть его характеристики, которые используют данные из справочников. Используя в этом запросе строковый идентификатор характеристики (relation), Вы можете получить все элементы справочника.
Формат запроса
[apirms.ru/techapi/]?[get=reference_items]&[token=ваш_токен]&[referenceName=section]
Параметры запроса
| Параметр | Описание |
|---|---|
| apirms.ru/techapi/ | Путь к ресурсу |
| get=reference_items | Метод получение списка элементов справочника по его строковому идентификатору |
| token=ваш_токен | Токен пользователя |
| referenceName=section | Строковый идентификатор справочника |
Возвращаемые данные
В случае выполнения успешного запроса, возвращается массив с двумя элементами: 'status' со значением 'successful' означающем, что запрашиваемые данные получены и 'result' в котором представлены возвращаемые данные в виде значения или массива 'items' значений, элементы которых представлены в таблице.
| Элемент | Значение |
|---|---|
| id | Идентификатор элемента справочника |
| name | Наименование элемента справочника |
Возвращаемые ошибки
В случае не удачного выполнения запроса, возвращается массив с двумя элементами: 'status' со значение 'error' означающем, что запрашиваемые данные не получены и 'result' в котором представлены возвращаемые ошибки в виде массива значений, 'code' - код ошибки и 'message' - текстовое значение ошибки, данные которых представлены в таблице.
| Код | Значение |
|---|---|
| 100 | the name of the reference book is not set |
| 200 | token not found |
| 300 | unknown error |