This API call is used to list all users in an account filtered by location and active status.
| Required Information | |
|---|---|
| Name | Description |
| action | adminusers |
| operation | list |
| format | xml |
| Optional Information | |
| locationid | The location id with which to filter users. Note: If no value is passed, users for all locations will be returned. |
| showinactive | The active filter to determine which users to show. Valid options are:
false is assumed.
|
| Reply Data | |
|---|---|
| Name | Description |
| id | The id of the user. |
| username | The username of the user. |
| fname | The first name of the user. |
| lname | The last name of the user. |
| role | The role of the user. |
| active | The active status of the user. |
| location id | The location id of the user. |
| location | The location name of the user. |
| The email of the user. | |
Example Request:
http://test.zonarsystems.net/interface.php?action=adminusers&operation=list&format=xml&locationid=1&showinactive=true
DTD:
<!ELEMENT users (user*)>
<!ATTLIST users ver CDATA #REQUIRED>
<!ELEMENT user (username, fname, lname, role, active, location, email)>
<!ELEMENT username (#PCDATA)>
<!ELEMENT fname (#PCDATA)>
<!ELEMENT lname (#PCDATA)>
<!ELEMENT role (#PCDATA)>
<!ELEMENT active (#PCDATA)>
<!ELEMENT location (#PCDATA)>
<!ATTLIST location id CDATA #REQUIRED>
<!ELEMENT email (#PCDATA)>