Resources

Depending on set flags format of response can differ.

This chapter describes flags that can be applied to resources and parts of resulting JSON which they are responsible for. If you specify several flags, then parts will be united into one JSON.

All flags are only used in DEC format.

Resource flags:

Flag - 0x00000001

{
	"nm":<text>,	/* name */
	"cls":<uint>,	/* superclass ID: "avl_resource" */
	"id":<uint>,	/* resource ID */
	"mu":<uint>,	/* measure units: 0 - si, 1 - us, 2 - imperial, 3 - metric with gallons */
	"uacl":<uint>	/* current user access level for resource */
}

Flag - 0x00000002

You can store any resource data you need in custom properties.

{
	"prp":{				/* custom properties */
		"emails":"[<text>]",		/* list of e-mails for jobs */
		"nf_rep_emails":"[<text>]",	/* list of e-mail for notifications */
		"phones":"[<text>]",		/* list of phone numbers for job "Send fuel information by e-mail or SMS" */
		...
	},
	"ftp": {				/* FTP settings */
		"hs":<text>,			/* host */
		"lg":<text>,			/* login */
		"pt":<text>,			/* directory path */
		"ch": <uint>,			/* FTP settings validity: 1-yes, 0-no */
		"tp": <uint>,			/* use wialon hosting FTP: 1 - yes, 0 - no */
		"fl": <uint>			/* is wialon hosting FTP available: 1 - yes, 0 - no */
	}
}

Flag - 0x00000004

{
	"crt":<uint>,	/* creator ID */
	"bact":<uint>,	/* account ID */
	"bpact":<uint>	/* parrent account ID */
}

Flag - 0x00000008

{
	"flds":{	/* custom fields */		
		"<uint>":{	/* sequence number */
			"id":<uint>,	/* ID */
			"n":<text>,	/* name */
			"v":<text>	/* value */
		},
		...
	},
	"fldsmax":<long>,	/* maximal count of custom fields (-1 - unlimited) */
}

Flag - 0x00000020

After setting this flag you can receive resource messages.

{}

Flag - 0x00000040

{
	"gd":<text>	/* resource GUID */
}

Flag - 0x00000080

{
	"aflds":{	/* administrative fields */		
		"<uint>":{	/* sequence number */
			"id":<uint>,	/* ID */
			"n":<text>,	/* name */
			"v":<text>	/* value */
		},
		...
	},
	"afldsmax":<long>,	/* maximal count of administrative fields (-1 - unlimited) */
}

Flag - 0x00000100

{
	"drvrs":{
		<text>:{	/* sequence number of driver */
			"id":<long>,	/* ID */
			"n":<text>,	/* name */
			"c":<text>,	/* code */
			"pwd":<text>,   /* password for mobile authorization */
			"ej":<text>,    /* extentended JSON */
			"jp": {			/* custom fields */
				<text>:<text>,		/* name: value */
				...
			},
			"ds":<text>,	/* description */
			"p":<text>,	/* phone number */
			"r":<double>,	/* image aspect ratio */
			"ck":<ushort>	/* check sum (CRC16) */
			"bu":<long>,	/* binded unit */
			"pu":<long>,	/* previous binded unit */
			"bt":<uint>,	/* time of last binging/unbinding */
			"pos":{		/* last position, null - if driver is bound to unit */
				"y":<double>,	/* latitude */
				"x":<double>	/* longitude */
			},
			infr: { /*parameters for analysis infringements of work and rest of drivers AETR */
				"a": <uint>,	/* current activity */
				"t": <uint>,	/* the start time of this activity */
				"ud": <uint>,	/* duration of uninterrupted driving before the current activity */
				"ur": <uint>,	/* duration of uninterrupted rest before the current activity */
				"uil": <uint>,	/* allowed duration of uninterrupted driving */
				"uim": <uint>,	/* duration of uninterrupted driving to which the violation is infringement minor */
				"uis": <uint>,	/* duration of uninterrupted driving to which the violation is infringement serious (above - very serious) */
				"uir": <uint>,	/* duration of required rest */
				"ddt": <uint>,	/* daily driving time before the current activity */
				"dbt": <uint>,	/* start time of daytime activity */
				"ddc": <uint>,	/* allowed number of prolonged daily driving in this week */
				"ddil": <uint>,	/* allowed duration of daily driving */
				"ddim": <uint>,	/* allowed duration of daily driving (minor infringement ) */
				"ddis": <uint>,	/* allowed duration of daily driving (serious infringement(above very serious)) */
				"wdt": <uint>,	/* duration of weekly driving before the current activity */
				"wdil": <uint>,	/* allowed duration of weekly driving */
				"wdim": <uint>,	/* allowed duration of weekly driving (minor infringement) */
				"wdis": <uint>,	/* allowed duration of weekly driving (serious infringement(above very serious)) */
				"twdt": <uint>,	/* duration for two weeks of driving before the current activity */
				"twdil": <uint>,/* allowed duration for two weeks of driving */
				"twdim": <uint>,/* allowed duration for two weeks of driving (minor infringement) */
				"twdis": <uint>,/* allowed duration for two weeks of driving (serious infringement(above very serious)) */
				"drt": <uint>,	/* duration of the previous daily rest */
				"drd": <uint>,	/* duration of the required daily rest */
				"dril": <uint>,	/* time before which daily rest should occure */
				"drim": <uint>,	/* time before which an infringement is considered to be minor */
				"dris": <uint>,	/* time before which an infringement is considered to be serious(above very serious) */
				"wrt": <uint>,	/* duration of the previous weekly rest */
				"wrd": <uint>,	/* duration of the required weekly rest */
				"wril": <uint>,	/* time before which weekly rest should occure */
				"wrim": <uint>,	/* time before which an infringement is considered to be minor */
				"wris": <uint>	/* time before which an infringement is considered to be serious(above very serious) */
			}
		},
		...
	},
	"drvrsmax":<long>	/* maximal count of drivers (-1 - unlimited) */
}

