Unit groups

Depending on set flags format of response can differ.

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

:!: All flags are only used in DEC format.

Unit group flags:

Value HEX Value HEX Description
0x00000001 1 base flag
0x00000002 2 custom properties
0x00000004 4 billing properties
0x00000008 8 custom fields
0x00000010 16 image
0x00000040 64 GUID
0x00000080 128 administrative fields
0x3FFFFFFFFFFFFFFF 4611686018427387903 set all possible flags to unit group

General properties

Flag - 0x00000001

{
	"nm":<text>,	/* name */
	"cls":<uint>,	/* superclass ID: "avl_unit_group" */
	"id":<uint>,	/* group ID */
	"u":[<long>],	/* array of group units */
	"uacl":<uint>	/* current user access level for unit group */
}

Custom properties

Flag - 0x00000002

You can store any data you need in custom properties.

{
	"prp":{}	/* custom properties */
}

Billing

Flag - 0x00000004

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

Custom fields

Flag - 0x00000008

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

Unit group image

Flag - 0x00000010

{
	"ugi":<uint>	/* image changes counter */
}

GUID

Flag - 0x00000040

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

Administrative fields

Flag - 0x00000080

{
	"aflds":{	/* administrative fields */		
		<text>:{	/* sequence number */
			"id":<uint>,	/* ID */
			"n":<text>,	/* name */
			"v":<text>	/* value */
		},
		...
	},
	"afldsmax":<long>,	/* maximal count of administrative fields (-1 - unlimited) */
}
Follow us on Facebook Gurtam Wialon Twitter Gurtam Wialon info@gurtam.com   |   Copyright © 2002-2020 Gurtam