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

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

Все флаги используются только в DEC формате.

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

Флаг - 0x00000001

{
	"nm":<text>,	/* название */
	"cls":<uint>,	/* ID базового класса "avl_resource" */
	"id":<uint>,	/* ID ресурса */
	"mu":<uint>,	/* единицы измерения: 0 - si, 1 - us, 2 - имперская, 3 - метрическая с галлонами */
	"uacl":<uint>	/* уровень доступа к ресурсу у текущего пользователя */
}

Флаг - 0x00000002

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

{
	"prp":{					/* произвольные свойства */
		"emails":"[<text>]",		/* список e-mail для заданий */
		"nf_rep_emails":"[<text>]",	/* список e-mail для уведомлений */
		"phones":"[<text>]",		/* список телефонов для задания "отправить информацию о топливе" */
		...
	},
	"ftp": {				/* настройки FTP */
		"hs":<text>,			/* хост */
		"lg":<text>,			/* логин */
		"pt":<text>,			/* путь к папке */
		"ch": <uint>,			/* валидность настроек FTP: 1-да(по умолчанию), 0-нет */
		"tp": <uint>,			/* отправлять данные на wialon hosting FTP: 1 - да, 0 - нет */
		"fl": <uint>			/* признак наличия wialon hosting FTP: 1 - да, 0 - нет */
	}
}

Флаг - 0x00000004

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

Flag - 0x00000008

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

Флаг - 0x00000020

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

{}

Флаг - 0x00000040

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

Flag - 0x00000080

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

Флаг - 0x00000100

{
	"drvrs":{
		<text>:{	/* порядковый номер водителя */
			"id":<long>,	/* ID */
			"n":<text>,	/* имя */
			"c":<text>,	/* код */
			"pwd":<text>,   /* пароль, необходимый для мобильной авторизации */
			"ej":<text>,    /* произвольный JSON */
			"jp": {			/* произвольные поля */
				<text>:<text>,		/* название: значение */
				...
			},
			"ds":<text>,	/* описание */
			"p":<text>,	/* телефонный номер */
			"r":<double>,	/* соотношение сторон изображения */
			"ck":<ushort>	/* контрольная сумма (CRC16) */
			"bu":<long>,	/* назначенный объект */
			"pu":<long>,	/* предыдущий назначенный объект */
			"bt":<uint>,	/* время последнего назначения/снятия */
			"pos":{		/* последнее местоположение , если водитель назначен возвращается нулевые значения*/
				"y":<double>,	/* широта */
				"x":<double>	/* долгота */
			},
			infr: { /*параметры для определения нарушений режима труда и отдыха водителей по ЕСТР */
				"a": <uint>,	/* тип текущей активности (0 — отдых, 1 — доступность, 2 — работа, 3 — вождение) */
				"t": <uint>,	/* время начала этой активности в Unix time формате */
				"ud": <uint>,	/* длительность непрерывного вождения до наступления текущей активности */
				"ur": <uint>,	/* длительность непрерывного отдыха до наступления текущей активности */
				"uil": <uint>,	/* допустимая длительность непрерывного вождения (270 мин) */
				"uim": <uint>,	/* длительность непрерывного вождения до которого нарушение считается незначительным (300 мин) */
				"uis": <uint>,	/* длительность непрерывного вождения до которого нарушение считается значительным (360 мин); свыше - критическим */
				"uir": <uint>,	/* длительность необходимого отдыха (45 минут за каждые 4.5 часа) */
				"ddt": <uint>,	/* время управления до текущей активности (суммарное вождение) */
				"dbt": <uint>,	/* время начала дневной активности */
				"ddc": <uint>,	/* сколько раз на этой неделе можно продлить время ежедневного вождения (уменьшается с 2 до 0; связан с ddil, ddim, ddis) */
				"ddil": <uint>,	/* допустимая длительность ежедневного вождения (при ddc:0 значение 600 мин, иначе 540 мин) */
				"ddim": <uint>,	/* допустимая длительность ежедневного вождения, до которого нарушение считается незначительным (при ddc:0 значение 660 мин, иначе 600 мин) */
				"ddis": <uint>,	/* допустимая длительность ежедневного вождения, до которого нарушение считается значительным (при ddc:0 значение 720 мин, иначе 660 мин); свыше - критическим */
				"wdt": <uint>,	/* длительность еженедельного вождения до наступления текущей активности */
				"wdil": <uint>,	/* допустимая длительность еженедельного вождения (3360 мин) */
				"wdim": <uint>,	/* допустимая длительность еженедельного вождения, до которого нарушение считается незначительным (3600 мин) */
				"wdis": <uint>,	/* допустимая длительность еженедельного вождения, до которого нарушение считается значительным (4200 мин); свыше - критическим */
				"twdt": <uint>,	/* длительность двухнедельного вождения до наступления текущей активности */
				"twdil": <uint>,/* допустимая длительность двухнедельного вождения (5400 мин) */
				"twdim": <uint>,/* допустимая длительность двухнедельного вождения, до которого нарушение считается незначительным (6000 мин)  */
				"twdis": <uint>,/* допустимая длительность двухнедельного вождения, до которого нарушение считается значительным (6750 мин); свыше - критическим */
				"drt": <uint>,	/* длительность предыдущего отдыха (ежедневный отдых) */
				"drd": <uint>,	/* длительность необходимого ежедневного отдыха (660 мин обычный, 540 мин сокращенный) */
				"dril": <uint>,	/* время, до которого должен наступить ежедневный отдых */
				"drim": <uint>,	/* время в Unix time формате, до которого нарушение периода отдыха считается незначительным (на 60 мин больше) */
				"dris": <uint>,	/* время в Unix time формате, до которого нарушение периода отдыха считается значительным (на 120 мин больше); свыше — критическим */
				"wrt": <uint>,	/* длительность предыдущего отдыха (еженедельный отдых) */
				"wrd": <uint>,	/* длительность необходимого еженедельного отдыха (обычный в 2700 мин или сокращенный в 1440 мин) */
				"wril": <uint>,	/* время, до которого должен наступить еженедельный отдых */
				"wrim": <uint>,	/* время в Unix time формате, до которого нарушение периода отдыха считается незначительным (на 120 мин больше) */
				"wris": <uint>	/* время в Unix time формате, до которого нарушение периода отдыха считается значительным (на 240 мин больше); свыше — критическим */
			}
		},
		...
	},
	"drvrsmax":<long>	/* максимальное количество водителей, разрешенное тарифным планом (-1 - не ограничено) */
}

