ВОЙТИ

Список изменений в API версии 2.0

Последние изменения: 29.10.2019
добавить в избранные

Общие изменения:

  • В URL вместо V1 теперь нужно писать V2 (за исключением API для телефонии).
  • Теперь при любой ошибке вместо полей errorType и errorMessage возвращается поле Error (с заглавной буквы) с текстом ошибки. Кроме того, при любой ошибке возвращается код состояния HTTP 500.
  • При использовании вебхуков из API телефонии появилась возможность проверять подлинность вызова посредством проверки сертификата.

GetSchools:

  • Переименован в GetOffices.
  • В результатах полe Schools переименовано в Offices.

GetStudents:

  • Параметр schoolId переименован в officeOrCompanyId.
  • Параметр status заменён на statuses, в котором можно указывать несколько значений.
  • Добавлены параметры addressDateFrom/addressDateTo.
  • В результатах поле Schools переименовано в OfficesAndCompanies.
  • В результатах добавлено поле AddressDate.

GetStudyRequests::

  • Параметры begin/end переименованы во from/to.
  • Параметр school переименован в office.
  • Удалён параметр studentId.
  • В результатах удалено поле StudentId.
  • В результатах поле School переименовано в Office.

GetLeads:

  • Параметр schoolId переименован в officeOrCompanyId.
  • Удалён параметр studentId.
  • Добавлены параметры addressDateFrom/addressDateTo.
  • В результатах удалено поле StudentId.
  • В результатах полe Schools переименовано в OfficesAndCompanies.
  • В результатах добавлено поле AddressDate.

GetLearners:

  • Переименован в GetEdUnits.
  • Параметры beginDate/endDate переименованы в dateFrom/dateTo.
  • Параметры beginTime/endTime переименованы в timeFrom/timeTo.
  • Параметр schoolId переименован в officeOrCompanyId.
  • Параметр school переименован в officeOrCompany.
  • Параметр queryPayableInfo переименован в queryFiscalInfo.
  • Параметр types больше не является обязательным и принимает значения в ед. числе (например "Group" вместо "Groups"), кроме того добавлено значение "TrialLessons".
  • Если параметр dateFrom не указан, он больше не принимается равным текущей дате.
  • Параметры discipline, level, maturity, learningType заменены на disciplines, levels, maturities, learningTypes и теперь в них можно указывать несколько значений.
  • Параметр onlyForming заменён на statuses, в котором можно указывать несколько значений.
  • Добавлен параметр queryDays.
  • В результатах поле Learners переименовано в EdUnits.
  • В результатах поле PayableInfo переименовано в FiscalInfo.
  • В результатах поля ScheduleItems.BeginDate и ScheduleItems.EndDate возвращаются теперь в формате "YYYY-MM-DD".
  • В результатах поле ScheduleItems.Classroom переименовано в ScheduleItems.ClassroomName.
  • В результатах поле PayableInfo.Price переименовано в PayableInfo.PriceName.
  • В результатах поля IsCompany, Schools, SchoolId, SchoolAddress переименованы в Corporative, OfficeOrCompanyName, OfficeOrCompanyId, OfficeOrCompanyAddress.
  • В результатах поле ScheduleItems не возвращается, если элементов расписаний нет.
  • В результатах добавлено поле Days.
  • Теперь данный метод возвращает и инд. пробные уроки.
  • Теперь данный метод возвращает и уч. единицы без расписаний.

GetLearnerStudents:

  • Переименован в GetEdUnitStudents.
  • Параметр learnerId переименован в edUnitId.
  • Параметр learnerTypes переименован в edUnitTypes.
  • Параметр edUnitTypes принимает значения в ед. числе (например "Group" вместо "Groups").
  • Параметр learnerSchoolId переименован в edUnitOfficeOrCompanyId.
  • Параметр learnerSchool переименован в edUnitOfficeOrCompany.
  • Параметр learnerCorporative переименован в edUnitCorporative.
  • Параметры learnerDiscipline, learnerLevel, learnerMaturity, status заменены на edUnitDisciplines, edUnitLevels, edUnitMaturities, statuses, в которых можно указывать несколько значений.
  • Параметры beginDate/endDate переименованы в dateFrom/dateTo.
  • Удалён параметр studentId.
  • В результатах поле LearnerStudents переименовано в EdUnitStudents.
  • В результатах поля Payers.StudentId и Payers.CompanyId заменены на Payers.IsCompany.
  • В результатах поле Payers.LearnerPayments переименовано в Payers.EdUnitPayments.
  • В результатах поля LearnerId, LearnerType, LearnerName, LearnerSchool, LearnerSchoolId, LearnerCorporative, LearnerDiscipline, LearnerLevel, LearnerLearningType, LearnerMaturity переименованы в EdUnitId, EdUnitType, EdUnitName, EdUnitOfficeOrCompanyName, EdUnitOfficeOrCompanyId, EdUnitCorporative, EdUnitDiscipline, EdUnitLevel, EdUnitLearningType, EdUnitMaturity.
  • В результатах удалено поле StudentId.
  • В результатах для связок "Без занятий" больше не возвращаются поля BeginDate и EndDate.

GetLessonPlans:

  • Параметр learnerId переименован в edUnitId.
  • Параметр schoolId переименован в officeOrCompanyId.
  • Параметры beginDate/endDate переименованы во dateFrom/dateTo.
  • В результатах поле LearnerId переименовано в EdUnitId.

GetPrices:

  • Параметр schoolId переименован в officeId.
  • В результатах поле Schools переименовано в Offices.
  • В результатах добавлены поля ValueQuantity, ValueCurrency, UnitsQuantity, UnitsType, Months и Days.

GetPayments:

  • Параметр type заменён на types, в котором можно указывать несколько значений.
  • Параметры beginDate/endDate переименованы в dateFrom/dateTo.
  • Параметры beginPaidDate/endPaidDate переименованы в paidDateFrom/paidDateTo.
  • Параметр schoolId переименован в officeOrCompanyId.
  • В результатах поля SchoolId, SchoolName переименованы в OfficeOrCompanyId, OfficeOrCompanyName.
  • В результатах добавлены поля ValueQuantity и ValueCurrency.

SetStudentPasses:

  • Параметр StudentId заменён на StudentClientId.
  • Параметр LearnerId переименован в EdUnitId.
  • В результатах при ошибке поля date, learnerId, studentId заменены на Date, EdUnitId, StudentClientId.

AddPayment:

  • Параметр SchoolOrCompanyId заменён на OfficeOrCompanyId.
  • В результатах поле id заменено на Id.

AddLearnerPayment:

  • Переименован в AddEdUnitPayment.
  • Параметр LearnerId переименован в EdUnitId.
  • В результатах поля id, value заменены на Id, Value.

AddStudyRequest:

  • Параметр learningLevel переименован в level.
  • Параметр school переименован в office.
  • Параметр learnerType переименован в edUnitType.
  • Параметр learnerId переименован в edUnitId.
  • В результатах поле id заменено на Id.

EditPayment:

  • Параметр State стал строковым.

Добавлены новые методы: GetEdUnitTestResults и EditEdUnitStudent.