Ресурсы

В зависимости от установленных флагов формат ответа может варьироваться.

В данном разделе рассмотрены флаги, применимые к ресурсам, и части результирующего JSON, за которые они отвечают. При указании нескольких флагов части будут собираться в один JSON.

Флаги ресурсов:

Значение Описание
0x00000001 базовый флаг
0x00000002 произвольные свойства
0x00000004 свойства биллинга
0x00000020 GUID
0x00000100 водители
0x00000400 задания
0x00001000 уведомления
0x00002000 POI
0x00004000 геозоны
0x00008000 шаблоны отчетов

Основные свойства

Флаг - 0x00000001

{
	"nm":<text>,	/* название */
	"cls":<uint>,	/* ID базового класса "avl_resource" */
	"id":<uint>	/* ID ресурса */
}

Произвольные свойства

Флаг - 0x00000002

В произвольных свойствах вы можете сохранять любые нужные вам данные о ресурсе.

{
	"prp":{		/* произвольные свойства */
		<text>:<text>,	/* название: значение */
		...
	},
	"pup":{		/* частные и публичные свойства */
		<text>:<text>,	/* название: значение */
		...
	}
}

Биллинг

Флаг - 0x00000004

{
	"crt":<uint>,	/* ID создателя */
	"bact":<uint>	/* ID учетной записи */
}

GUID

Флаг - 0x00000020

{
	"gd":<text>	/* GUID  ресурса */
}

Водители

Флаг - 0x00000100

{
	"drvrs":{
		<text>:{	/* порядковый номер водителя */
			"id":<long>,	/* ID */
			"nm":<text>,	/* имя */
			"c":<text>,	/* код */
			"ds":<text>,	/* описание */
			"p":<text>,	/* телефонный номер */
			"r":<double>,	/* соотношение сторон изображения */
			"ck":<ushort>	/* контрольная сумма (CRC16) */
		},
		...
	},
	"drvrs_max":<long>	/* максимальное количество водителей, разрешенное тарифным планом (-1 - не ограничено) */
}

Задания

Флаг - 0x00000400

{
	"ujb":{
		<text>:{		/* порядковый номер задания */
			"id":<uint>,		/* ID задания */
			"nm":<text>,		/* название */
			"de":<text>,		/* описание */
			"rsch":<text>,		/* тип выполнения */
			"at":<uint>,		/* время активации */
			"mt":<uint>,		/* максимальное количество раз выполнения задания, 0 - не ограничено */
			"tz":<int>,		/* часовой пояс (сек.) */
			"la":<text>,		/* язык, используется для отчётов */
			"je":<int>,		/* активно/неактивно */
			"dt":<uint>,		/* количество выполнений */
			"ldt":<uint>,		/* время последнего выполнения задания */
			"sch":{		/* ограничение по времени */
				"f1":<uint>,	/* время начала интервала 1 */
				"f2":<uint>,	/* время начала интервала 2 */
				"t1":<uint>,	/* время окончания интервала 1 */
				"t2":<uint>,	/* время окончания интервала 2 */
				"mdm":<uint>,	/* маска дней месяца */
				"ymm":<uint>,	/* маска месяцев */
				"wdm":<uint>	/* маска дней недели */
			},
			"act":{		/* выполняемое действие */
				"t":<text>,	/* тип задания */
				"p":{		/* параметры задания */
					<text>:<text>,	/* имя параметра: значение */
					...
				}
			}
		}
	},
	"ujbmax":<long>		/* максимальное количество заданий, разрешенное тарифным планом (-1 - не ограничено) */
}

Типы выполнения заданий и типы действий рассмотрены в разделе Задания: создание, редактирование и удаление.

Уведомления

Флаг - 0x00001000

