viewUsersByStatus
- Home
- Users & Groups
- SvcUsers
- viewUsersByStatus
viewUsersByStatus
Return a listing of users for a specific status; I.E.:active, suspended, etc…
Parameters
| Name | Description |
| page optional | The page of results to display. |
| perPage optional | The number of results to display per page. |
| status optional | The status of the user. |
| output optional | The response output format. Accepts JSON and XML. |
Request Syntax
| https://services.onesite.com/rest/svcUsers?action=viewAllUsers&page=1&perPage=2&status=good-standing&nodeID=188234&devkey=[devkey] |
JSON Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
{ "service":"svcUsers", "action":"viewAllUsers", "code":1, "message":"Success", "total":"37", "page":1, "per_page":2, "item":[ { "user_id":"220960047", "display_name":"adminuser", "first_name":"adminuser", "last_name":null, "email":"admin@onesitedemo.com", "domain":"onesitedemo.com/adminuser", "date_joined":"09/01/2016", "location":null, "account_status":"good-standing", "date_status_updated":"", "gender":"Female", "age":"49", "avatar":"http://images.onesite.com/onesitedemo.com/user/adminuser/avatar.jpg?type=user&ts=1548887109", "profile_img":"http://images.onesite.com/onesitedemo.com/user/adminuser/profile.jpg?type=user&ts=1548887109" }, { "user_id":"229751571", "display_name":"User", "first_name":"User", "last_name":null, "email":"john.doe@example.com", "domain":"onesitedemo.com/229751571", "date_joined":"01/08/2019", "location":null, "account_status":"good-standing", "date_status_updated":"", "gender":"Female", "age":"49", "avatar":"http://images.onesite.com/onesitedemo.com/user/229751571/avatar.jpg?type=user&ts=1548887109", "profile_img":"http://images.onesite.com/onesitedemo.com/user/229751571/profile.jpg?type=user&ts=1548887109" } ] } |
Service Information
| Service | svcUsers |
| Method | viewUsersByStatus |
| Type | REST |
| Response Types | JSON, XML |