Флаг - 0x00008000

{
	"drvrsgr":{	/* группы водителей */
		<text>:{	/* порядковый номер группы */
			"id":<long>,	/* ID группы */
			"n":<text>,	/* название */
			"d":<text>,	/* описание */
			"drs":[<uint>]	/* массив ID водителей */
		},
		...
	},
	"drvrsgrmax":<long>	/* максимальное количество групп водителей, разрешенное тарифным планом (-1 - не ограничено) */
}

Флаг - 0x00000200

{
	"ujb":{
		<text>:{		/* порядковый номер задания */
			"id":<uint>,		/* ID */
			"n":<text>,		/* название */
			"d":<text>,		/* описание */
			"m":<uint>,		/* максимальное разрешенное количество выполнений */
			"st":{			/* состояние */
				"e":<uint>,		/* активно/неактивно */
				"c":<uint>,		/* количество выполнений */
				"l":<uint>		/* время последнего выполнения */
			},
			"act":<text>		/* тип действия */
		},
		...
	},
	"ujbmax":<long>,	/* максимальное количество заданий, разрешенное тарифным планом (-1 - не ограничено) */
}

Типы действий рассмотрены в разделе Задания: подробная информация.

Флаг - 0x00000400

{
	"unf":{
		<text>:{		/* порядковый номер уведомления */
			"id":<long>,	/* ID */
			"n":<text>,	/* название */
			"ta":<uint>,	/* время активации */
			"td":<uint>,	/* время деактивации */
			"ma":<uint>,	/* максимальное количество срабатываний */
			"fl":<uint>,	/* флаги уведомлений */
			"ac":<uint>,	/* количество срабатываний */
			"un":[<long>],	/* массив идентификаторов объектов */
			"act":[<text>],	/* список действий */
			"trg":<text>,	/* тип контроля */
			"crc":<long>	/* контрольная сумма бинарного представления уведомления */
		},
		...
	},
	"unfmax":<long>,	/* максимальное количество уведомлений, разрешенное тарифным планом (-1 - не ограничено) */
}

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

Флаг - 0x00000800

>
{
	"poi":{
		<text>:{		/* порядковый номер POI */
			"id":<long>,	/* ID */
			"n":<text>,	/* название */
			"y":<double>,	/* широта */
			"x":<double>,	/* долгота */
			"t":<double>,	/* соотношение сторон изображения */
			"i":<short>,	/* контрольная сумма POI (CRC16) */
			"e":<ushort>	/* контрольная сумма изображения (CRC16) */
		},
		...
	},
	"poimax":<long>		/* максимальное количество POI, разрешенное тарифным планом (-1 - не ограничено) */
}

Флаг - 0x00001000

{
	"zl":{
		<text>:{	/* порядковый номер геозоны */
			"n":<text>,	/* название */
			"d":<text>,	/* описание */
			"id":<long>,	/* ID */
			"f":<uint>,	/* флаги */
			"t":<int>,	/* тип: 1 - линия, 2 - полигон, 3 - круг */
			"e":<ushort>	/* контрольная сумма (CRC16) */
			"b":{	/* конфигурация для отрисовки геозон */
				"min_x":<double>,	/* минимальная долгота */
				"min_y":<double>,	/* минимальная широта */
				"max_x":<double>,	/* максимальная долгота */
				"max_y":<double>,	/* максимальная широта */
				"cen_x":<double>,	/* долгота центра  */
				"cen_y":<double>	/* широта центра */
			}			
		},
		...
	},
	"zlmax":<long>	/* максимальное количество геозон, разрешенное тарифным планом (-1 - не ограничено) */
}

