Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
doc:dev:api:manufacturer [19.12.2016 12:30] asonkin |
doc:dev:api:manufacturer [02.06.2018 10:42] (текущий) |
||
|---|---|---|---|
| Строка 10: | Строка 10: | ||
| http://mycompany.virtpos.ru/api/manufacturer?apikey=MySecret&format=xml | http://mycompany.virtpos.ru/api/manufacturer?apikey=MySecret&format=xml | ||
| ==== Параметры запроса ==== | ==== Параметры запроса ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| - | * **id** - код производителя, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех производителях. | + | * **id** (get only) - код производителя, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех производителях. |
| Строка 32: | Строка 32: | ||
| <root> | <root> | ||
| <success>1</success> | <success>1</success> | ||
| - | <type>item_group</type> | + | <type>manufacturer</type> |
| <count>2</count> | <count>2</count> | ||
| <manufacturers> | <manufacturers> | ||
| Строка 57: | Строка 57: | ||
| ==== Параметры запроса ==== | ==== Параметры запроса ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| - | * **id** - код товарной группы, данные которой надо обновить | + | * **id** (get only) - код производителя, данные которого нужно обновить |
| - | * **create_if_not_exist** - Если истина, то при неудачном поиске производитель будет добавлен в систему. | + | * **create_if_not_exist** (get only) - Если истина, то при неудачном поиске производитель будет добавлен в систему. |
| * Также в качестве параметров могут быть переданы все поля для производителя, на данный момент это только name | * Также в качестве параметров могут быть переданы все поля для производителя, на данный момент это только name | ||
| Строка 96: | Строка 96: | ||
| ==== Параметры запроса ==== | ==== Параметры запроса ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| - | * **id** - код товарной группы, данные которой надо обновить | + | * **id** (get only) - код производителя который будет удален |
| Строка 113: | Строка 113: | ||
| ==== Пример ответа сервера ==== | ==== Пример ответа сервера ==== | ||
| + | <file xml> | ||
| <?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| <root> | <root> | ||
| Строка 118: | Строка 119: | ||
| <id>1</id> | <id>1</id> | ||
| </root> | </root> | ||
| + | </file> | ||