Разработка:sync/soap - История изменений

Konovalov: /* Коды ошибок */

2015-02-09T10:14:07Z

‎Коды ошибок

Konovalov в 06:33, 24 ноября 2014

2014-11-24T06:33:18Z

Konovalov: /* Коды ошибок */

2014-10-13T10:08:51Z

‎Коды ошибок

Konovalov в 08:33, 13 октября 2014

2014-10-13T08:33:00Z

Konovalov в 14:47, 6 октября 2014

2014-10-06T14:47:53Z

Konovalov в 14:31, 6 октября 2014

2014-10-06T14:31:49Z

Внесённые изменения

Konovalov в 06:50, 2 октября 2014

2014-10-02T06:50:13Z

Konovalov в 06:05, 2 октября 2014

2014-10-02T06:05:47Z

Konovalov в 13:53, 30 сентября 2014

2014-09-30T13:53:40Z

Внесённые изменения

Konovalov: /* Дополнительные методы */

2014-09-22T14:20:25Z

‎Дополнительные методы

@@ Строка 627: / Строка 627: @@
 ** SP35 - Не найден студент, на которого заключён договор
 ** SP36 - Нельзя изменить студента, на которого заключён договор
 * Ошибки кодирования [SC]
 ** SC1 - Не зарегистрирована функция проверки параметров запроса для данного метода

@@ Строка 69: / Строка 69: @@
 Поэтому при проверке на сервере хэш не совпадёт.
-=API=
+=API (внешний) =
 ==='''set_meta_contract($input)'''===
@@ Строка 179: / Строка 179: @@
-=Дополнительные методы=
+=Дополнительные методы (внутренние)=
 ===='''check_address($input)'''====

@@ Строка 576: / Строка 576: @@
 ** PR3 - Отсутствует контрольная сумма [requesthash]
 ** PR4 - Отсутствует идентификатор объекта [id]
 * Некорректные [PI]
 ** PI3 - Контрольная сумма запроса не совпадает
 ** PI4 - Недопустимые символы в e-mail
 ** PI5 - Тип переменной подразделения должен быть строковый
-** PI6 - Тип переменной cov должен быть объектом
+** PI6 - Тип переменной cov должен быть массивом
 ** PI7 - Поля внутри переменной cov не должны быть массивами или объектами
 ** PI8 - Поля внутри переменной cov не должны совпадать с полями справочника (например, status, adddate)
@@ Строка 588: / Строка 590: @@
 ** SP2 - Данный e-mail не допустим в системе
 ** SP3 - Данный e-mail уже зарегистрирован в системе
-** SP4 - Название подразделения не может быть пустым
+** SP4 - Название мета-контракта не может быть пустым
 ** SP5 - Подразделения с таким кодом не существует
 ** SP6 - Подразделение не актуально
 ** SP7 - Код подразделения должен быть строкового типа
 ** SP8 - Неверно передан параметр с запросом
 * Ошибки кодирования [SC]
 ** SC1 - Не зарегистрирована функция проверки параметров запроса для данного метода
 ** SC2 - Не зарегистрирована функция исполнения запроса для данного метода
-** SC3 - Не верно передан формат проверки полей вложенного объекта cov
+** SC3 - Не верно передан формат проверки полей вложенного массива cov
 ** SC4 - Для этого метода не задана таблица, с которой он работает
 ** SC5 - Неверно указано название операции
 * Ошибки целостности структуры (базы) [SI]
 ** SI1 - Не удалось добавить запись в справочник metacontracts
@@ Строка 609: / Строка 647: @@
 ** SI8 - Не удалось обновить запись в справочнике addresses
 ** SI9 - Не удалось найти запись в справочнике addresses для обновления
 =Замечания, возможные проблемы=

@@ Строка 180: / Строка 180: @@
 =Дополнительные методы=
 ===='''check_cov($cov, $fields = null)'''====
@@ Строка 248: / Строка 271: @@
 * (bool) - false в случае ошибки, или
 * (object) - объект подключения к синхронизации dof_storage_sync_connect
@@ Строка 347: / Строка 381: @@
 * (bool) - false, если такого сочетания "метод-справочник" не найдено
 * (string) - код ошибки
@@ Строка 381: / Строка 430: @@
 * (bool) - false в случае ошибки
 * (string) - sha1-хеш
@@ Строка 411: / Строка 459: @@
 * (int) - id добавленного объекта
 * (string) - код ошибки

@@ Строка 14: / Строка 14: @@
 У каждого метода присутствуют следующие обязательные служебные параметры:
