GDMN-Salary (Руководство разработчика)

Версия 20:53, 21 февраля 2016

Web-server API

Запрос к серверу ?token=REQUEST_PARAM_TOKEN & param=value ...

ip_address app_version_code

auth_key для всех кроме авторизации

header

 Content-Type: application/json; charset=utf-8

объекты передаются в формате json

токены прописаны в скрипте...

Ответ сервера

{"cl":"SyncHeader", "params":{"f1":"v1","f2":"v2","f3":"v3"}} {}

client timeouts:

 ConnectTimeout - 60 сек
 ReadTimeout - 60 с

RequestMethod: GET

RealmSyncObject {

 String              cl          - не null
 List<Link>          master        - может быть null
 List<Link>          link            - может быть null
 <T extends RealmObject>  obj         - не null
 boolean             deleted

}

Link {

 String              cl          - не null
 String              uid         - не null
 String              field       - не null

}

Пример данных для EmployeeModel, PayslipModel и PayslipItemModel:

 {cl:"EmployeeModel", obj:{uid:"123", ...}}
 {cl:"PayslipModel", link:[{cl:"EmployeeModel", uid:"123", field:"employee"}], obj:{uid:"456", ...}}
 {cl:"PayslipItemModel", master:[{cl:"PayslipModel", uid:"456", field:"items"}], obj:{...}}

Пример данных для EmployeeModel, TimesheetModel, WorkscheduleModel и DayEventModel:

 {cl:"EmployeeModel", obj:{uid:"123", ...}}
 {cl:"TimesheetModel", link:[{cl:"EmployeeModel", uid:"123", field:"employee"}], obj:{uid:"456", ...}}
 {cl:"WorkscheduleModel", link:[{cl:"EmployeeModel", uid:"123", field:"employee"}], obj:{uid:"789", ...}}
 {cl:"DayEventModel", master:[{cl:"TimesheetModel", uid:"456", field:"events"}, {cl:"WorkscheduleModel", uid:"789", field:"events"}], obj:{...}}

Пример удаления записи:

 {cl:"EmployeeModel", delete:"true", obj:{uid:"123"}}

Классы, хранящиеся в клиентской БД

Указаны лишь те поля, которые связаны с БД

Класс DayEventModel - событие дня в расписании или табеле

Наименование	Тип данных	Описание
uid	int	PK
eventTypeIndex	int	Тип события дня [DayEventModel.EventType]
timeBegin	Date	Время начала
timeEnd	Date	Время окончания
hours	double	Продолжительность, часов
description	String	Описание
isAllDay	boolean	Продолжительность: весь день

Класс DeviceInfoModel - информация об устройстве

Наименование	Тип данных	Описание
uid	int	PK
phoneNumber	String	MSISDN
deviceId	String	Уникальный идентификатор устройства [IMEI for GSM, MEI for GSM, MEID/ESN for CDMA phones, else: android_id]
deviceModel	String	Модель устройства

Класс EmployeeModel - сотрудник

Наименование	Тип данных	Описание
uid	int	PK
firstname	String	Имя
surname	String	Фамилия
middlename	String	Отчество
passportId	String	ID паспорта
listNumber	String	Табельный номер

Класс ExRatesMonthlyModel - курс валют

Наименование	Тип данных	Описание
uid	int	PK
onDate	Date	Дата
usdRate	double	Курс доллара
eurRate	double	Курс евро

Класс GdMsgAbsenceModel - заявка о неявке на работу

Наименование	Тип данных	Описание
uid	int	PK
typeIndex	int	Тип неявки [GdMsgAbsenceModel.Type]
dateBegin	Date	Дата начала
dateEnd	Date	Дата окончания
requestGdMsgModel	GdMsgModel	Cообщение, на которое ответ (для серверных сообщений)

Класс GdMsgIncomeModel - заявка о справке о доходах

Наименование	Тип данных	Описание
uid	int	PK
dateBegin	Date	Дата начала
dateEnd	Date	Дата окончания
requestGdMsgModel	GdMsgModel	Cообщение, на которое ответ (для серверных сообщений)

Класс GdMsgInfoModel - информационное сообщение

Наименование	Тип данных	Описание
uid	int	PK
requestGdMsgModel	GdMsgModel	Cообщение, на которое ответ (для серверных сообщений)

Класс GdMsgModel - сообщение