Flag - 0x00000200

{
	"ujb":{
		<text>:{		/* sequence number of job */
			"id":<uint>,		/* ID */
			"n":<text>,		/* name */
			"d":<text>,		/* description */
			"m":<uint>,		/* maximal allowed executions count */
			"st":{			/* state */
				"e":<uint>,		/* active/inactive */
				"c":<uint>,		/* executions count */
				"l":<uint>		/* last execution time */
			},
			"act":<text>		/* action type */
		},
		...
	},
	"ujbmax":<long>,	/* maximal count of jobs (-1 - unlimited) */
}

Types of actions are described in the chapter Jobs: detailed information.

Flag - 0x00000400

{
	"unf":{
		<text>:{	/* sequence number of notification */
			"id":<long>,	/* ID */
			"n":<text>,	/* name */
			"ta":<uint>,	/* activation time */
			"td":<uint>,	/* deactivation time */
			"ma":<uint>,	/* maximal alarms count (0 - unlimited) */
			"fl":<uint>,	/* notification types */
			"ac":<uint>,	/* alarms count */
			"un":[<long>],	/* array of units IDs */
			"act":[<text>],	/* actions list */
			"trg":<text>,	/* type of control */
			"crc":<long>	/* check sum of binary view of notification */
		},
		...
	},
	"unfmax":<long>,	/* maximal count of notifications (-1 - unlimited) */
}

Action types, control types and notification flags are described in the chapter Notifications: detailed information.

Flag - 0x00000800

>
{
	"poi":{
		<text>:{	/* sequence number of POI */
			"id":<long>,	/* ID */
			"n":<text>,	/* name */
			"y":<double>,	/* latitude */
			"x":<double>,	/* longitude */
			"t":<double>,	/* image aspect ratio */
			"i":<short>,	/* check sum of image (CRC16) */
			"e":<ushort>	/* check sum of POI (CRC16) */
		},
		...
	},
	"poimax":<long>		/* maximal count of POIs (-1 - unlimited) */
}

Flag - 0x00001000

{
	"zl":{
		<text>:{	/* sequence number of geofence */
			"n":<text>,	/* name */
			"d":<text>,	/* description */
			"id":<long>,	/* ID */
			"f":<uint>,	/* flags */
			"t":<int>,	/* type: 1 - line, 2 - polygon, 3 - circle */
			"e":<ushort>	/* check sum (CRC16) */
			"b":{	/* configuration for rendering geofences */
				"min_x":<double>,	/* minimal longitude */
				"min_y":<double>,	/* minimal latitude */
				"max_x":<double>,	/* maximal longitude */
				"max_y":<double>,	/* maximal latitude */
				"cen_x":<double>,	/* longitude of center  */
				"cen_y":<double>	/* latitude of center */
			}			
		},
		...
	},
	"zlmax":<long>	/* maximal count of geofences (-1 - unlimited) */
}

Geofence flags are described in the chapter Geofences: detailed information.

Flag - 0x00002000

{
	"rep":{
		<text>:{	/* sequence number of template */
			"id":<long>,	/* ID */
			"n":<text>,	/* name */
			"ct":<text>,	/* template type */
			"c":<ushort>	/* check sum (CRC16) */
		},
		...
	},
	"repmax":<long>	/* maximal count of templates (-1 - unlimited) */
}

Types of templates are described in the chapter Get templates data.

Flag - 0x00004000

{
	"drvrun":[<long>]	/* array IDs of auto attachable units */
}