-* requestime - время генерации запроса, используется для устаревания запроса с целью защиты от атаки на "повторение перехваченного запроса"
+* requesttime - (UNIX timestamp) время генерации запроса, используется для устаревания запроса с целью защиты от атаки на "повторение перехваченного запроса"
 * requestlogin - идентифицирует систему-отправитель запроса (задается в sync/soap/cfg/clients.php, вместе с паролем requestpassword и необязательными параметрами)
 * requesthash - sha1-хеш от всех полей запроса в алфавитном порядке, включая предыдущие два, а так же поля requestpassword (в самом запросе не участвует). Используется для подтверждения подлинности запроса.
 Имена полей soap-запросов должны совпадать с именами полей в справочниках: [[Разработка:storages/metacontracts | storages/metacontracts ]], [[Разработка:storages/persons | storages/persons ]], [[Разработка:storages/contracts | storages/contracts ]]
@@ Строка 30: / Строка 32: @@
 * id - переданный в запросе id объекта
 * dofid - внутренний id объекта
-* modified - время изменения объекта
+* modified - время изменения объекта (UNIX timestamp)
 * hash - контрольная сумма из storages/sync
 * errorcode - код ошибки, помогающий идентифицировать проблему при исполнении запроса
@@ Строка 73: / Строка 75: @@
 * input(object) - данные метаконтракта, переданные по SOAP. Содержит следующие поля
 ** requestlogin(string) - Идентификатор системы-отправителя запроса
-** requesttime(int) - Время генерации запроса
+** requesttime(int) - Время генерации запроса (UNIX timestamp)
 ** requesthash(string) - sha1-хеш
 ** id(int) - Внешний id метаконтракта
@@ Строка 92: / Строка 94: @@
 * input(object) - данные персоны, переданные по SOAP. Содержит следующие поля
 ** requestlogin(string) - Идентификатор системы-отправителя запроса
-** requesttime(int) - Время генерации запроса
+** requesttime(int) - Время генерации запроса (UNIX timestamp)
 ** requesthash(string) - sha1-хеш
 ** id(int) - Внешний id метаконтракта
@@ Строка 151: / Строка 153: @@
 * input(object) - данные договора, переданные по SOAP. Содержит следующие поля
 ** requestlogin(string) - Идентификатор системы-отправителя запроса
-** requesttime(int) - Время генерации запроса
+** requesttime(int) - Время генерации запроса (UNIX timestamp)
 ** requesthash(string) - sha1-хеш
 ** id(int) - Внешний id договора

@@ Строка 39: / Строка 39: @@
 ** vars формируется следующим образом:
-*** Из полей объекта для SOAP-запроса исключаются служебные данные — requesthash, requestlogin, requesttime и дополнительный массив cov
+*** Из полей объекта для SOAP-запроса исключаются служебные данные — requesthash, requestlogin, requesttime и дополнительный объект cov
 *** Поля сортируются в алфавитном порядке;
 ** cvars — вложенный объект cov, поля которого так же сортируются в алфавитном порядке;
@@ Строка 78: / Строка 78: @@
 ** num - Номер метаконтракта
 ** departmentcode - Код подразделения
-** cov - Дополнительный массив cov, содержащий дополнительные поля к объекту
+** cov - Дополнительный объект cov, содержащий дополнительные поля к объекту
 ''Возвращаемые значения:''
 * (object) - объект со следующими полями
@@ Строка 123: / Строка 123: @@
 ** address(object) - Текущий адрес (почтовый адрес)
 ** birthaddress(object) - Адрес рождения персоны
-** cov - Дополнительный массив cov, содержащий дополнительные поля к объекту
+** cov - Дополнительный объект cov, содержащий дополнительные поля к объекту
 ''Формат объектов: passportadd, address, birthaddress''
 * postalcode - Почтовый индекс
@@ Строка 163: / Строка 163: @@
 ** notes - Заметки
 ** departmentcode - Подразделение в таблице departments, к которому приписан контракт на обучение (например, принявшее ученика)
 ** contractform - Форма договора (шаблон)
 ** curatorid - Куратор или классный руководитель данного ученика (по таблице persons или не указан), отслеживает учебный процесс, держит связь с учеником, является посредником между учеником и системой, может быть внешней персоной.
 ** enddate - Дата окончания договора
 ** metacontractid - id метаконтракта, к которому привязан договор, в таблице metacontracts
-** cov - Дополнительный массив cov, содержащий дополнительные поля к объекту
+** cov - Дополнительный объект cov, содержащий дополнительные поля к объекту
 ''Возвращаемые значения:''
 * (object) - объект со следующими полями
@@ Строка 182: / Строка 181: @@
 ===='''check_cov($cov, $fields = null)'''====
-Проверить дополнительный массив на предмет соответствия формату
+Проверить дополнительный объект на предмет соответствия формату
 ''Аргументы:''
-* cov(array) - дополнительный вложенный массив.
+* cov(array) - дополнительный вложенный объект.
 * fields(object) - поля объекта для проверки дублирующихся полей.
 ''Возвращаемые значения:''
@@ Строка 364: / Строка 363: @@
 ''Аргументы:''
