Round information

To get detailed round information, use the command route/get_round_data:

svc=route/get_round_data&params={"itemId":<long>,
				 "col":[<long>]}

Parameters

Name Description
itemId route ID
col array of rounds IDs

Response

[
	{
		"id":<long>,	/* round ID */
		"n":<text>,	/* name */
		"d":<text>,	/* description */
		"tz":<uint>,	/* timezone */
		"u":<long>,	/* unit appointed to this round: if not specified - first unit of "cu" array which goes out from the first check point */
		"cu":[<long>],	/* array of unit IDs */
		"pt":[		/* check points */
			{
				"n":<text>,	/* name */
				"f":<uint>,	/* type */
				"u":<long>,	/* unit ID, 0 - if check point not of the type: check point from unit */
				"y":<double>,	/* latitude */
				"x":<double>,	/* longitude */
				"r":<uint>	/* radius */
			}
		],
		"sh":{		/* schedule */
			"id":<long>,	/* ID */
			"n":<text>,	/* name */
			"f":<uint>,	/* type */
			"tz":<uint>,	/* timezone */
			"cfg":{		/* custom configuration (example) */
				"enabled":<byte>,	/* auto create rounds for current schedule: 1 - enable, 0 - disable */
				"name":<text>,		/* name */
				"roundFlags":<uint>,	/* round flags (see below) */
				"units":[<long>],	/* array of units IDs */
				"validityPeriod":<uint>	/* validity period */
			},
			"tm":[		/* time of passing points */
				{
					"at":<uint>,	/* arrival time */
					"ad":<uint>,	/* deviation from arrival time */
					"dt":<uint>,	/* departure time */
					"dd":<uint>	/* deviation from departure time */
				}
			],
			"sch":{		/* time limitation */
				"f1":<uint>,	/* beginning of interval 1 */
				"f2":<uint>,	/* beginning of interval 2 */
				"t1":<uint>,	/* ending of interval 1 */
				"t2":<uint>,	/* ending of interval 2 */
				"m":<uint>,	/* days of month mask */
				"y":<uint>,	/* months mask */
				"w":<uint>	/* days of week mask */
			}
		},
		"at":<uint>,	/* activation time */
		"vt":<uint>,	/* time from which validity period begins */
		"vp":<uint>,	/* validity period */
		"f":<uint>,	/* round flags (see below) */
		"st":{		/* round state */
			"st":{		/* general round state */
				"pi":<uint>,	/* check point index, if 4294967295 - round isn't started */	
				"ps":<uint>,	/* state flags + event flags (see below) */
				"ut":<uint>	/* last event time */
			},
			"pts":{ 	/* state by points */
				<text>:{	/* check point ID */
					"st": <uint>,	/* event flags (see below) */
					"tm": <uint>	/* last event time */
				},
				...
			}
		}
	}
]

Types of check points are described in the chapter Update check points.

Schedule types are described in the chapter Schedules: create, edit, delete.

Round flags
Flag Description
0x0 check points order: strict
0x2 remove finished rounds from the timeline
0x10 check points order: skipping possible
0x20 allows to make reports upon performance on a round
0x40 check points order: arbitrary
Round state flags
Flag Description
0x010000 not active
0x020000 finished
0x040000 expecting arrival
0x080000 expecting departure
0x200000 is late
0x400000 outrun
0x800000 stopped
Event flags
Flag Description
0x1 round begins
0x2 round finished
0x4 round aborted
0x8 arrive in check point
0x10 pass check point
0x20 depart from check point
0x40 registered late arrival
0x80 registered outrun
0x100 pass check point in time
0x200 delayed arrival
Follow us on Facebook Gurtam Wialon Twitter Gurtam Wialon info@gurtam.com   |   Copyright © 2002-2020 Gurtam