Users Advanced: UpdateUserPreferencesUpadates the preferences of a user

See Also

Usage Notes

DateFormat Legend

hh
Two digit hour
Example: 05 or 11
h
One or two digit hour
Example: 5 or 11
HH
Two digit 24-hour
Example: 05 or 17
H
One or two digit 24-hour
Example: 5 or 17
mm
Two digit minunte
Example: 09 or 38
m
One or two digit minunte
Example: 9 or 38
ss
Two digit second
Example: 02 or 46
s
One or two digit second
Example: 2 or 46
tt
Two character meridium
Example: AM or PM
t
One character meridium
Example: a or p

TimeFormat Legend

yyyy
Four digit year
Example: 1979 or 2009
yy
Two digit year
Example: 79 or 09
MMMM
Month name
Example: November
MMM
Month abbreviation
Example: Nov
MM
Two digit month
Example: 08 or 12
M
One or two digit month
Example: 8 or 12
ddd
Day name
Example: Tuesday
dd
Two digit date
Example: 06 or 28
d
One or two digit date
Example: 6 or 28

The following parameters are appiled to the UI profile for the User when Fleet Freedom initializes.

The StartupFocus, StartupLoad, StartupLabels, and StartupLayers parameters take a comma separated list of values.

StartupMapType takes only one of the values listed.

StartupLat, StartupLong, and StartupZoom are only applied if no StartupFocus objects are specified.

The valid values for each parameter are:

StartupFocus, StartupLoad, and StartupLabels
  • device
  • zone
  • location
  • route
StartupLayers
  • traffic
  • evse
  • weather
StartupMapType
  • map
  • hybrid
  • terrain
  • satellite
StartupLat
A number between -90 and 90.
StartupLong
A number between -180 and 180.
StartupZoom
A number between 2 and 16.

Example of Returned Data

<UpdateUserPreferences Success="?" Message="" />

Test Method

ParameterValueTypeUsage
UserIDint32Unique user identifier
TimeZoneIDint32The unique identifier of the Timezone as defined by APITimeZonesList
UseMetricbooleanFlag to use Metric or US Standard unit values (for display, method calls are all in metric)
DateFormatstringSee Usage Notes.
Format for dates
TimeFormatstringSee Usage Notes.
Format for times
StartupFocusstringSee Usage Notes.
The map will centre around the specified types of objects' positions.
StartupLoadstringSee Usage Notes.
Automatically load these types of objects.
StartupLabelsstringSee Usage Notes.
Display the labels of these types of objects on the map.
StartupLayersstringSee Usage Notes.
Show these types of layers.
StartupMapTypestringSee Usage Notes.
Map will default to the specified style.
StartupLatdoubleSee Usage Notes.
The initializing latitude for the map.
StartupLongdoubleSee Usage Notes.
The initializing longitude for the map.
StartupZoombyteSee Usage Notes.
The initializing zoom level for the map.