Наименование	Тип данных	Описание
uid	int	PK
requestStatusIndex	int	Статус запроса [GdMsgModel.RequestStatus]
subjectIndex	int	Тема запроса [GdMsgModel.Subject]
senderIndex	int	Тип отправителя [GdMsgModel.Sender]
isUnread	boolean	Прочитано
timestamp	Date	Дата создания
msg	String
comment	String	Комментарий
gdMsgString	String	Строковое представление данных сообщения (для поиска по ним)
gdMsgAbsenceModel	GdMsgAbsenceModel	Заявка: неявка на работу
gdMsgIncomeModel	GdMsgIncomeModel	Заявка: справка о доходах
gdMsgVacationModel	GdMsgVacationModel	Заявка: отпуск
gdMsgInfoModel	GdMsgInfoModel	Информационное сообщение
gdMsgVacationInfoModel	GdMsgVacationInfoModel	Заявка: информация о ближайшем отпуске

Класс GdMsgVacationInfoModel - заявка о информации на ближайший отпуск

Наименование	Тип данных	Описание
uid	int	PK
dateBegin	Date	Дата начала
dateEnd	Date	Дата окончания
requestGdMsgModel	GdMsgModel	Cообщение, на которое ответ (для серверных сообщений)

Класс GdMsgVacationModel - заявка об отпуске

Наименование	Тип данных	Описание
uid	int	PK
typeIndex	int	Тип отпуска [GdMsgVacationModel.Type]
dateBegin	Date	Дата начала
dateEnd	Date	Дата окончания
requestGdMsgModel	GdMsgModel	Cообщение, на которое ответ (для серверных сообщений)

Класс PayslipBenefitModel - льгота расчетного литка

Наименование	Тип данных	Описание
uid	int	PK
date	Date	Дата
name	String	Наименование
sum	double	Сумма
code	int	Код льготы

Класс PayslipDeductionModel - вычет расчетного листка

Наименование	Тип данных	Описание
uid	int	PK
date	Date	Дата
name	String	Наименование
deductionKind	String	Вид вычета
sum	double	Сумма
code	int	Код вычета

Класс PayslipItemModel - позиция расчетного листка (начисление/удержание/налог/аванс)

Наименование	Тип данных	Описание
uid	int	PK
categoryIndex	int	Тип категории [PayslipItemModel.Category]
date	Date	Дата
name	String	Наименование
code	int	Код
debit	double	Сумма дебета
credit	double	Сумма кредита

Класс PayslipModel - расчетный листок за месяц

Наименование	Тип данных	Описание
uid	int	PK
payDate	Date	Дата окончания периода
employee	EmployeeModel	Сотрудник
department	String	Участок
isFinal	boolean	Окончательный
position	String	Должность
salary	double	Сумма оклада
hourRate	double	Сумма почасовой тарифной ставки
dependents	int	Количество иждивенцев
items	RealmList<PayslipItemModel>	Список позиций листка (начисления, удержания, налоги, авансы)
benefits	RealmList<PayslipBenefitModel>	Список льгот
deductions	RealmList<PayslipDeductionModel>	Список Вычетов

Класс SyncGdMsgStateModel - состояние сообщения

Наименование	Тип данных	Описание
uid	String	PK
statusIndex	int	Тип состояния [SyncGdMsgStateModel.UpdatedStatus]
gdMsgKey	int	GdMsg.uid сообщения

Класс SyncMetaDataModel - мета-данные для синхронизации

Наименование	Тип данных	Описание
uid	int	PK
scheme	String	Схема веб-протокола
addressServer	String	Адрес
authKey	String	Авторизационный ID
lastSyncDate	String	Дата последней синхронизации
lastSyncMsgDate	String	Дата последней синхронизации сообщений
gcmRegistrationId	String	ID девайса в Google Cloud Messaging
inviteCode	String	Инвайт-код
permits	boolean	Наличие права доступа к данным
lostMode	boolean	Режим потерянного девайса

Класс TimesheetModel - табель рабочего времени за день

Наименование	Тип данных	Описание
uid	int	PK
dayTypeIndex	int	Тип дня [DayType]
employee	EmployeeModel	Сотрудник
description	String	Описание
hours	double	Продолжительность, часов
date	Date	Дата
events	RealmList<DayEventModel>	Список событий

Класс WorkScheduleModel - рабочий график на день

