This API call is used to edit a user in an account. Any of the optional parameters that are not provided will remain unchanged on the edited user.
Required Information |
Name |
Description |
action |
adminusers |
operation |
edit |
format |
xml |
edituserid |
The id of the user to edit. |
Optional Information |
uname |
The new username for the user.(32 character limit) |
fname |
The new first name for the user.(32 character limit) |
lname |
The new last name for the user.(32 character limit) |
role |
The new role for the user.(16 character limit) See Get Roles for a list of locations. |
upassword |
The new password for the user. |
location |
The new location for the user. See Get Locations for a list of locations. |
isactive |
The new active status of the user, valid options are:
true - Set the user as active.
false - Set the user to inactive.
|
timezone |
The new timezone for the user, valid options are:
PST8PDT - US Pacific
MST - US Mountain/Arizona
MST7MDT - US Mountain
CST6CDT - US Central
EST - US Eastern/Indiana
EST5EDT - US Eastern
US/Alaska - US Alaska
US/Aleutian - US Alaska (Aleutians)
US/Hawaii - US HAwaii
America/Halifax - Canada: Atlantic Time
America/Regina - Canada: Central Standard Time
America/Winnipeg - Canada: Central Time
America/Montreal - Canada: Eastern Time
America/Dawson_Creek - Canada: Mountain Standard Time
America/Edmonton - Canada: Mountain Time - Alberta, East B.C. & West Saskatchewan
America/Vancouver - Canada: Pacific Time
Europe/London - United Kingdom: Great Britain
Europe/Belfast - United Kingdom: Northern Ireland
Pacific/Guam - Guam
Pacific/Chatham - New Zealand: Chatham Islands
Pacific/Auckland - New Zealand: most locations
Australia/Lord_howe - Australia: Lord Howe Island
Australia/Syndey - Australia: New South Wales
Australia/Darwin - Australia: Northern Territory
Australia/Brisbane - Australia: Queensland
Australia/Adelaide - Australia: South Australia
Australia/Hobart - Australia: Tasmania
Australia/Melbourne - Australia: Victoria
Australia/Perth - Australia: Western Australia
UTC - UTC
|
displaycount |
The new display count for the user, valid options are:
20
50
100
200
500
1000
2000
5000
|
email |
The new email for the user.(64 character limit) |
attrfilter |
The new attribute filter id for the user. |
Data Returned
Reply Data |
Name |
Description |
message_id |
The id of the user edited. |
Example Request
https://omi.zonarsystems.net/interface.php?customer=zzo2544&username=zonar&password=secret.pw.2019&action=adminusers&operation=edit&format=xml&edituserid=123&uname=testuser1
&fname=Test&lname=User&role=Admin&upassword=password&location=Home&isactive=true&timezone=PST8PDT&displaycount=20
Example Reply
<success ver="1">
<action>adminusers</action>
<message_id>123</message_id>
</success>