{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/users/view.json","auth":"required","method":"get","params":[{"name":"type","type":"string","default":"ALL","desc":"Type of user. The accepted types are: \"admin\" and \"driver\"","required":true,"in":"query","ref":"","_id":"5593de970e82e81700334e2d"}],"results":{"codes":[{"code":"{  \n   \"userResponseVO\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"messageCode\": null,\n      \"generatedAt\":\"Dec-21-2015, 05:39 AM UTC\",\n      \"currentPage\":null,\n      \"totalPages\":null,\n      \"users\":[  \n         {  \n            \"userId\": \"76a3a779-6706-11e6-83dc-1fc5d0a52cbb\",\n            \"firstName\": \"Bill\",\n            \"lastName\": \"Mowry\",   \n            \"userName\": \"charlie:::at:::azuga.com\",\n            \"userTypeId\": 3,\n            \"userType\": \"Web Admin\",\n            \"fullName\": \"Bill Mowry\",\n            \"notInGroup\": false,\n            \"deleted\": false,\n            \"employeeId\": \"\"\n         },\n         {  \n            \"userId\": \"b124bddd-b878-11e6-a243-f535d47678c1\",\n            \"firstName\": \"Scott\",\n            \"lastName\": \"Henry\",\n            \"userName\": \"[email protected]\",\n            \"userTypeId\": 4,\n            \"userType\": \"Driver\",\n            \"fullName\": \"Scott Henry\",\n            \"notInGroup\":false,\n            \"deleted\":false,\n            \"trackeeId\": \"23b66a40-f809-11e6-b7d9-1b8af0d9ae89\",\n            \"trackeeName\": \"8349328438\",\n            \"employeeId\": \"AZ3454\"\n         }       \n      ]\n   }\n}","language":"json","status":200,"name":""}]},"settings":"559288b86bf22f170075b794","examples":{"codes":[{"code":"","language":"text"}]}},"next":{"description":"","pages":[]},"title":"View","type":"endpoint","slug":"view-users","excerpt":"Use this API to get account information of users. Users are people in your organization that use Azuga for tracking vehicles and reporting on performance and productivity. Users include drivers, as well, who are given limited access to the application.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sample Request\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/users/view.json?type=all\"\n}\n[/block]\n##API Response Explanation\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"code\",\n    \"0-1\": \"API Status Code\",\n    \"1-1\": \"API Message\",\n    \"3-1\": \"API generation timestamp in UTC\",\n    \"1-0\": \"message\",\n    \"3-0\": \"generatedAt\",\n    \"4-0\": \"currentPage\",\n    \"4-1\": \"The current page\",\n    \"5-0\": \"totalPages\",\n    \"5-1\": \"The total number of pages in the result\",\n    \"6-0\": \"users\",\n    \"6-1\": \"An array of user objects\",\n    \"11-0\": \"userTypeId\",\n    \"11-1\": \"Unique identifier representing a user type. Different user types IDs are:\\n* 2 = Super Admin\\n* 3 = Web Admin\\n* 4 = Driver\",\n    \"12-0\": \"userType\",\n    \"12-1\": \"Type of user\",\n    \"7-0\": \"userId\",\n    \"10-0\": \"userName\",\n    \"10-1\": \"Username of the account\",\n    \"7-1\": \"Unique identifier representing the user\",\n    \"13-0\": \"fullName\",\n    \"14-0\": \"notInGroup\",\n    \"15-0\": \"deleted\",\n    \"13-1\": \"Full name of the user\",\n    \"15-1\": \"Boolean to indicate if the user is deleted or not from the application\",\n    \"14-1\": \"Boolean to indicate if the user belongs to a group\",\n    \"18-0\": \"employeeId\",\n    \"18-1\": \"This represents the employee ID of the user\",\n    \"2-0\": \"messageCode\",\n    \"2-1\": \"API sub-error code\",\n    \"8-0\": \"firstName\",\n    \"8-1\": \"The first name of the user\",\n    \"9-0\": \"lastName\",\n    \"9-1\": \"The last name of the user\",\n    \"16-0\": \"trackeeId\",\n    \"16-1\": \"Unique identifier representing the vehicle that the driver is paired with(only applicable for the userType driver)\",\n    \"17-0\": \"trackeeName\",\n    \"17-1\": \"Name of the vehicle that the driver is paired with(only applicable for the userType driver)\"\n  },\n  \"cols\": 2,\n  \"rows\": 19\n}\n[/block]","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"559435a85c9eaa2300a862cb","editedParams":true,"editedParams2":true,"user":"55926c39cf9cdb2100b57022","githubsync":"","project":"55926c913735880d005f7c65","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["559286c7c39c4b2d00127a72","55928a98c39c4b2d00127a83","5592bd7b9a68220d00f1c3db","5593dcaf0e82e81700334e25","5594342f0c33bd0d000595a3","563081713998420d00a509e4","5630941c7581b80d00c51c86","56309f4ff1c0580d00fac666","567923b8239fac0d00c7df25","573306dea6a9c40e00e13875","577a288fd051530e00f65563","579af3982b865e17005a4357","57ee06aa1e42900e0014a374","5951f49a63f39000159e7ef1","5951f4c563f39000159e7ef2","598951542a9dfc000fcacd40","5b3375cc98cb500003e4b363","5bbcd4e29667280003084100"],"_id":"559286c6c39c4b2d00127a71","createdAt":"2015-06-30T12:08:38.768Z","project":"55926c913735880d005f7c65","releaseDate":"2015-06-30T12:08:38.768Z","__v":18,"forked_from":"559286b6c39c4b2d00127a6e"},"category":{"sync":{"isSync":false,"url":""},"pages":["5630a1f83998420d00a50a09"],"title":"USER","slug":"users","order":4,"from_sync":false,"reference":true,"_id":"5594342f0c33bd0d000595a3","__v":1,"createdAt":"2015-07-01T18:40:47.006Z","project":"55926c913735880d005f7c65","version":"559286c6c39c4b2d00127a71"},"createdAt":"2015-07-01T18:47:04.023Z","parentDoc":null,"__v":9}

