Различия

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

--- napoleonapi [2025/11/20 11:36] – salnikov
+++ napoleonapi [2025/11/20 12:15] (текущий) – [Stores — склады] salnikov
@@ Строка 5: / Строка 5: @@
-====Работа через API====
+=====Работа через API=====
 Подключение к серверу происходит по http протоколу через порт сервера.
-===Заголовки запроса:===
+====Заголовки запроса:====
 Content-Type: application/json
@@ Строка 21: / Строка 21: @@
 http://127.0.0.1:8888/object/Agents
-===Стандартный ответ===
+====Стандартный ответ====
 Ответ сервера содержит массив объектов. Объект содержит имя и массив данных.
 //Answer = [<StdObject>]
 StdObject = {"name":<ObjectName>,"data":[<DataObject>]}//
@@ Строка 31: / Строка 33: @@
 Поля даты/времени передается в строковом виде 20221113184531
 Сервер всегда возвращает объект ServerAnswer
-{"response":<Response>,"message":<Message>}
-Response	1 - операция успешна
+//{"response":<Response>,"message":<Message>}//
-- ошибка
-Message	Описание ошибки
+|Response	|1 - операция успешна, 0 - ошибка|
+|Message	|Описание ошибки|
 ===/object/<ObjectName>[?filter] methods GET, DELETE===
@@ Строка 93: / Строка 97: @@
 |200|Стандартный ответ.ServerAnswer|
-====Объекты обмена====
-===Agents — список ТП===
+----
-Торговые представители
+=====Объекты обмена=====
+====Agents — список ТП====
+Мобильные пользователи (Торговые представители)
 **Поля**
@@ Строка 104: / Строка 112: @@
 |name|Varchar|ФИО|
-**ServerConfig — настройки программы**
+====ServerConfig — настройки программы====
 Настройки работы программ. Настройки для работы берутся по коду торгового представителя, или общие (поле userid пустое). Индивидуальные настройки ТП имеют приоритет над общими.
@@ Строка 115: / Строка 123: @@
 |value|Varchar|Значение|
-**Ключи настроек**
+====Ключи настроек====
 ^Название	^Тип	^Описание^
@@ Строка 121: / Строка 129: @@
 |ДатаДоставки|0;1;2|Установка даты доставки при создании заказа.0 — дата доставки сегодня; 1 — дата доставки завтра; 2 — дата доставки следующий рабочий день|
-**Orgs — торговые точки**
+====Orgs — торговые точки====
 Торговые точки
 ^Название	^Тип	^Описание^
-|id|Varchar|Код ТТ|
+|id|Varchar|Код ТТ. Торговая точка - это адрес доставки когнтрагента, должен содержать уникальный ID, например: <код контрагента>@<код адреса>|
 |name|Varchar|Наименование|
 |address|Varchar|Адрес|
@@ Строка 134: / Строка 142: @@
 |name|Varchar|Наименование договора|
 |id|Varchar|Код договора|
-|orgId|Varchar|Код организации|
+|orgId|Varchar|Код организации - поставщика|
 |priceId|Varchar|Код вида цены|
-**AgentData — доступные объекты для ТП**
+====AgentData — доступные объекты для ТП====
 Содержит данные по доступным объектам агента из общего списка.
@@ Строка 147: / Строка 155: @@
 |type|Varchar|Тип объекта; Org – торговые точки; Price — товары; PriceType – виды цен|
-**AgentStoreData — доступные склады для ТП**
+====AgentStoreData — доступные склады для ТП====
 Содержит данные по складам для агентов. Порядок следования складов определяется порядком следования складов при записи коллекции.
@@ Строка 154: / Строка 162: @@
 ^Название	^Тип	^Описание^
-|id|Varchar|Код объекта|
+|id|Varchar|Код объекта (склада)|
 |userid|Varchar|Код ТП|
-**Folder — папки товаров**
+====Folder — папки товаров====
 Содержит иерархический список папок товаров
@@ Строка 163: / Строка 172: @@
 ^Название	^Тип	^Описание^
-|id|Varchar|Код|
+|id|Varchar|Код товарной группы (папки товара)|
 |name|Varchar|Наименование|
-**StoreQty — остатки товаров по складам**
+====Stores — склады====
+Содержит список складов.
+**Поля**
+^Название	^Тип	^Описание^
+|id|Varchar	|Код склада|
+|name|Varchar	|Наименование|
+====StoreQty — остатки товаров по складам====
 Содержит список остатки товаров на складах. Запись имеет метку версии. Каждый раз при выгрузке данных версию необходимо изменить, а после выгрузки данных, удалить предыдущие версии данных.
@@ Строка 177: / Строка 196: @@
 |version|int|версия|
-**Price — товары**
+====Price — товары====
 Список товаров
 ^Название	^Тип	^Описание^
-|id|Varchar|Код|
+|id|Varchar|Код товара|
 |name|Varchar|Наименование|
 |fid|Varchar|Код папки товара|
@@ Строка 192: / Строка 211: @@
 |inpack|float|Множитель упаковки|
-**PriceCost — цены на товары**
+====PriceCost — цены на товары====
 Содержит цены для товаров по разным видам цен. Запись имеет метку версии. Каждый раз при выгрузке данных версию необходимо изменить, а после выгрузки данных, удалить предыдущие версии данных.
@@ Строка 204: / Строка 223: @@
 |version|int|версия|
-**PriceType — виды цен**
+====PriceType — виды цен====
 Список видов цен
 ^Название	^Тип	^Описание^
-|id|Varchar|Код|
+|id|Varchar|Код вида цены|
 |name|Varchar|Наименование|
-**Firm — организации**
+====Firm — организации====
-Список организаций
+Список организаций от которых идет поставка в торговые точки
 ^Название	^Тип	^Описание^
-|id|Varchar|Код|
+|id|Varchar|Код организации-поставщика|
 |name|Varchar|Наименование|
-**Balance — долги торговых точек**
+====Balance — долги торговых точек====
 Список долгов по торговым точкам
@@ Строка 238: / Строка 257: @@
 |title|Varchar|Заголовок документа в списке долгов|
-**Delivery — отгрузки**
+====Delivery — отгрузки====
 Список отгрузок по торговым точкам
@@ Строка 253: / Строка 272: @@
 |sum|float|Сумма по строке|
-**NewOrders — список новых заказов**
+====NewOrders — список новых заказов====
 Список заказов. Документ появляется в этом списке если его дата создания не старше 3 дней от текущей даты и его нет в таблице
@@ Строка 272: / Строка 291: @@
 |cost|float|Цена|
-**NewIncass — список новых инкассаций**
+====NewIncass — список новых инкассаций====
 Список новый инкассаций. Документ появляется в этом списке если его дата создания не старше 3 дней от текущей даты и его нет в таблице OrderCommitted
@@ Строка 289: / Строка 308: @@
 |uid|Varchar|Уникальный идентификатор отгрузки|
-**OrderCommitted — информация об обработке документа**
+====OrderCommitted — информация об обработке документа====
 Содержит связь между созданным в программе документом и документом в 1с
@@ Строка 300: / Строка 319: @@
 |date|Date|Дата документа в 1с|
-**OrderProceeded — инофрмация об обработанных документах для торгового представителя**
+====OrderProceeded — инофрмация об обработанных документах для торгового представителя====
 Информация передается в мобильную программу и удаляется из этой таблицы.