Users

Depending on set flags format of response can differ.

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

User flags:

Value Description
0x00000001 base flag
0x00000002 custom properties
0x00000004 billing properties
0x00000008 access level
0x00000010 custom fields
0x00000020 GUID
0x00000040 messages
0x00000100 other properties
0x00000400 phone numbers
0x00001000 notifications

General properties

Flag - 0x00000001

{
	"nm":<text>,	/* user name */
	"cls":<uint>,	/* superclass ID: "user" */
	"id":<uint>	/* user ID */
}

Custom properties

Flag - 0x00000002

You can store any user data you need in custom properties. Usually, such settings are user's e-mail, map position after launching etc.

{
	"prp":{		/* custom properties */
		<text>:<text>,	/* name: value */
		...
	},
	"pup":{		/* private and public properties */
		<text>:<text>,	/* name: value */
		...
	}
}

Billing

Flag - 0x00000004

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

Access level

Flag - 0x00000008

{
	"acl":{			/* access level */
		<text>:<uint>,	/* item ID: access rights */
		...
	}
}

Access rights are examined in chapter Get access level.

Custom fields

Flag - 0x00000010

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

GUID

Flag - 0x00000020

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

Messages

Flag - 0x00000040

After setting this flag you can receive messages from unit.

{}

Other properties

Flag - 0x00000100

{
	"fl":<uint>	/* user settings flags */
}

The list of user settings flags is given in the chapter Set user settings flags.

Phone numbers

Flag - 0x00000400

{
	"smsp":<text>	/* user phones (comma-separated) */
}

Notifications

Flag - 0x00001000

{
	"usnf":{	/* user notifications */
		<text>:{		/* sequence number */
			"t":<uint>,		/* lifetime (sec) */
			"d":<text>,		/* text of notification */
			"h":<text>,		/* subject */
			"s":<text>		/* sender */
		},
		...
	}
}
Follow us on Facebook Gurtam Wialon Twitter Gurtam Wialon info@gurtam.com   |   Copyright © 2002-2019 Gurtam