{
	"unf":{
		<text>:{		/* порядковый номер уведомления */
			"id":<long>,	/* ID */
			"nm":<text>,	/* название */
			"txt":<text>,	/* текст уведомления */
			"ta":<uint>,	/* время активации (UNIX формат) */
			"td":<uint>,	/* время деактивации (UNIX формат) */
			"ma":<uint>,	/* максимальное количество срабатываний */
			"mmtd":<uint>,	/* максимальный временной интервал между сообщениями (секунд) */
			"cdt":<uint>,	/* таймаут срабатывания(секунд) */
			"mast":<uint>,	/* минимальная продолжительность тревожного состояния (секунд) */
			"mpst":<uint>,	/* минимальная продолжительность предыдущего состояния (секунд) */
			"cp":<uint>,	/* период контроля относительно текущего времени */
			"fl":<uint>,	/* флаги уведомлений */
			"tz":<int>,	/* часовой пояс */
			"la":<text>,	/* язык уведомления, используется в отчётах */
			"ac":<uint>,	/* количество срабатываний */
			"sch":{		/* ограничение по времени */
				"f1":<uint>,	/* время начала интервала 1 */
				"f2":<uint>,	/* время начала интервала 2 */
				"t1":<uint>,	/* время окончания интервала 1 */
				"t2":<uint>,	/* время окончания интервала 2 */
				"mdm":<uint>,	/* маска дней месяца */
				"ymm":<uint>,	/* маска месяцев */
				"wdm":<uint>	/* маска дней недели */
			},
			"un":[<long>],	/* массив GUIDов объектов */
			"act":[		/* действия */
				{
					"t":<text>,	/* тип действия */
					"p":{		/* параметры */
						<text>:<text>,	/* имя параметра: значение */
						...
					}
				}
			],
			"trg":{		/* контроль */
				"t":<text>,	/* тип контроля */
				"p":{		/* параметры */
					<text>:<text>,	/* имя параметра: значение */
					...
				}
			}
		}
	},
	"unfmax":<long>		/* максимальное количество уведомлений, разрешенное тарифным планом (-1 - не ограничено) */
}

Типы действий,типы контроля и флаги уведомлений подробней рассмотрены в разделе Уведомления: создание, редактирование и удаление.

POI

Флаг - 0x00002000

{
	"poi":{
		<text>:{	/* порядковый номер POI */
			"id":<long>,	/* ID */
			"nm":<text>,	/* название */
			"de":<text>,	/* описание */
			"y":<double>,	/* широта */
			"x":<double>,	/* долгота */
			"r":<uint>,	/* соотношение сторон изображения */
			"d":<uint>,	/* радиус, м */
			"f":<uint>,	/* флаг: 1 - отображать круг, 0 - скрывать */
			"cr":<uint>,	/* цвет RGB */
			"c":<ushort>	/* контрольная сумма изображения (CRC16) */
		},
		...
	},
	"poimax":<long>		/* максимальное количество POI, разрешенное тарифным планом (-1 - не ограничено) */
}

Геозоны

Флаг - 0x00004000

{
	"zl":{
		<text>:{	/* порядковый номер геозоны */
			"n":<text>,	/* название */
			"i":<long>,	/* ID */
			"t":<int>,	/* тип: 1 - линия, 2 - полигон, 3 - круг */
			"d":<uint>,	/* толщина линии или радиус круга, м */
			"dr":{
				"addr":<int>,		/* источник адреса: 0 - нет, 1 - да */
				"ride_begin":<uint>,	/* отправной пункт: 0 - нет, 1 - да */
				"ride_end":<uint>,	/* конечный пункт: 0 - нет, 1 - да */
				"color":<uint>		/* цвет (ARGB) */
			},
			"p":<text>	/* координаты точек (y,x,z,...) */
		}
	},
	"zlmax":<long>	/* максимальное количество геозон, разрешенное тарифным планом (-1 - не ограничено) */
}

Шаблоны отчетов

Флаг - 0x00008000

{
	"rep":{
		<text>:{	/* порядковый номер шаблона */
			"id":<long>,	/* ID */
			"nm":<text>,	/* название */
			"ct":<text>	/* тип шаблона */
		}
	},
	"repmax":<long>	/* максимальное количество шаблонов, разрешенное тарифным планом (-1 - не ограничено) */
}

Типы шаблонов рассмотрены в разделе Получить список типов таблиц.

Follow us on Facebook Gurtam Wialon Twitter Gurtam Wialon info@gurtam.com   |   Copyright © 2002-2019 Gurtam