Наименование	Тип данных	Описание
uid	int	PK
dayTypeIndex	int	Тип дня [DayType]
employee	EmployeeModel	Сотрудник
description	String	Описание
hours	double	Продолжительность, часов
date	Date	Дата
events	RealmList<DayEventModel>	Список событий

Таблицы данных для приложения на сервере

GDMN-Salary (Руководство разработчика)

Версия 20:53, 21 февраля 2016

Web-server API

Классы, хранящиеся в клиентской БД

Таблицы данных для приложения на сервере

Персональные инструменты

Пространства имён

Варианты

Просмотры

Действия

Поиск

Навигация

Инструменты

@@ Строка 61: / Строка 61: @@
 Указаны лишь те поля, которые связаны с БД
-'''Класс DayEventModel'''
+'''Класс DayEventModel''' - событие дня в расписании или табеле
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 69: / Строка 69: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | eventTypeIndex
 | int
-| Тип события дня DayEventModel.EventType
+| Тип события дня [DayEventModel.EventType]
 |- align="center"
 | timeBegin
 | Date
-|
+| Время начала
 |- align="center"
 | timeEnd
 | Date
-|
+| Время окончания
 |- align="center"
 | hours
 | double
-|
+| Продолжительность, часов
 |- align="center"
 | description
 | String
-|
+| Описание
 |- align="center"
 | isAllDay
 | boolean
-|
+| Продолжительность: весь день
 |}
-'''Класс DeviceInfoModel'''
+'''Класс DeviceInfoModel''' - информация об устройстве
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 103: / Строка 104: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | phoneNumber
 | String
-|
+| MSISDN
 |- align="center"
 | deviceId
 | String
-|
+| Уникальный идентификатор устройства [IMEI for GSM, MEI for GSM, MEID/ESN for CDMA phones, else: android_id]
 |- align="center"
 | deviceModel
 | String
-|
+| Модель устройства
 |}
-'''Класс EmployeeModel'''
+'''Класс EmployeeModel''' - сотрудник
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 125: / Строка 127: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | firstname
 | String
-|
+| Имя
 |- align="center"
 | surname
 | String
-|
+| Фамилия
 |- align="center"
 | middlename
 | String
-|
+| Отчество
 |- align="center"
 | passportId
 | String
-|
+| ID паспорта
 |- align="center"
 | listNumber
 | String
-|
+| Табельный номер
 |}
-'''Класс ExRatesMonthlyModel'''
+'''Класс ExRatesMonthlyModel''' - курс валют
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 155: / Строка 158: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | onDate
 | Date
-|
+| Дата
 |- align="center"
 | usdRate
 | double
-|
+| Курс доллара
 |- align="center"
 | eurRate
 | double
-|
+| Курс евро
 |}
-'''Класс GdMsgAbsenceModel'''
+'''Класс GdMsgAbsenceModel''' - заявка о неявке на работу
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 177: / Строка 181: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | typeIndex
 | int
-| GdMsgAbsenceModel.Type
+| Тип неявки [GdMsgAbsenceModel.Type]
 |- align="center"
 | dateBegin
 | Date
-|
+| Дата начала
 |- align="center"
 | dateEnd
 | Date
-|
+| Дата окончания
 |- align="center"
 | requestGdMsgModel
 | GdMsgModel
-| для серверных сообщений - сообщение на которое ответ
+| Cообщение, на которое ответ (для серверных сообщений)
 |}
-'''Класс GdMsgIncomeModel'''
+'''Класс GdMsgIncomeModel''' - заявка о справке о доходах
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 203: / Строка 208: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | dateBegin
 | Date
-|
+| Дата начала
 |- align="center"
 | dateEnd
 | Date
-|
+| Дата окончания
 |- align="center"
 | requestGdMsgModel
 | GdMsgModel
-| для серверных сообщений - сообщение на которое ответ
+| Cообщение, на которое ответ (для серверных сообщений)
 |}
-'''Класс GdMsgInfoModel'''
+'''Класс GdMsgInfoModel''' - информационное сообщение
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 225: / Строка 231: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | requestGdMsgModel
 | GdMsgModel
-| для серверных сообщений - сообщение на которое ответ
+| Cообщение, на которое ответ (для серверных сообщений)
 |}
