GLN¶

Для работы с этим методом пользователь должен быть авторизированным .

Метод позволяет пользователю просматривать дополнительную информацию о других пользователях на уровне одного общего аккаунта.

Метод запроса

HTTP GET

Content-Type

application/json (тело запроса/ответа в json формате в теле HTTP запроса

URL запроса

https://edo-v2.edi-n.com/api/oas/identifiers

Параметры, передаваемые в URL (вместе с адресом метода)

В строке заголовка (Header) «Set-Cookie» обязательно передается SID - токен полученный при авторизации Обязательные url-параметры:

gln - строка(13); номер GLN организации, которая связана с авторизированным пользователем платформы EDIN 2.0 на уровне аккаунта

query - строка; название/ИНН/КПП/GLN организации; «над которым осуществляется действие»

Подсказка

Также возможно выполнить запрос в виде curl-строки:

curl -X GET „https://edo-v2.edi-n.com/api/oas/identifiers?gln=9864065702429&query=EDS_1“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“

Спецификация для расшифровки ключей curl запроса: https://curl.haxx.se/docs/manpage.html

JSON-параметры в теле HTTP запроса/ответа

REQUEST

В этом методе json-тело запроса отсутствует (другие данные передавать не нужно).

RESPONSE

Таблица 1 - Описание json-параметров, которые могут передаваться в ответ на метод API

Параметр	Формат	Описание
	Объект Identificator
guid	String	GUID организации
taxNum	String	Налоговый идентификационный номер; строка 50 символов
ndsNum	String	№ свидетельства НДС; строка 50 символов
manager	String	ФИО менеджера; строка 100 символов
accountant	String	ФИО бухгалтера; строка 100 символов
id	long	ID пользователя
gln	String	GLN организации, которая связана с авторизированным пользователем? ; строка 13 символов
companyId	long	id аккаунта; число
retailerId	long	id сети (ритейлера); число
name	String	название организации; строка 100 символов
companyType	String	форма собственности; строка 5 символов; jur - Юридическое лицо, fiz - Физическое лицо
companyInn	String	код ИНН компании; строка 50 символов
companyKpp	String	код ЕГРПОУ/КПП; строка 50 символов
companyOgrn	String	Основной Государственный Регистрационный Номер; строка 15 символов
companyTaxDepartmentID	String	идентификатор отделения налоговой инспекции
dirLastName	String	фамилия директора; строка 150 символов
dirFirstName	String	имя директора; строка 150 символов
apartment	String	квартира; строка 20 символов
zip	String	почтовый индекс; строка 20 символов
city	String	город; строка 50 символов
street	String	название улицы; строка 100 символов
regionCode	String	код региона; строка 3 символа
bankName	String	название банка; строка 100 символов
bankMfo	String	МФО банка, код-реквизит банка
phone	String	№ телефона; строка 50 символов
bankAccount	String	расчетный счет банка; строка 50 символов
otherInfo	String	комментарии
email	String	E-mail; строка 255 символов
metroCode	String	код точки доставки; строка 20 символов

Таблица 2 - Описание параметров объекта Account)

Параметр	Формат	Описание
	Объект Account
platform	enum	признак принадлежности к платформе EVO / FELEX
id	int	id аккаунта; число 11 символов
name	String	полное наименование организации или ФИО индивидуального предпринимателя
ownership	String	форма собственности; строка 5 символов; jur - Юридическое лицо, fiz - Физическое лицо
inn	String	код ИНН; строка 50 символов
kpp	String	код ЕГРПОУ/КПП; строка 50 символов
mail	String	почта
phone	String	№ телефона; строка 50 символов
ndsNumber	String	№ свидетельства НДС; строка 50 символов
bankAccount	String	расчетный счет банка; строка 50 символов
bankName	String	название банка; строка 100 символов
bankMfo	String	МФО банка, код-реквизит банка
bankAddress	String	адрес банка; строка 150 символов
identificators	List<Identificator>	массив объектов;
companies	List<Company>	массив объектов;
users	List<User>	массив объектов;

Таблица 3 - Описание параметров объекта Company)

	Объект Company
id	long	id компании; число
account	Account	объект; данные аккаунта
name	String	полное наименование организации или ФИО индивидуального предпринимателя
ownership	String	форма собственности; строка 5 символов; jur - Юридическое лицо, fiz - Физическое лицо
edrpou	String	код ЕГРПОУ/КПП; строка 50 символов
inn	String	код ИНН; строка 50 символов
mail	String	почта
phone	String	№ телефона; строка 50 символов
ndsNumber	String	№ свидетельства НДС; строка 50 символов
bankAccount	String	расчетный счет банка; строка 50 символов
bankName	String	название банка; строка 100 символов
bankMfo	String	МФО банка, код-реквизит банка
bankAddress	String	адрес банка; строка 150 символов
users	List<User>	массив объектов;

Таблица 4 - Описание параметров объекта User)

Параметр	Формат	Описание
	Объект User
id	long	id пользователя; число
accountId	long	id аккаунта
login	String	логин пользователя; строка 50 символов
stringEmails	String	E-mail; строка 255 символов
emails	List<String>	массив адресов E-mail
blocked	int	отметка о блокировке; число; 0 - нет, 1 - да
allowFTP	int	отметка доступа к FTP; число; 0 - нет, 1 - да
autoSending	boolean	автоотправка; число; 0 - Нет, 1 - Да (документы автоматически отправляются при переносе документа для отправки в папку outbox)
statusFile	int	создание статус-файлов; число; 0 - Нет, 1 - Да, 2 - Да, о доставке, 3 - Да, о прочтении
isAdmin	boolean	отметка, является ли пользователь админом в управление пользователями; число; 0 - нет, 1 - да

Примеры

Запрос не содержит тела (json)

Пример тела ответа (json):

  [
{
  "guid": {},
  "manager": "#",
  "id": 133187,
  "gln": "9864065702429",
  "companyId": 29824,
  "retailerId": 0,
  "name": "EDS_1",
  "companyType": "jur",
  "companyInn": "1010101010",
  "companyKpp": "90000031",
  "zip": "112233",
  "city": "г. Львов",
  "street": "ул. Хмурится, 6",
  "phone": "#",
  "otherInfo": "[]",
  "account": {
    "platform": "EVO",
    "id": 29824,
    "name": "Test_EDS1",
    "ownership": "#",
    "inn": "1010101010",
    "kpp": "100000001",
    "mail": "test@qw.we",
    "phone": "12345678901",
    "ndsNumber": "#",
    "bankAccount": "#",
    "bankName": "#",
    "bankMfo": "#",
    "bankAddress": "#",
    "identificators": [],
    "companies": [],
    "users": []
  }
}
]