Флаги геозон рассмотрены в разделе Геозоны: подробная информация.

Флаг - 0x00100000

{
	"zg":{	/* группы геозон */
		<text>:{	/* порядковый номер группы */
			"id":<long>,	/* ID группы */
			"n":<text>,	/* название */
			"d":<text>,	/* описание */
			"zns":[<uint>]	/* массив ID геозон */
		}
	},
	"zgmax":<long>	/* максимальное количество групп геозон, разрешенное тарифным планом (-1 - не ограничено) */
}

Флаг - 0x00002000

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

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

Флаг - 0x00004000

{
	"drvrun":[<long>]	/* массив ID объектов для автоматического прикрепления */
}

Флаг - 0x00010000

{
	"trlrs":{	/* прицепы */
		<text>:{	/* порядковый номер прицепа */
			"id":<long>,	/* ID  прицепа */
			"n":<text>,	/* название */
			"c":<text>,	/* код */
			"ej":<text>,    /* произвольный JSON */
			"jp":{		/* произвольные поля */
				<text>:<text>,	/* название поля: значение */
				...
			},
			"ds":<text>,	/* описание */
			"p":<text>,	/* телефонный номер */
			"r":<double>,	/* соотношение сторон изображения прицепа */
			"ck":<short>,	/* контрольная сумма изображения прицепа */
			"bu":<long>,	/* назначенный объект */
			"pu":<long>,	/* предыдущий назначенный объект */
			"bt":<uint>,	/* время последнего назначения/снятия объекта */
			"pos":{		/* местоположение */
				"y":<double>,	/* широта */
				"x":<double>	/* долгота */
			}
		}
	},
	"trlrsmax":<long>	/* максимальное количество групп прицепов, разрешенное тарифным планом (-1 - не ограничено) */
}

Флаг - 0x00020000

{
	"trlrsgr":{	/* группы прицепов */
		<text>:{	/* порядковый номер группы */
			"id":<long>,	/* ID группы */
			"n":<text>,	/* название */
			"d":<text>,	/* описание */
			"drs":[<uint>]	/* массив ID прицепов */
		}
	},
	"trlrsgrmax":<long>	/* максимальное количество групп прицепов, разрешенное тарифным планом (-1 - не ограничено) */
}

Флаг - 0x00040000

{
	"trlrun":[<long>]	/* массив ID объектов для автоматического прикрепления */
}

Флаг - 0x00080000

{
   "orders":{
        "<uint>": {      /* номер заказа, дублируется в параметре "id" */
		    "id":<uint>,	/* id заказа внутри ресурса */
		    "n":<text>,	        /* имя заказа */
		    "p":{		/* пользовательский объект */
			    ...
		    },
		    "f":<bool>,	        /* флаги заказа: 1 - для успешного завершения заказа в области заказа должно быть отправлено хотя бы одно сообщение с нулевой скоростью */
		    "tf":<uint>,	/* начальное разрешенное время доставки */
		    "tt":<uint>,	/* последнее разрешенное время доставки  */
		    "uid":<uint>,	/* уникальный id (нужен для уникальности заказа в истории) */
		    "r":<uint>,	        /* радиус точки заказа */
		    "y":<double>,	/* широта */
		    "x":<double>,	/* долгота */
		    "u":<long>,	        /* id объекта */
		    "s":<uint>,	        /* статус: 0 - неактивный (не привязан объект), 1 - активный, 2 - завершен вовремя, 3 - завершен с опозданием, 4 - отклонён */
		    "st":<uint>	        /* время последней смены статуса */
	},
        ...
   }
}

Флаг - 0x00200000

"item": {
    "tags": {
	<uint>: {			/* id метки*/
	    "id": <uint>,		/* id метки*/
	    "n": <text>,		/* имя метки*/
	    "c": <text>,		/* код метки */
	    "jp": {<text>:<text> },	/* произвольные поля, ключ:значение */
	    "r": <double>,		/* соотношение сторон изображения */
	    "ck":<ushort>		/* контрольная сумма (CRC16) */
	    "bu": <long>,		/* назначенный объект */
	    "pu": <long>,		/* предыдущий назначенный объект */
	    "bt": <uint>,		/* время последнего назначения/снятия */
	    "tz": <int>,		/* временная зона */
	    "art": <int>,		/* время автоматического снятия */
	    "pos": {			/* местоположение */
		"y": <double>,		/* широта */
		"x": <double>		/* долгота */
	    }
	},
	...
    },
    tagsmax: -1				/* максимально разрешенное количество меток */
},

Флаг - 0x00400000

{
    "tagrun":[<long>]	/* массив ID объектов для автоматического прикрепления */
}

Флаг - 0x00800000

{
    tagsgr: {     		/* группы меток*/
	<long>: {		/* ID группы */
	    id: <long>,		/* ID группы */
	    n: <text>,		/* имя группы */
	    d: <text>,	/* описание группы */
	    tgs: [<uint>]	/* массив ID меток в группе */
	},
	...
    }
    tagsgrmax: -1		/* ограничение на количество групп */
}