getView

Use this API to get account information of users. Users are people in your organization that use Azuga for tracking vehicles and reporting on performance and productivity. Users include drivers, as well, who are given limited access to the application.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

type:
required
stringALL
Type of user. The accepted types are: "admin" and "driver"

Result Format


Documentation

[block:callout] { "type": "info", "title": "Sample Request", "body": "https://api.azuga.com/azuga-ws/v1/users/view.json?type=all" } [/block] ##API Response Explanation [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "code", "0-1": "API Status Code", "1-1": "API Message", "3-1": "API generation timestamp in UTC", "1-0": "message", "3-0": "generatedAt", "4-0": "currentPage", "4-1": "The current page", "5-0": "totalPages", "5-1": "The total number of pages in the result", "6-0": "users", "6-1": "An array of user objects", "11-0": "userTypeId", "11-1": "Unique identifier representing a user type. Different user types IDs are:\n* 2 = Super Admin\n* 3 = Web Admin\n* 4 = Driver", "12-0": "userType", "12-1": "Type of user", "7-0": "userId", "10-0": "userName", "10-1": "Username of the account", "7-1": "Unique identifier representing the user", "13-0": "fullName", "14-0": "notInGroup", "15-0": "deleted", "13-1": "Full name of the user", "15-1": "Boolean to indicate if the user is deleted or not from the application", "14-1": "Boolean to indicate if the user belongs to a group", "18-0": "employeeId", "18-1": "This represents the employee ID of the user", "2-0": "messageCode", "2-1": "API sub-error code", "8-0": "firstName", "8-1": "The first name of the user", "9-0": "lastName", "9-1": "The last name of the user", "16-0": "trackeeId", "16-1": "Unique identifier representing the vehicle that the driver is paired with(only applicable for the userType driver)", "17-0": "trackeeName", "17-1": "Name of the vehicle that the driver is paired with(only applicable for the userType driver)" }, "cols": 2, "rows": 19 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}