Flag - 0x00008000

{
	"drvrsgr":{	/* driver groups */
		<text>:{	/* sequence number of group */
			"id":<long>,	/* group ID */
			"n":<text>,	/* name */
			"d":<text>,	/* description */
			"drs":[<uint>]	/* array of drivers IDs */
		},
		...
	},
	"drvrsgrmax":<long>	/* maximal count of driver groups (-1 - unlimited) */
}

Flag - 0x00010000

{
	"trlrs":{	/* trailers */
		<text>:{	/* sequence number of trailer */
			"id":<long>,	/* trailer ID */
			"n":<text>,	/* name */
			"c":<text>,	/* code */
			"ej":<text>,    /* extentended JSON */
			"jp":{		/* custom fields */
				<text>:<text>,	/* name: value */
				...
			},
			"ds":<text>,	/* description */
			"p":<text>,	/* phone number */
			"r":<double>,	/* image aspect ratio */
			"ck":<short>,	/* check sum of image */
			"bu":<long>,	/* binded unit */
			"pu":<long>,	/* previous binded unit */
			"bt":<uint>,	/* time of last binding/unbinding */
			"pos":{		/* position */
				"y":<double>,	/* latitude */
				"x":<double>	/* longitude */
			}
		}
	},
	"trlrsmax":<long>	/* maximal count of trailers (-1 - unlimited) */
}

Flag - 0x00020000

{
	"trlrsgr":{	/* trailer groups */
		<text>:{	/* sequence number of group */
			"id":<long>,	/* group ID */
			"n":<text>,	/* name */
			"d":<text>,	/* description */
			"drs":[<uint>]	/* array of trailers IDs */
		}
	},
	"trlrsgrmax":<long>	/* maximal count of trailer groups (-1 - unlimited) */
}

Flag - 0x00040000

{
	"trlrun":[<long>]	/* array IDs of auto attachable units */
}

Флаг - 0x00080000

{
   "orders":{
        "<uint>": {      /* order number, the same as in "id" param */
		    "id":<uint>,	/* order id within resource */
		    "n":<text>,	        /* order name */
		    "p":{		/* user-defined object content */
			    ...
		    },
		    "f":<bool>,	        /* order flags: 1 - order would be marked as completed if there were at least one message within order area with zero speed in it */
		    "tf":<uint>,        /* lower bound of order completion time */
		    "tt":<uint>,        /* upper bound of order completion time  */
		    "uid":<uint>,	/* unique id (is used as unique key in order history) */
		    "r":<uint>,	        /* order point radius */
		    "y":<double>,	/* order point lattitude */
		    "x":<double>,	/* order point longitude */
		    "u":<long>,	        /* unit id */
		    "s":<uint>,	        /* order status: 0 - inactive (no unit assigned), 1 - active (unit assigned), 2 - completed in time, 3 - completed overdue, 4 - cancelled (not used) */
		    "st":<uint>	        /* last status modification time */
	},
        ...
   }
}

Flag - 0x00100000

{
	"zg":{	/* geofences groups */
		<text>:{	/* sequence number of group */
			"id":<long>,	/* group ID */
			"n":<text>,	/* name */
			"d":<text>,	/* description */
			"drs":[<uint>]	/* array of geofences IDs */
		},
		...
	},
	"zgmax":<long>	/* maximal count of geofences groups (-1 - unlimited) */
}

Flag - 0x00200000

"item": {
    "tags": {
	<uint>: {			/* tag id*/
	    "id": <uint>,		/* tag id*/
	    "n": <text>,		/* tag name*/
	    "c": <text>,		/* tag code */
	    "jp": {<text>:<text> },	/* custom fields, key:value */
	    "r": <double>,		/* image aspect ratio */
	    "ck":<ushort>		/* check sum (CRC16) */
	    "bu": <long>,		/* binded unit */
	    "pu": <long>,		/* previous binded unit */
	    "bt": <uint>,		/* last binding/unbinding time */
	    "tz": <int>,		/* time zone */
	    "art": <int>,		/* automatic time unbinding  */
	    "pos": {			/* position */
		"y": <double>,		/* latitude */
		"x": <double>		/* longitude */
	    }
	},
	...
    },
    tagsmax: -1				/* maximum number of tags */
},

Flag - 0x00400000

{
    "tagrun":[<long>]	/* array of units ID's for automatic binding */
}

Flag - 0x00800000

{
    "tagsgr": {     		
	<long>: {		/* group ID */
	    "id": <long>,	/* group ID */
	    "n": <text>,	/* group name */
	    "d": <text>,	/* description */
	    "tgs": [<uint>]	/* tags ID's array */
	},
	...
    }
    "tagsgrmax": -1		/* maximum number of groups */
}