ЗапросНаСервер

Метод (Строка),
Параметры (Структура),
Файлы (Соответствие)

Выполнить запрос к серверу Agenta.

Параметры:

• Метод - метод сервера, например, “getlicences”,
• Параметры - параметры запроса в виде структуры,
• Файлы - файлы для передачи на сервер, передаются как Соответствие (ИмяФайла => ПутьКФайлу).

Возвращает:

В случае ошибки соединения возвращает Ложь, иначе структуру ответа сервера:

Структура:

• success: Истина/Ложь
• data: данные с сервера (строка или структура)
• error: код ошибки
• msg: сообщение (описание ошибки)
• errors: структура ошибок (ключ:значение)

Поле success является флагом успешности выполнения запроса: Истина - все ок, Ложь - возникли ошибки.

Поле data содержит структуру полей ответа, либо строку (в зависимости от метода).

error - содержит строковое id ошибки, в случае неудачного выполненния запроса, например, ‘invalid’ - неверный параметр.

msg - содержит текстовое описание ошибки, например “неверный параметр”

errors - служит уточнением ошибки, какой параметр заполнен неверно, является структурой в виде “поле”: “значение”

Пример:

Агента = Обработки.Agenta.Создать();
Файлы = Новый Соответствие;
Файлы.Вставить("data", ИмяФайлаZIP);
	
Результат = Агента.ЗапросНаСервер("setdata",
	Новый Структура("sid,date", sid, ТекущаяДата()),
	Файлы
);

ПолучитьЛицензии

нет

Получить перечень лицензий. Лицензии возвращаются в виде ТаблицыЗначений, где каждая строка - это лицензия, с полями:

• sid - id лицензии
• Телефон - номер телефона, закрепленного за лицензией
• Активность - признак активности лицензии
• Оплачено - признак оплаты лицензии
• Наименование - наименование лицензии
• Группа - id подразделения
• ГруппаНаименование - наименование подразделения

Параметры:

нет

Возвращает:

В случае ошибки - Ложь, иначе - ТаблицуЗначений (см. описание)

Пример:

Агента = Обработки.Agenta.Создать();
	
//Получаем лицензии, и выгружаем данные для первой
Лицензии = Агента.ПолучитьЛицензии();
	
Если Лицензии <> Ложь Тогда
	Лиц = Лицензии.Получить(1);
	Сообщить("Телефон: " + Лиц.phone);
Иначе
	Сообщить(Агента.ПолучитьОписаниеОшибки());
КонецЕсли;

ПолучитьДокументы

lastupdate (Целое, не обязат.)
group (GUID, не обязат.)

Получить перечень новых и изменившихся документов с момента времени lastupdate.

Документы возвращаются в виде СпискаЗначений, который содержит тексты XML-представлений документов.

Так же, сервер возвращает метку времени, на которую получены документы. Определить ее можно через метод ПолучитьМеткуВремени(). Если в выборке документов не обнаружено, в качестве метки будет возвращено то же самое значение параметра lastupdate.

Параметры:

lastupdate - метка времени в виде числа. Здесь нужно передавать метку, которую возвращает сервер в предыдущем запросе. Если не указывать параметр, сервер вернет все имеющиеся документы

group - id подразделения (GUID), для получения документов только по указанному подразделению. Если не указывать параметр group, выборка будет по всем подразделениям.

Возвращает:

В случае ошибки - Ложь, иначе СписокЗначений (см. выше)

Пример:

Агента = Обработки.Agenta.Создать();
	
//Получаем документы
Доки = Агента.ПолучитьДокументы(135533584841106900);
	
Если Доки <> Ложь Тогда
	Метка = Агента.ПолучитьМеткуВремени(); 
	
	Если Метка <> Неопределено Тогда
		//запоминаем текущую метку времени
		//чтобы использовать ее при следующем запросе
	КонецЕсли;
	...	
	//Обработка документов
	//Доки - это список значений, 
	//где каждое значение - документ в виде XML текста
	...
Иначе
	Сообщить(Агента.ПолучитьОписаниеОшибки());
КонецЕсли;

ВыгрузитьДанные

sid, имяФайлаXML

Выгружает данные на сервер для лицензии sid.

Параметры:

• sid - sid-код лицензии, для которой выгружаются данные
• имяФайлаXML - полный путь к XML-файлу данных.

Возвращает:

Признак успешности выполнения запроса: Истина/Ложь.

Пример:

Агента = Обработки.Agenta.Создать();
//Здесь формируем xml-файл остатков
ИмяФайлаДанных = ПодготовитьФайлДанных();

Результат = Агента.ВыгрузитьДанные(Лицензия.sid,
	ИмяФайлаДанных);

Если Результат <> Ложь Тогда
	Предупреждение("Данные успешно выгружены!");
Иначе
	Предупреждение("Ошибка выполнения запроса! "
		+ Символы.ПС + Агента.ПолучитьОписаниеОшибки());
КонецЕсли;

ПолучитьКодОшибки

нет

Получить код последней ошибки.

Код текстовый, например, “invalid” - неверные параметры

Параметры:

нет

Возвращает:

Код ошибки (Строка)

ПолучитьОписаниеОшибки

нет

Получить текстовое описание последней ошибки. Например, “неверные параметры”

Параметры:

нет

Возвращает:

Описание ошибки (Строка)

ПолучитьМеткуВремени

нет

Получить метку времени последнего запроса, на которую получены данные.

Метка времени используется для осуществления обменов. Например, в методе ПолучитьДокументы(МеткаВремени).
Внимание! Если выборка пуста, метка времени будет в значении Неопределено. В этом случае, при дальнейших запросах, в качестве метки используйте предыдущее значение.

Параметры:

нет

Возвращает:

Метку времени (Число), или Неопределено

ЭтоВнешняяОбработка

нет

Позволяет определить режим запуска - внешняя обработка, или встроенная

Параметры:

нет

Возвращает:

Истина для внешней обработки, иначе Ложь