-* input(object) - SOAP-запрос с обязательными полями id, requesttime, requestlogin, requesthash, массивом cov.
+* input(object) - SOAP-запрос с обязательными полями id, requesttime, requestlogin, requesthash, объектом cov.
 * requestpassword(string) - ключ идентификатора системы.
 ''Возвращаемые значения:''
@@ Строка 400: / Строка 399: @@
 * Выполнить дополнительные действия: [[#execute_additional_($input, $operation, $dofid = null)|execute_additional_()]], в случае ошибок сгенерировать ответ
 * Вставить объект в базу, обработать ошибки
-* Обработать массив cov: [[#update_cov($dofid, $inputcov, $plugincode)|update_cov()]], добавить поля в базу, обработать ошибки
+* Обработать объект cov: [[#update_cov($dofid, $inputcov, $plugincode)|update_cov()]], добавить поля в базу, обработать ошибки
 * В соответствии с настройками выставить статус через [[#set_status_route($table, $dofid, $departmentid)|set_status_route()]], ошибки только логировать
@@ Строка 472: / Строка 471: @@
 ===='''update_cov($dofid, $inputcov, $plugincode)'''====
-Обновить вложенный массив cov для внутренних объектов
+Обновить вложенный объект cov для внутренних объектов
 ''Аргументы:''
 * dofid(int) - внутренний id объекта в таблице $plugincode
-* inputcov(object) - массив или объект, по которому происходит перебор
+* inputcov(object) - объект, по которому происходит перебор
 * plugincode(string) - код плагина storage
 ''Возвращаемые значения:''
@@ Строка 489: / Строка 488: @@
 * Выполнить дополнительные действия: [[#execute_additional_($input, $operation, $dofid = null)|execute_additional_()]], в случае ошибок сгенерировать ответ
 * Обновить объект в базе, обработать ошибки
-* Обработать массив cov: [[#update_cov($dofid, $inputcov, $plugincode)|update_cov()]], добавить поля в базу, обработать ошибки
+* Обработать объект cov: [[#update_cov($dofid, $inputcov, $plugincode)|update_cov()]], добавить поля в базу, обработать ошибки
 ''Аргументы:''
@@ Строка 517: / Строка 516: @@
 ** PI4 - Недопустимые символы в e-mail
 ** PI5 - Тип переменной подразделения должен быть строковый
-** PI6 - Тип переменной cov должен быть массивом
+** PI6 - Тип переменной cov должен быть объектом
 ** PI7 - Поля внутри переменной cov не должны быть массивами или объектами
 ** PI8 - Поля внутри переменной cov не должны совпадать с полями справочника (например, status, adddate)
@@ Строка 533: / Строка 532: @@
 ** SC1 - Не зарегистрирована функция проверки параметров запроса для данного метода
 ** SC2 - Не зарегистрирована функция исполнения запроса для данного метода
-** SC3 - Не верно передан формат проверки полей вложенного массива cov
+** SC3 - Не верно передан формат проверки полей вложенного объекта cov
 ** SC4 - Для этого метода не задана таблица, с которой он работает
 ** SC5 - Неверно указано название операции

@@ Строка 271: / Строка 271: @@
 * (bool) - операция прошла успешно
 * (object) - возвращает дополнительные поля, которые надо присоединить к объекту в методе [[#insert_object($input, $method, $table)|insert_object()]]
 * (string) - или код ошибки
@@ Строка 280: / Строка 307: @@
 ''Аргументы:''
 * input(object) - объект с определёнными полями одного из справочника
-* storage(string) - название справочника: 'cov', 'persons', ...
+* storage(string) - название справочника: 'contracts', 'persons', ...
 ''Возвращаемые значения:''
 * (bool) - false, в случае ошибки
@@ Строка 315: / Строка 342: @@
 ''Аргументы:''
 * method(string) - название операции со справочником: 'insert', 'update', ...
-* storage(string) - название справочника: 'cov', 'persons', ...
+* storage(string) - название справочника: 'contracts', 'persons', ...
 ''Возвращаемые значения:''
 * (bool) - false, если такого сочетания "метод-справочник" не найдено
@@ Строка 378: / Строка 405: @@
 ''Аргументы:''
 * input(object) - объект с полями справочника и другими дополнительными полями
-* method(string) - внутренний id объекта в таблице $plugincode
+* method(string) - метод API, который необходимо выполнить
-* table(string) - название справочника: 'cov', 'persons', ...
+* table(string) - название справочника: 'contracts', 'persons', ...
 ''Возвращаемые значения:''
 * (int) - id добавленного объекта
@@ Строка 423: / Строка 450: @@
 ''Аргументы:''
-* table(string) - название справочника: 'cov', 'persons', ...
+* table(string) - название справочника: 'contracts', 'persons', ...
 * dofid(int) - внутренний id объекта из таблицы $storage
 * departmentid(int) - id из таблицы departments
 ''Возвращаемые значения:''
 * (int) - id добавленного объекта