-'''Класс GdMsgModel'''
+'''Класс GdMsgModel''' - сообщение
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 239: / Строка 246: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | requestStatusIndex
 | int
-| GdMsgModel.RequestStatus
+| Статус запроса [GdMsgModel.RequestStatus]
 |- align="center"
 | subjectIndex
 | int
-| GdMsgModel.Subject
+| Тема запроса [GdMsgModel.Subject]
 |- align="center"
 | senderIndex
 | int
-| GdMsgModel.Sender
+| Тип отправителя [GdMsgModel.Sender]
 |- align="center"
 | isUnread
 | boolean
-|
+| Прочитано
 |- align="center"
 | timestamp
 | Date
-|
+| Дата создания
 |- align="center"
 | msg
@@ Строка 267: / Строка 274: @@
 | comment
 | String
-|
+| Комментарий
 |- align="center"
 | gdMsgString
 | String
-|
+| Строковое представление данных сообщения (для поиска по ним)
 |- align="center"
 | gdMsgAbsenceModel
 | GdMsgAbsenceModel
-|
+| Заявка: неявка на работу
 |- align="center"
 | gdMsgIncomeModel
 | GdMsgIncomeModel
-|
+| Заявка: справка о доходах
 |- align="center"
 | gdMsgVacationModel
 | GdMsgVacationModel
-|
+| Заявка: отпуск
 |- align="center"
 | gdMsgInfoModel
 | GdMsgInfoModel
-|
+| Информационное сообщение
 |- align="center"
 | gdMsgVacationInfoModel
 | GdMsgVacationInfoModel
-|
+| Заявка: информация о ближайшем отпуске
 |}
-'''Класс GdMsgVacationInfoModel'''
+'''Класс GdMsgVacationInfoModel''' - заявка о информации на ближайший отпуск
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 301: / Строка 309: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | dateBegin
 | Date
-|
+| Дата начала
 |- align="center"
 | dateEnd
 | Date
-|
+| Дата окончания
 |- align="center"
 | requestGdMsgModel
 | GdMsgModel
-| для серверных сообщений - сообщение на которое ответ
+| Cообщение, на которое ответ (для серверных сообщений)
 |}
-'''Класс GdMsgVacationModel'''
+'''Класс GdMsgVacationModel''' - заявка об отпуске
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 323: / Строка 332: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | typeIndex
 | int
-| GdMsgVacationModel.Type
+| Тип отпуска [GdMsgVacationModel.Type]
 |- align="center"
 | dateBegin
 | Date
-|
+| Дата начала
 |- align="center"
 | dateEnd
 | Date
-|
+| Дата окончания
 |- align="center"
 | requestGdMsgModel
 | GdMsgModel
-| для серверных сообщений - сообщение на которое ответ
+| Cообщение, на которое ответ (для серверных сообщений)
 |}
-'''Класс PayslipBenefitModel'''
+'''Класс PayslipBenefitModel''' - льгота расчетного литка
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 349: / Строка 359: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | date
 | Date
-|
+| Дата
 |- align="center"
 | name
 | String
-|
+| Наименование
 |- align="center"
 | sum
 | double
-|
+| Сумма
 |- align="center"
 | code
 | int
-|
+| Код льготы
 |}
-'''Класс PayslipDeductionModel'''
+'''Класс PayslipDeductionModel''' - вычет расчетного листка
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 375: / Строка 386: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | date
 | Date
-|
+| Дата
 |- align="center"
 | name
 | String
-|
+| Наименование
-||- align="center"
+|- align="center"
 | deductionKind
 | String
-| вид вычета
+| Вид вычета
 |- align="center"
 | sum
 | double
-|
+| Сумма
 |- align="center"
 | code
 | int
-|
+| Код вычета
 |}
+'''Класс PayslipItemModel''' - позиция расчетного листка (начисление/удержание/налог/аванс)
-'''Класс PayslipItemModel'''
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 407: / Строка 417: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | categoryIndex
 | int
-| PayslipItemModel.Category
+| Тип категории [PayslipItemModel.Category]
 |- align="center"
 | date
 | Date
-|
+| Дата
 |- align="center"
 | name
 | String
-|
+| Наименование
 |- align="center"
 | code
 | int
-|
+| Код
 |- align="center"
 | debit
 | double
-|
+| Сумма дебета
 |- align="center"
 | credit
 | double
-|
+| Сумма кредита
 |}
