Объекты

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

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

Флаги объектов:

Флаг - 0x00000001

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

Флаг - 0x00000002

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

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

Флаг - 0x00000004

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

Флаг - 0x00000008

{
	"ugs":[]	/* ID групп, в которые входит объект */
}

Флаг - 0x00000010

{
	"flds":{	/* список произвольных полей */			
		<text>:{		/* порядковый номер произвольного поля */
			"id":<uint>,	/* ID */
			"nm":<text>,	/* имя */
			"vl":<text>	/* значение */
		},
		...
	},
	"flds_max":<long>,	/* максимальное количество произвольных полей (-1 - не ограничено) */
}

Флаг - 0x00000020

{
	"gd":<text>	/* GUID  объекта */
}

Флаг - 0x00000040

Установка данного флага позволяет принимать сообщения от объекта.

{}

Флаг - 0x00000100

{
	"uid":<text>,	/* уникальный ID оборудования */
	"hw":<long>,	/* тип оборудования */
	"ph":<text>,	/* телефонный номер */
	"psw":<text>	/* пароль */
}

Флаг - 0x00000200

{
	"cmds":{		/* команды */
		<text>:[<text>]		/* тип связи: массив доступных типов команд */
	},
	"cml":{
		<text>:{	/* ID команды */
			"nm":<text>,	/* название команды */
			"cn":<text>	/* тип команды */
			"lt":<text>,	/* тип связи */
			"cp":<text>,	/* параметры команды */
		},
		...
	},
	"cml_max":<uint>	/* доступное количество команд */
}

Типы команд и связи рассмотрены в разделе Параметры команд.

Флаг - 0x00000400

{
	"pos":{			/* последнее известное местоположение */
		"t":<uint>,		/* время UTC */
		"f":<uint>,		/* флаги сообщения */
		"tp":<text>,		/* тип сообщения */
		"l":<text>,		/* местоположение */
		"y":<double>,		/* широта */
		"x":<double>,		/* долгота */
		"z":<int>,		/* высота над уровнем моря */
		"s":<int>,		/* скорость */
		"c":<int>,		/* курс */
		"sc":<int>		/* количество спутников */
		"y2":<double>,		/* широта, привязанная к дороге */
		"x2":<double>,		/* долгота, привязанная к дороге */
		"i":<uint>,		/* состояние цифровых входов */
		"o":<uint>,		/* состояние цифровых выходов */
		"p":{			/* параметры */
			<text>:<double>		/* название параметра: значение */
		}
	},
	"lmsg":<text>|{}		/* последнее известное сообщение, если его координаты совпадают с координатами из "pos" то значение данного поля будет равно "dup" */
}

Типы сообщений рассмотрены в разделе Форматы данных: Сообщения.

Флаг - 0x00000800

{
	"drv":<text>,		/* код водителя */
	"sens":{		/* датчики */
		<text>:{		/* номер датчика */
			"nm":<text>,	/* название */
			"tp":<text>,	/* тип */
			"de":<text>,	/* описание */
			"me":<text>,	/* единица измерения */
			"pn":<text>,	/* название параметра */
			"fl":<uint>,	/* флаги датчика */ 
			"tbl":[		/* таблица расчета */
				{		/* параметры */
					"x":<double>, 
					"a":<double>,
					"b":<double>
				}
			],
			"vt":<uint>,	/* тип валидации */
			"vs":<uint>	/* ID валидирующего датчика */
		}
	},
	"sens_max":<long>	/* количество датчиков, разрешенное тарифным планом (-1 - не ограничено) */
	"cfl":<uint>,		/* флаги калькуляции */
	"cnm":<uint>,		/* счетчик пробега, м */
	"cneh":<uint>,		/* счетчик моточасов, c */
	"si":{			/*записи о техобслуживании*/
		<text>:{		/* порядковый номер */
			"id":<uint>,	/* ID */
			"nm":<text>,	/* название */
			"txt":<text>,	/* описание */
			"im":<uint>,	/* интервал по пробегу */
			"ids":<uint>,	/* интервал в днях */
			"ie":<uint>,	/* интервал по моточасам */
			"pm":<uint>,	/* последнее техобслуживание для интервала по пробегу, км */
			"pd":<uint>,	/* последнее техобслуживание для интервала в днях (дата в секундах) */
			"pe":<uint>,	/* последнее техобслуживание для интервала по моточасам, ч */
			"sc":<uint>	/* количество выполнений */
		}
	},
	"simax":<long>		 /* количество записей, разрешенное тарифным планом (-1 - не ограничено) */
}
}

Флаги датчика, типы датчиков и валидации рассмотрены в разделе Датчики.

Флаг - 0x00001000

{
	"ugi":<uint>	/* счетчик изменений изображения */
}

Флаг - 0x00010000

{
	"rc":{		/* состояние маршрута на который назначен объект */
		<text>:{	/* индекс маршрута */
			"i":<uint>, 	/* индекс маршрута*/
			"nm":<text>, 	/* название */
			"de":<text>,	/* описание */
			"at":<uint>,	/* время активации */
			"fl":<long>,	/* флаги маршрута */
			"st":<long>,	/* состояние маршрута */
			"pt":<uint>,	/* индекс последней пройденной точки маршрута */
			"tm":<uint>,	/* время смены статуса */
			"ri":<long>,	/* ID ресурса */
			"z":<long>	/* ID геозоны */
		}
	},
 
	"rcmax":<long>	/* количество маршрутов, разрешенное тарифным планом (-1 - не ограничено) */
}

Флаги маршрута и его состояния рассмотрены в разделе Маршруты: создание, редактирование и удаление.