Различия

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

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
doc:dev:api:supplier [28.06.2017 14:54]
dchuprunov [Структура ответа сервера]
doc:dev:api:supplier [02.06.2018 10:42] (текущий)
Строка 11: Строка 11:
  
 ==== Параметры запроса ==== ==== Параметры запроса ====
 +Параметры,​ которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
  
-  * **format** - формат,​ в котором сервер отдаст данные. Может принимать значения "​xml"​ или "​json"​. Необязательный параметр.+  * **format** ​(get only) - формат,​ в котором сервер отдаст данные. Может принимать значения "​xml"​ или "​json"​. Необязательный параметр.
  
   * **id** - идентификатор поставщика,​ для которого надо вернуть данные. Если не указан,​ то возвращаются данные обо всех поставщиках.   * **id** - идентификатор поставщика,​ для которого надо вернуть данные. Если не указан,​ то возвращаются данные обо всех поставщиках.
Строка 132: Строка 132:
  
  
-  * **id** – ID поставщика+  * **id** – ID поставщика ​- //int NOT NULL, первичный ключ//
  
-  * **name** - Название+  * **name** - Название ​- //​varchar(255) NOT NULL, обязательно//​
  
-  * **legal_name** - Юридическое название+  * **legal_name** - Юридическое название ​- //​varchar(255) DEFAULT NULL//
  
-  * **inn** - ИНН+  * **inn** - ИНН ​- //​varchar(255) DEFAULT NULL//
  
-  * **kpp** - КПП+  * **kpp** - КПП ​- //​varchar(255) DEFAULT NULL//
  
-  * **address** - Адрес+  * **address** - Адрес ​- //​varchar(255) DEFAULT NULL//
  
-  * **phone** - Телефон+  * **phone** - Телефон ​- //​varchar(255) DEFAULT NULL//
  
-  * **email** - Адрес электронной почты+  * **email** - Адрес электронной почты ​- //​varchar(255) DEFAULT NULL, валидный e-mail адрес//​
  
-  * **www** - WWW+  * **www** - WWW - //​varchar(255) DEFAULT NULL, валидный URL//
  
-  * **type_id** - Тип контрагента (1 - Внешний поставщик,​ 2 - Внутренний поставщик,​ 3 - Банк)+  * **type_id** - Тип контрагента (1 - Внешний поставщик,​ 2 - Внутренний поставщик,​ 3 - Банк) ​- //int NOT NULL DEFAULT '​1'//​
  
-  * **type_name** - наименование типа контрагента+  * **type_name** - наименование типа контрагента ​- //​varchar(255) DEFAULT NULL//
  
-  * **code** - Код контрагента+  * **code** - Код контрагента ​- //​varchar(255) DEFAULT NULL//
  
-  * **OKPO** - ОКПО ​+  * **OKPO** - ОКПО ​- //​varchar(30) DEFAULT NULL//
  
-  * **OKONH** - ОКОНХ+  * **OKONH** - ОКОНХ ​- //​varchar(255) DEFAULT NULL//
  
-  * **bank_name** - Наименование банка, обслуживающего организацию+  * **bank_name** - Наименование банка, обслуживающего организацию ​- //​varchar(255) DEFAULT NULL//
  
-  * **corraccount** - Номер счета банка, обслуживающего организацию+  * **corraccount** - Номер счета банка, обслуживающего организацию ​- //​varchar(255) DEFAULT NULL//
  
-  * **bankaccount** - Номер счета организации в банке, обслуживающем организацию+  * **bankaccount** - Номер счета организации в банке, обслуживающем организацию ​- //​varchar(255) DEFAULT NULL//
  
-  * **BIK** - БИК+  * **BIK** - БИК ​- //char(9) DEFAULT NULL, 9 символов ровно//​
  
-  * **status** - Статус+  * **status** - Статус ​- //​varchar(255) DEFAULT NULL//
  
-  * **delivaddress** - Факт. адрес+  * **delivaddress** - Факт. адрес ​- //​varchar(255) DEFAULT NULL//
  
-  * **external_id** - Идентификатор во внешней системе+  * **external_id** - Идентификатор во внешней системе ​- //​varchar(255) DEFAULT NULL//
  
-  * **created_date** - Дата создания+  * **created_date** - Дата создания ​- //datetime DEFAULT NULL//
  
-  * **created_by** - Кем создано+  * **created_by** - Кем создано ​- //int DEFAULT NULL//
  
-  * **last_update_date** - Дата изменения+  * **last_update_date** - Дата изменения ​- //datetime DEFAULT NULL// 
 + 
 +  * **last_update_by** - Кем изменено - //int DEFAULT NULL//
  
-  * **last_update_by** - Кем изменено 
 ===== Пример запроса на добавление/​изменение данных ===== ===== Пример запроса на добавление/​изменение данных =====
  
Строка 188: Строка 189:
  
 ==== Параметры запроса ==== ==== Параметры запроса ====
 +Параметры,​ которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
  
-  * **format** - формат,​ в котором сервер отдаст данные. Может принимать значения "​xml"​ или "​json"​. Необязательный параметр.+  * **format** ​(get only) - формат,​ в котором сервер отдаст данные. Может принимать значения "​xml"​ или "​json"​. Необязательный параметр.
  
-  * **id** - идентификатор поставщика,​ данные которого надо обновить+  * **id** ​(get only) - идентификатор поставщика,​ данные которого надо обновить
  
-  * **external_id** - код поставщика во внешней системе учета (например,​ в 1С)+  * **external_id** ​(get only) - код поставщика во внешней системе учета (например,​ в 1С)
  
-  * **create_if_not_exist** - Если истина,​ то при неудачном поиске поставщик будет добавлен в систему.+  * **create_if_not_exist** ​(get only) - Если истина,​ то при неудачном поиске поставщик будет добавлен в систему.
    
   * Также в качестве параметров могут быть переданы все поля для поставщика (name, address, phone и т.д.)   * Также в качестве параметров могут быть переданы все поля для поставщика (name, address, phone и т.д.)