-'''Класс PayslipModel'''
+'''Класс PayslipModel''' - расчетный листок за месяц
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 441: / Строка 452: @@
 | uid
 | int
-| PK записи
+| PK
-|- align="center"
-| employeeKey
-| String
-|
 |- align="center"
 | payDate
 | Date
-|
+| Дата окончания периода
 |- align="center"
 | employee
 | EmployeeModel
-|
+| Сотрудник
 |- align="center"
 | department
 | String
-|
+| Участок
 |- align="center"
 | isFinal
 | boolean
-|
+| Окончательный
 |- align="center"
 | position
 | String
-|
+| Должность
 |- align="center"
 | salary
 | double
-|
+| Сумма оклада
 |- align="center"
 | hourRate
 | double
-|
+| Сумма почасовой тарифной ставки
 |- align="center"
 | dependents
 | int
-|
+| Количество иждивенцев
 |- align="center"
 | items
 | RealmList<PayslipItemModel>
-| Начисления, Удержания, Налоги
+| Список позиций листка (начисления, удержания, налоги, авансы)
 |- align="center"
 | benefits
 | RealmList<PayslipBenefitModel>
-| Льготы
+| Список льгот
 |- align="center"
 | deductions
 | RealmList<PayslipDeductionModel>
-| Вычеты
+| Список Вычетов
 |}
-'''Класс SyncGdMsgStateModel'''
+'''Класс SyncGdMsgStateModel''' - состояние сообщения
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 499: / Строка 507: @@
 | uid
 | String
-| PK записи
+| PK
 |- align="center"
 | statusIndex
 | int
-| UpdatedStatus {READED, DELETED}
+| Тип состояния [SyncGdMsgStateModel.UpdatedStatus]
 |- align="center"
 | gdMsgKey
 | int
-|
+| GdMsg.uid сообщения
 |}
-'''Класс SyncMetaDataModel'''
+'''Класс SyncMetaDataModel''' - мета-данные для синхронизации
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 517: / Строка 526: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | scheme
 | String
-|
+| Схема веб-протокола
 |- align="center"
 | addressServer
 | String
-|
+| Адрес
 |- align="center"
 | authKey
 | String
-|
+| Авторизационный ID
 |- align="center"
 | lastSyncDate
 | String
-|
+| Дата последней синхронизации
 |- align="center"
 | lastSyncMsgDate
 | String
-|
+| Дата последней синхронизации сообщений
 |- align="center"
 | gcmRegistrationId
 | String
-|
+| ID девайса в Google Cloud Messaging
 |- align="center"
 | inviteCode
 | String
-|
+| Инвайт-код
 |- align="center"
 | permits
 | boolean
-|
+| Наличие права доступа к данным
 |- align="center"
 | lostMode
 | boolean
-|
+| Режим потерянного девайса
 |}
-'''Класс TimesheetModel'''
+'''Класс TimesheetModel''' - табель рабочего времени за день
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 563: / Строка 573: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | dayTypeIndex
 | int
-|
+| Тип дня [DayType]
 |- align="center"
 | employee
 | EmployeeModel
-|
+| Сотрудник
 |- align="center"
 | description
 | String
-|
+| Описание
 |- align="center"
 | hours
 | double
-|
+| Продолжительность, часов
 |- align="center"
 | date
 | Date
-|
+| Дата
 |- align="center"
 | events
 | RealmList<DayEventModel>
-|
+| Список событий
 |}
-'''Класс WorkScheduleModel'''
+'''Класс WorkScheduleModel''' - рабочий график на день
 {|border="1" cellpadding="2" cellspacing="0" style="border-collapse:collapse;"
 !style="background:#ffdead;"| Наименование
@@ Строка 597: / Строка 608: @@
 | uid
 | int
-| PK записи
+| PK
 |- align="center"
 | dayTypeIndex
 | int
-|
+| Тип дня [DayType]
 |- align="center"
 | employee
 | EmployeeModel
-|
+| Сотрудник
 |- align="center"
 | description
 | String
-|
+| Описание
 |- align="center"
 | hours
 | double
-|
+| Продолжительность, часов
 |- align="center"
 | date
 | Date
-|
+| Дата
 |- align="center"
 | events
 | RealmList<DayEventModel>
-|
+| Список событий
 |}
 === Таблицы данных для приложения на сервере ===