Различия

Здесь показаны различия между двумя версиями данной страницы.

--- doc:dev:api:manufacturer [16.12.2016 20:02]
asonkin
+++ doc:dev:api:manufacturer [02.06.2018 10:42] (текущий)
@@ Строка 1: / Строка 1: @@
 ====== API :: Manufacturer. Получение/изменение данных о производителях ======
-В системе реализован программный интерфейс для получения, добавления, изменения и удаления производителей. Данные выгружаются по http протоколу. Формат на выбор - xml или json.
+В системе реализован программный интерфейс для получения, добавления, изменения и удаления производителей. Данные выгружаются по http протоколу. Формат на выбор - XML или JSON.
@@ Строка 10: / Строка 10: @@
  http://mycompany.virtpos.ru/api/manufacturer?apikey=MySecret&format=xml
 ==== Параметры запроса ====
+параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** - код производителя, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех производителях.
+  * **id** (get only) - код производителя, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех производителях.
@@ Строка 32: / Строка 32: @@
 <root>
    <success>1</success>
-   <type>item_group</type>
+   <type>manufacturer</type>
    <count>2</count>
    <manufacturers>
@@ Строка 57: / Строка 57: @@
 ==== Параметры запроса ====
+параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** - код товарной группы, данные которой надо обновить
+  * **id** (get only) - код производителя, данные которого нужно обновить
-  * **create_if_not_exist** - Если истина, то при неудачном поиске производитель будет добавлен в систему.
+  * **create_if_not_exist** (get only) - Если истина, то при неудачном поиске производитель будет добавлен в систему.
   * Также в качестве параметров могут быть переданы все поля для производителя, на данный момент это только name
@@ Строка 89: / Строка 89: @@
 </file>
+===== Пример запроса на удаление данных =====
+Пример запроса на удаление производителя:
+ http://mycompany.virtpos.ru/api/manufacturer/delete/?apikey=MySecret&format=xml&id=1
+==== Параметры запроса ====
+параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
+  * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **id** (get only) - код производителя который будет удален
+==== Ответ сервера ====
+В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info.
+Также возвращается id записи, которая была удалена.
+==== Пример ответа сервера ====
+<file xml>
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+   <success>1</success>
+   <id>1</id>
+</root>
+</file>