{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/users/view.json","auth":"required","settings":"559288b86bf22f170075b794","examples":{"codes":[{"language":"text","code":""}]},"method":"get","params":[{"name":"type","type":"string","default":"ALL","desc":"Type of user. For drivers, type = 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\": \"01543295-c5e4-11e7-9cd4-5d91e1d62596\",\n            \"firstName\": \"Charlie\",\n            \"lastName\": \"Jo\",\n            \"userName\": \"charlie:::at:::azuga.com\",\n            \"userTypeId\": 4,\n            \"userType\": \"driver\",\n            \"fullName\": \"Charlie Jo\",\n            \"notInGroup\": false,\n            \"deleted\": false,\n            \"trackeeId\": \"00a8894b-c5e4-11e7-b909-d32d26d1092b\",\n            \"trackeeName\": \"Range Rover\",\n            \"employeeId\": \"A9973\"\n            \n            \n         },\n         {  \n            \"userId\": \"02e49eca-f809-11e6-8b15-a9c24ff5d525\",\n            \"firstName\": \"Richard\",\n            \"lastName\": \"Simons\",\n            \"userName\": \"[email protected]\",\n            \"userTypeId\": 4,\n            \"userType\": \"driver\",\n            \"fullName\": \"Richard Simons\",\n            \"notInGroup\": false,\n            \"deleted\": false,\n            \"trackeeId\": \"027ae03b-f809-11e6-8d7d-73d92aa2a966\",\n            \"trackeeName\": \"7773849841\",\n            \"employeeId\": \"FR06\"\n            \n         }\n      ]\n   }\n}","language":"json","status":200,"name":""}]}},"next":{"description":"","pages":[]},"title":"View","type":"endpoint","slug":"view-driver","excerpt":"Use this API to get account information of users. Users are drivers in your organization who use the application to evaluate their performance, obtain vehicle information, participate in reward program etc.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sample Request\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/users/view.json?type=4\"\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\": \"Current page of the paginated result\",\n    \"5-0\": \"totalPages\",\n    \"5-1\": \"Total number of pages in the paginated 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 (admin/drivers)\",\n    \"7-0\": \"userId\",\n    \"7-1\": \"Unique identifier representing the driver\",\n    \"8-0\": \"firstName\",\n    \"8-1\": \"First name of the driver\",\n    \"9-0\": \"lastName\",\n    \"9-1\": \"Last name of the driver\",\n    \"10-0\": \"userName\",\n    \"10-1\": \"Username of the account\",\n    \"13-0\": \"fullName\",\n    \"13-1\": \"Full name of the driver\",\n    \"15-0\": \"deleted\",\n    \"15-1\": \"Boolean to indicate if the driver is deleted or not from the application\",\n    \"14-0\": \"notInGroup\",\n    \"14-1\": \"Boolean to indicate if the driver belongs to a group\",\n    \"16-0\": \"trackeeId\",\n    \"16-1\": \"Unique identifier representing the vehicle that the driver is paired with\",\n    \"17-0\": \"trackeeName\",\n    \"17-1\": \"Name of the vehicle that the driver is paired with\",\n    \"18-0\": \"employeeId\",\n    \"18-1\": \"Employee ID of the driver\",\n    \"12-0\": \"userType\",\n    \"12-1\": \"Type of user\",\n    \"2-0\": \"messageCode\",\n    \"2-1\": \"API sub-error code\"\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":"57f73236a1f6a30e00da11a0","parentDoc":null,"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":[],"title":"DRIVER","slug":"driver","order":5,"from_sync":false,"reference":true,"_id":"57ee06aa1e42900e0014a374","createdAt":"2016-09-30T06:31:06.459Z","version":"559286c6c39c4b2d00127a71","__v":0,"project":"55926c913735880d005f7c65"},"user":"5656a3dd5656350d001d83a0","createdAt":"2016-10-07T05:27:18.863Z","githubsync":"","project":"55926c913735880d005f7c65","__v":5}

getView

Use this API to get account information of users. Users are drivers in your organization who use the application to evaluate their performance, obtain vehicle information, participate in reward program etc.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

type:
required
stringALL
Type of user. For drivers, type = driver

Result Format


Documentation

[block:callout] { "type": "info", "title": "Sample Request", "body": "https://api.azuga.com/azuga-ws/v1/users/view.json?type=4" } [/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": "Current page of the paginated result", "5-0": "totalPages", "5-1": "Total number of pages in the paginated result", "6-0": "users", "6-1": "An array of user objects", "11-0": "userTypeId", "11-1": "Unique identifier representing a user type (admin/drivers)", "7-0": "userId", "7-1": "Unique identifier representing the driver", "8-0": "firstName", "8-1": "First name of the driver", "9-0": "lastName", "9-1": "Last name of the driver", "10-0": "userName", "10-1": "Username of the account", "13-0": "fullName", "13-1": "Full name of the driver", "15-0": "deleted", "15-1": "Boolean to indicate if the driver is deleted or not from the application", "14-0": "notInGroup", "14-1": "Boolean to indicate if the driver belongs to a group", "16-0": "trackeeId", "16-1": "Unique identifier representing the vehicle that the driver is paired with", "17-0": "trackeeName", "17-1": "Name of the vehicle that the driver is paired with", "18-0": "employeeId", "18-1": "Employee ID of the driver", "12-0": "userType", "12-1": "Type of user", "2-0": "messageCode", "2-1": "API sub-error code" }, "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 }}