{"_id":"5951e426f8a1ac001b0f65d0","project":"56f962d8d522d81700600280","version":{"_id":"56f962d8d522d81700600283","hasDoc":true,"__v":5,"hasReference":true,"project":"56f962d8d522d81700600280","createdAt":"2016-03-28T16:59:04.166Z","releaseDate":"2016-03-28T16:59:04.166Z","categories":["56f962d8d522d81700600284","5951d5489435c30015923d54","5951d6de50727a00155053c6","5951d99224e2f70015dec6c6","5951e40ef5c137001533814b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5951d5489435c30015923d54","project":"56f962d8d522d81700600280","version":"56f962d8d522d81700600283","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-06-27T03:47:20.769Z","from_sync":false,"order":1,"slug":"tasks","title":"Reference"},"user":"57736a020a6d610e00dea1fd","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-27T04:50:46.473Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Drivers are the members of an organization who perform actions via the Wimo mobile applications. They may belong to teams managed by any number of administrators in their own organization. Drivers have a vehicle with which tasks are completed.\n[block:html]\n{\n  \"html\": \"<span style=\\\"background-color: #248FB2; color:white; padding-left:5px; padding-right:5px;\\\">Post</span>\\n<a href=\\\"https://docs.wimo.ae/docs/create-driver\\\">Create Driver</a>\"\n}\n[/block]\n\nBody parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The driver's complete name.\",\n    \"1-0\": \"phone\",\n    \"1-1\": \"String\",\n    \"1-2\": \"A valid phone number as per the driver's organization’s country.\",\n    \"2-0\": \"teams\",\n    \"2-1\": \"Integer array\",\n    \"2-2\": \"One or more team IDs of which the driver is a member.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --request POST \\\\\\n  --url https://be.wimo.ae:3001/api/v1/drivers \\\\\\n  --header 'authorization: 95de9ce1f12861dca3335cc87b5cfd90' \\\\\\n  --data '{\\\"teams\\\":[\\\"62\\\",\\\"63\\\"],\\\"name\\\":\\\"name\\\",\\\"phone\\\":\\\"+841222976366\\\"}'\",\n      \"language\": \"shell\",\n      \"name\": \"Shell\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"success\\\": true,\\n    \\\"user\\\": {\\n        \\\"id\\\": 3666,\\n        \\\"name\\\": \\\"Test Driver 1498549753\\\",\\n        \\\"email\\\": \\\"test.driver.1489669528:::at:::nikmesoft.com\\\",\\n        \\\"password\\\": \\\"\\\",\\n        \\\"phone\\\": \\\"+841498549753\\\",\\n        \\\"avatar\\\": null,\\n        \\\"driver\\\": true,\\n        \\\"admin\\\": false,\\n        \\\"superAdmin\\\": false,\\n        \\\"active\\\": true,\\n        \\\"dispatcher\\\": false,\\n        \\\"inShift\\\": false,\\n        \\\"hasDismissedIntroModal\\\": false,\\n        \\\"status\\\": 0,\\n        \\\"startShiftTime\\\": null,\\n        \\\"endShiftTime\\\": null,\\n        \\\"lunchBreakDuration\\\": null,\\n        \\\"lunchBreakStart\\\": null,\\n        \\\"lunchBreakEnd\\\": null,\\n        \\\"createdAt\\\": \\\"2017-03-16T13:05:28.000Z\\\",\\n        \\\"updatedAt\\\": \\\"2017-06-27T07:49:13.000Z\\\",\\n        \\\"driverTransportationId\\\": null,\\n        \\\"companyId\\\": 46,\\n        \\\"company\\\": {\\n            \\\"id\\\": 46,\\n            \\\"name\\\": \\\"Nikme 299\\\",\\n            \\\"timezone\\\": \\\"Asia/Jakarta\\\",\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"country\\\": {\\n                \\\"id\\\": \\\"US\\\",\\n                \\\"name\\\": \\\"United States\\\"\\n            },\\n        \\\"driverTransportation\\\": null,\\n        \\\"shiftTimes\\\": []\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<span style=\\\"background-color: #9B708B; color:white; padding-left:5px; padding-right:5px;\\\">Put</span>\\n<a href=\\\"https://docs.wimo.ae/docs/update-driver\\\">Update Driver</a>\"\n}\n[/block]\n\nBody parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The driver's complete name.\",\n    \"1-0\": \"phone\",\n    \"1-1\": \"String\",\n    \"1-2\": \"A valid phone number as per the driver's organization’s country.\",\n    \"2-0\": \"teams\",\n    \"2-1\": \"Integer array\",\n    \"2-2\": \"One or more team IDs of which the driver is a member.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --request PUT \\\\\\n  --url https://be.wimo.ae:3001/api/v1/drivers/:driverId \\\\\\n  --header 'authorization: 95de9ce1f12861dca3335cc87b5cfd90' \\\\\\n  --data '{\\\"teams\\\":[\\\"62\\\",\\\"63\\\"],\\\"name\\\":\\\"name\\\",\\\"phone\\\":\\\"+841222976366\\\"}'\",\n      \"language\": \"shell\",\n      \"name\": \"Shell\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"success\\\": true,\\n    \\\"user\\\": {\\n        \\\"id\\\": 3666,\\n        \\\"name\\\": \\\"Test Driver 1498549753\\\",\\n        \\\"email\\\": \\\"test.driver.1489669528@nikmesoft.com\\\",\\n        \\\"password\\\": \\\"\\\",\\n        \\\"phone\\\": \\\"+841498549753\\\",\\n        \\\"avatar\\\": null,\\n        \\\"driver\\\": true,\\n        \\\"admin\\\": false,\\n        \\\"superAdmin\\\": false,\\n        \\\"active\\\": true,\\n        \\\"dispatcher\\\": false,\\n        \\\"inShift\\\": false,\\n        \\\"hasDismissedIntroModal\\\": false,\\n        \\\"status\\\": 0,\\n        \\\"startShiftTime\\\": null,\\n        \\\"endShiftTime\\\": null,\\n        \\\"lunchBreakDuration\\\": null,\\n        \\\"lunchBreakStart\\\": null,\\n        \\\"lunchBreakEnd\\\": null,\\n        \\\"createdAt\\\": \\\"2017-03-16T13:05:28.000Z\\\",\\n        \\\"updatedAt\\\": \\\"2017-06-27T07:49:13.000Z\\\",\\n        \\\"driverTransportationId\\\": null,\\n        \\\"companyId\\\": 46,\\n        \\\"company\\\": {\\n            \\\"id\\\": 46,\\n            \\\"name\\\": \\\"Nikme 299\\\",\\n            \\\"timezone\\\": \\\"Asia/Jakarta\\\",\\n            \\\"currency\\\": \\\"USD\\\",\\n            \\\"country\\\": {\\n                \\\"id\\\": \\\"US\\\",\\n                \\\"name\\\": \\\"United States\\\"\\n            },\\n        \\\"driverTransportation\\\": null,\\n        \\\"shiftTimes\\\": []\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<span style=\\\"background-color: #9B708B; color:white; padding-left:5px; padding-right:5px;\\\">Put</span>\\n<a href=\\\"https://docs.wimo.ae/docs/assign-task-to-driver\\\">Assign Task To Driver</a>\"\n}\n[/block]\n\nBody parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"tasks\",\n    \"0-1\": \"Integer array\",\n    \"0-2\": \"One or more awbs of which the task that you want to assign to the driver.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --request PUT \\\\\\n  --url https://be.wimo.ae:3001/api/v1/containers/drivers/4316 \\\\\\n  --header 'authorization: 95de9ce1f12861dca3335cc87b5cfd90'\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"success\\\": true,\\n    \\\"results\\\": [\\n        {\\n            \\\"awb\\\": \\\"1156\\\",\\n            \\\"success\\\": false,\\n            \\\"error\\\": {\\n                \\\"code\\\": \\\"TASK_ALREADY_PROCESSED\\\",\\n                \\\"message\\\": \\\"It is already processed.\\\"\\n            }\\n        },\\n        {\\n            \\\"awb\\\": \\\"1156\\\",\\n            \\\"success\\\": true\\n        }\\n    ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<span style=\\\"background-color: #6BBD5B; color:white; padding-left:5px; padding-right:5px;\\\">Get</span>\\n<a href=\\\"https://docs.wimo.ae/docs/get-drivers\\\">Get Drivers</a>\\n\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --request GET \\\\\\n  --url https://be.wimo.ae:3001/api/v1/drivers \\\\\\n  --header 'authorization: 319743994e9e0394ea69d86b68cf79d9'\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"success\\\": true,\\n    \\\"users\\\": [\\n        {\\n            \\\"id\\\": 4445,\\n            \\\"name\\\": \\\"michael\\\",\\n            \\\"email\\\": \\\"\\\",\\n            \\\"phone\\\": \\\"+841222976366\\\",\\n            \\\"avatar\\\": \\\"user-avatars/1502072052183-0b877f40-bc8d-43c9-a707-53c856d69ef6.png\\\",\\n            \\\"inShift\\\": true,\\n            \\\"status\\\": 1,\\n            \\\"startShiftTime\\\": \\\"08:00\\\",\\n            \\\"endShiftTime\\\": \\\"17:00\\\",\\n            \\\"lunchBreakDuration\\\": \\\"60\\\",\\n            \\\"lunchBreakStart\\\": \\\"12:00\\\",\\n            \\\"lunchBreakEnd\\\": \\\"13:00\\\",\\n            \\\"createdAt\\\": \\\"2017-06-27T09:28:05.000Z\\\",\\n            \\\"updatedAt\\\": \\\"2017-08-15T02:48:43.000Z\\\",\\n            \\\"driverTransportationId\\\": null,\\n            \\\"companyId\\\": 5909,\\n            \\\"driverTransportation\\\": null,\\n            \\\"driverTeams\\\": [\\n                {\\n                    \\\"id\\\": 1567,\\n                    \\\"name\\\": \\\"Team 2\\\"\\n                }\\n            ]\\n        },\\n        {\\n            \\\"id\\\": 4601,\\n            \\\"name\\\": \\\"Test Driver\\\",\\n            \\\"email\\\": \\\"\\\",\\n            \\\"phone\\\": \\\"+84905123456\\\",\\n            \\\"avatar\\\": null,\\n            \\\"inShift\\\": false,\\n            \\\"status\\\": 0,\\n            \\\"startShiftTime\\\": \\\"08:00\\\",\\n            \\\"endShiftTime\\\": \\\"17:00\\\",\\n            \\\"lunchBreakDuration\\\": null,\\n            \\\"lunchBreakStart\\\": null,\\n            \\\"lunchBreakEnd\\\": null,\\n            \\\"createdAt\\\": \\\"2017-08-01T02:58:38.000Z\\\",\\n            \\\"updatedAt\\\": \\\"2017-08-01T02:58:38.000Z\\\",\\n            \\\"driverTransportationId\\\": null,\\n            \\\"companyId\\\": 5909,\\n            \\\"driverTransportation\\\": null,\\n            \\\"driverTeams\\\": [\\n                {\\n                    \\\"id\\\": 1565,\\n                    \\\"name\\\": \\\"team1\\\"\\n                }\\n            ]\\n        }\\n    ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<span style=\\\"background-color: #6BBD5B; color:white; padding-left:5px; padding-right:5px;\\\">Get</span>\\n<a href=\\\"https://docs.wimo.ae/docs/get-driver-tasks\\\">Get Driver Tasks</a>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --request GET \\\\\\n  --url https://be.wimo.ae:3001/api/v1/drivers/4/tasks \\\\\\n  --header 'authorization: 319743994e9e0394ea69d86b68cf79d9'\\n\\n\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"success\\\": true,\\n  \\\"tasks\\\": [\\n    {\\n      \\\"id\\\": 320336,\\n      \\\"awb\\\": \\\"1111\\\",\\n      \\\"details\\\": \\\"test\\\",\\n      \\\"customerNotes\\\": null,\\n      \\\"totalPrice\\\": 1111,\\n      \\\"leftToBePaid\\\": 1100,\\n      \\\"deliveryPrice\\\": null,\\n      \\\"currency\\\": \\\"USD\\\",\\n      \\\"inventory\\\": null,\\n      \\\"priority\\\": 126,\\n      \\\"cancelReason\\\": \\\"\\\",\\n      \\\"quantity\\\": 0,\\n      \\\"sentETA\\\": false,\\n      \\\"eta\\\": 0,\\n      \\\"etaText\\\": null,\\n      \\\"serviceTime\\\": 0,\\n      \\\"uuid\\\": \\\"SyL0LSffb\\\",\\n      \\\"startedAt\\\": \\\"2017-06-05T02:49:53.357Z\\\",\\n      \\\"completedAt\\\": \\\"2017-06-07T02:43:21.000Z\\\",\\n      \\\"lastLocationLat\\\": 16.0335328,\\n      \\\"lastLocationLng\\\": 108.22326247,\\n      \\\"collectPayment\\\": true,\\n      \\\"completeBefore\\\": null,\\n      \\\"completeAfter\\\": null,\\n      \\\"pickupTask\\\": true,\\n      \\\"arrivalTime\\\": null,\\n      \\\"mobileTaskForm\\\": null,\\n      \\\"createdAt\\\": \\\"2017-06-05T02:49:50.000Z\\\",\\n      \\\"updatedAt\\\": \\\"2017-06-07T02:43:21.000Z\\\",\\n      \\\"ownerId\\\": 1,\\n      \\\"fulfillerId\\\": 1,\\n      \\\"userId\\\": 4,\\n      \\\"teamId\\\": null,\\n      \\\"customerId\\\": null,\\n      \\\"statusId\\\": 9,\\n      \\\"paymentTypeId\\\": 2,\\n      \\\"owner\\\": {\\n        \\\"id\\\": 1,\\n        \\\"name\\\": \\\"Nikmesoft\\\",\\n        \\\"logo\\\": \\\"\\\",\\n        \\\"email\\\": \\\"nikmesoft@gmail.com\\\",\\n        \\\"phone\\\": \\\"0938765299\\\",\\n        \\\"paying\\\": true\\n      },\\n      \\\"fulfiller\\\": {\\n        \\\"id\\\": 1,\\n        \\\"name\\\": \\\"Nikmesoft\\\",\\n        \\\"logo\\\": \\\"\\\",\\n        \\\"email\\\": \\\"nikmesoft@gmail.com\\\",\\n        \\\"phone\\\": \\\"0938765299\\\",\\n        \\\"paying\\\": true\\n      },\\n      \\\"user\\\": {\\n        \\\"id\\\": 4,\\n        \\\"name\\\": \\\"michaelll\\\",\\n        \\\"avatar\\\": \\\"user-avatars/1500952863933-e0870f3d-07e5-47df-8047-09d9ebf1e8f5.png\\\",\\n        \\\"email\\\": null,\\n        \\\"phone\\\": \\\"+841222976366\\\",\\n        \\\"inShift\\\": true,\\n        \\\"status\\\": 1\\n      },\\n      \\\"team\\\": null,\\n      \\\"customer\\\": null,\\n      \\\"status\\\": {\\n        \\\"id\\\": 9,\\n        \\\"name\\\": \\\"Succeeded\\\"\\n      },\\n      \\\"paymentType\\\": {\\n        \\\"id\\\": 2,\\n        \\\"name\\\": \\\"Collect Credit Card\\\"\\n      },\\n      \\\"address\\\": {\\n        \\\"lat\\\": 0,\\n        \\\"lng\\\": 0,\\n        \\\"address\\\": \\\"test\\\",\\n        \\\"addressSecondLine\\\": \\\"\\\",\\n        \\\"city\\\": \\\"\\\",\\n        \\\"area\\\": \\\"\\\",\\n        \\\"country\\\": \\\"\\\",\\n        \\\"streetNumber\\\": \\\"\\\",\\n        \\\"streetName\\\": \\\"\\\",\\n        \\\"postalCode\\\": \\\"\\\"\\n      },\\n      \\\"notes\\\": []\\n    },\\n    {\\n      \\\"id\\\": 349332,\\n      \\\"awb\\\": \\\"1234\\\",\\n      \\\"details\\\": \\\"test\\\",\\n      \\\"customerNotes\\\": null,\\n      \\\"totalPrice\\\": 1234,\\n      \\\"leftToBePaid\\\": 1233,\\n      \\\"deliveryPrice\\\": null,\\n      \\\"currency\\\": \\\"USD\\\",\\n      \\\"inventory\\\": null,\\n      \\\"priority\\\": 128,\\n      \\\"cancelReason\\\": \\\"\\\",\\n      \\\"quantity\\\": 0,\\n      \\\"sentETA\\\": false,\\n      \\\"eta\\\": 0,\\n      \\\"etaText\\\": null,\\n      \\\"serviceTime\\\": 0,\\n      \\\"uuid\\\": \\\"SkYiQzaMb\\\",\\n      \\\"startedAt\\\": \\\"2017-06-13T07:26:25.436Z\\\",\\n      \\\"completedAt\\\": \\\"2017-06-13T07:26:43.219Z\\\",\\n      \\\"lastLocationLat\\\": 16.03354471,\\n      \\\"lastLocationLng\\\": 108.22325417,\\n      \\\"collectPayment\\\": true,\\n      \\\"completeBefore\\\": \\\"2017-06-15T05:00:00.000Z\\\",\\n      \\\"completeAfter\\\": \\\"2017-06-13T05:00:00.000Z\\\",\\n      \\\"pickupTask\\\": true,\\n      \\\"arrivalTime\\\": null,\\n      \\\"mobileTaskForm\\\": \\\"[{\\\\\\\"field_key\\\\\\\":\\\\\\\"field key\\\\\\\",\\\\\\\"answer\\\\\\\":\\\\\\\"1234ry\\\\\\\"},{\\\\\\\"field_key\\\\\\\":\\\\\\\"1\\\\\\\",\\\\\\\"answer\\\\\\\":\\\\\\\"1\\\\\\\"},{\\\\\\\"field_key\\\\\\\":\\\\\\\"user_email\\\\\\\",\\\\\\\"answer\\\\\\\":\\\\\\\"Test\\\\\\\"},{\\\\\\\"field_key\\\\\\\":\\\\\\\"true\\\\\\\",\\\\\\\"answer\\\\\\\":true}]\\\",\\n      \\\"createdAt\\\": \\\"2017-06-13T07:26:24.000Z\\\",\\n      \\\"updatedAt\\\": \\\"2017-06-13T07:30:22.000Z\\\",\\n      \\\"ownerId\\\": 1,\\n      \\\"fulfillerId\\\": 1,\\n      \\\"userId\\\": 4,\\n      \\\"teamId\\\": null,\\n      \\\"customerId\\\": null,\\n      \\\"statusId\\\": 9,\\n      \\\"paymentTypeId\\\": 2,\\n      \\\"owner\\\": {\\n        \\\"id\\\": 1,\\n        \\\"name\\\": \\\"Nikmesoft\\\",\\n        \\\"logo\\\": \\\"\\\",\\n        \\\"email\\\": \\\"nikmesoft@gmail.com\\\",\\n        \\\"phone\\\": \\\"0938765299\\\",\\n        \\\"paying\\\": true\\n      },\\n      \\\"fulfiller\\\": {\\n        \\\"id\\\": 1,\\n        \\\"name\\\": \\\"Nikmesoft\\\",\\n        \\\"logo\\\": \\\"\\\",\\n        \\\"email\\\": \\\"nikmesoft@gmail.com\\\",\\n        \\\"phone\\\": \\\"0938765299\\\",\\n        \\\"paying\\\": true\\n      },\\n      \\\"user\\\": {\\n        \\\"id\\\": 4,\\n        \\\"name\\\": \\\"michaelll\\\",\\n        \\\"avatar\\\": \\\"user-avatars/1500952863933-e0870f3d-07e5-47df-8047-09d9ebf1e8f5.png\\\",\\n        \\\"email\\\": null,\\n        \\\"phone\\\": \\\"+841222976366\\\",\\n        \\\"inShift\\\": true,\\n        \\\"status\\\": 1\\n      },\\n      \\\"team\\\": null,\\n      \\\"customer\\\": null,\\n      \\\"status\\\": {\\n        \\\"id\\\": 9,\\n        \\\"name\\\": \\\"Succeeded\\\"\\n      },\\n      \\\"paymentType\\\": {\\n        \\\"id\\\": 2,\\n        \\\"name\\\": \\\"Collect Credit Card\\\"\\n      },\\n      \\\"address\\\": {\\n        \\\"lat\\\": 16.03354471,\\n        \\\"lng\\\": 108.22325417,\\n        \\\"address\\\": \\\"test\\\",\\n        \\\"addressSecondLine\\\": \\\"\\\",\\n        \\\"city\\\": \\\"\\\",\\n        \\\"area\\\": \\\"\\\",\\n        \\\"country\\\": \\\"\\\",\\n        \\\"streetNumber\\\": \\\"\\\",\\n        \\\"streetName\\\": \\\"\\\",\\n        \\\"postalCode\\\": \\\"\\\"\\n      },\\n      \\\"notes\\\": [\\n        {\\n          \\\"id\\\": 213031,\\n          \\\"note\\\": null,\\n          \\\"image\\\": \\\"task-photos/1497338853006-05da6b70-0a43-488b-965f-1982d8b4682e.png\\\",\\n          \\\"type\\\": 2,\\n          \\\"createdAt\\\": \\\"2017-06-13T07:27:33.000Z\\\",\\n          \\\"updatedAt\\\": \\\"2017-06-13T07:27:33.000Z\\\",\\n          \\\"userId\\\": 4,\\n          \\\"taskId\\\": 349332,\\n          \\\"user\\\": {\\n            \\\"id\\\": 4,\\n            \\\"name\\\": \\\"michaelll\\\",\\n            \\\"avatar\\\": \\\"user-avatars/1500952863933-e0870f3d-07e5-47df-8047-09d9ebf1e8f5.png\\\"\\n          }\\n        },\\n        {\\n          \\\"id\\\": 213038,\\n          \\\"note\\\": null,\\n          \\\"image\\\": \\\"task-photos/1497338967674-d5833e67-37ed-465c-8cd8-4c067d5a6f56.png\\\",\\n          \\\"type\\\": 2,\\n          \\\"createdAt\\\": \\\"2017-06-13T07:28:49.000Z\\\",\\n          \\\"updatedAt\\\": \\\"2017-06-13T07:29:27.000Z\\\",\\n          \\\"userId\\\": 4,\\n          \\\"taskId\\\": 349332,\\n          \\\"user\\\": {\\n            \\\"id\\\": 4,\\n            \\\"name\\\": \\\"michaelll\\\",\\n            \\\"avatar\\\": \\\"user-avatars/1500952863933-e0870f3d-07e5-47df-8047-09d9ebf1e8f5.png\\\"\\n          }\\n        },\\n        {\\n          \\\"id\\\": 213049,\\n          \\\"note\\\": \\\"coent\\\",\\n          \\\"image\\\": null,\\n          \\\"type\\\": 1,\\n          \\\"createdAt\\\": \\\"2017-06-13T07:29:47.000Z\\\",\\n          \\\"updatedAt\\\": \\\"2017-06-13T07:30:21.000Z\\\",\\n          \\\"userId\\\": 4,\\n          \\\"taskId\\\": 349332,\\n          \\\"user\\\": {\\n            \\\"id\\\": 4,\\n            \\\"name\\\": \\\"michaelll\\\",\\n            \\\"avatar\\\": \\\"user-avatars/1500952863933-e0870f3d-07e5-47df-8047-09d9ebf1e8f5.png\\\"\\n          }\\n        },\\n        {\\n          \\\"id\\\": 213050,\\n          \\\"note\\\": null,\\n          \\\"image\\\": \\\"task-signatures/1497339021925-00d329d0-d15e-4243-9967-095c2f42e543.png\\\",\\n          \\\"type\\\": 3,\\n          \\\"createdAt\\\": \\\"2017-06-13T07:30:21.000Z\\\",\\n          \\\"updatedAt\\\": \\\"2017-06-13T07:30:21.000Z\\\",\\n          \\\"userId\\\": 4,\\n          \\\"taskId\\\": 349332,\\n          \\\"user\\\": {\\n            \\\"id\\\": 4,\\n            \\\"name\\\": \\\"michaelll\\\",\\n            \\\"avatar\\\": \\\"user-avatars/1500952863933-e0870f3d-07e5-47df-8047-09d9ebf1e8f5.png\\\"\\n          }\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"driver","type":"basic","title":"Drivers"}
Drivers are the members of an organization who perform actions via the Wimo mobile applications. They may belong to teams managed by any number of administrators in their own organization. Drivers have a vehicle with which tasks are completed. [block:html] { "html": "<span style=\"background-color: #248FB2; color:white; padding-left:5px; padding-right:5px;\">Post</span>\n<a href=\"https://docs.wimo.ae/docs/create-driver\">Create Driver</a>" } [/block] Body parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "String", "0-2": "The driver's complete name.", "1-0": "phone", "1-1": "String", "1-2": "A valid phone number as per the driver's organization’s country.", "2-0": "teams", "2-1": "Integer array", "2-2": "One or more team IDs of which the driver is a member." }, "cols": 3, "rows": 3 } [/block] [block:code] { "codes": [ { "code": "curl --request POST \\\n --url https://be.wimo.ae:3001/api/v1/drivers \\\n --header 'authorization: 95de9ce1f12861dca3335cc87b5cfd90' \\\n --data '{\"teams\":[\"62\",\"63\"],\"name\":\"name\",\"phone\":\"+841222976366\"}'", "language": "shell", "name": "Shell" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"success\": true,\n \"user\": {\n \"id\": 3666,\n \"name\": \"Test Driver 1498549753\",\n \"email\": \"test.driver.1489669528@nikmesoft.com\",\n \"password\": \"\",\n \"phone\": \"+841498549753\",\n \"avatar\": null,\n \"driver\": true,\n \"admin\": false,\n \"superAdmin\": false,\n \"active\": true,\n \"dispatcher\": false,\n \"inShift\": false,\n \"hasDismissedIntroModal\": false,\n \"status\": 0,\n \"startShiftTime\": null,\n \"endShiftTime\": null,\n \"lunchBreakDuration\": null,\n \"lunchBreakStart\": null,\n \"lunchBreakEnd\": null,\n \"createdAt\": \"2017-03-16T13:05:28.000Z\",\n \"updatedAt\": \"2017-06-27T07:49:13.000Z\",\n \"driverTransportationId\": null,\n \"companyId\": 46,\n \"company\": {\n \"id\": 46,\n \"name\": \"Nikme 299\",\n \"timezone\": \"Asia/Jakarta\",\n \"currency\": \"USD\",\n \"country\": {\n \"id\": \"US\",\n \"name\": \"United States\"\n },\n \"driverTransportation\": null,\n \"shiftTimes\": []\n }\n}", "language": "json" } ] } [/block] [block:html] { "html": "<span style=\"background-color: #9B708B; color:white; padding-left:5px; padding-right:5px;\">Put</span>\n<a href=\"https://docs.wimo.ae/docs/update-driver\">Update Driver</a>" } [/block] Body parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "name", "0-1": "String", "0-2": "The driver's complete name.", "1-0": "phone", "1-1": "String", "1-2": "A valid phone number as per the driver's organization’s country.", "2-0": "teams", "2-1": "Integer array", "2-2": "One or more team IDs of which the driver is a member." }, "cols": 3, "rows": 3 } [/block] [block:code] { "codes": [ { "code": "curl --request PUT \\\n --url https://be.wimo.ae:3001/api/v1/drivers/:driverId \\\n --header 'authorization: 95de9ce1f12861dca3335cc87b5cfd90' \\\n --data '{\"teams\":[\"62\",\"63\"],\"name\":\"name\",\"phone\":\"+841222976366\"}'", "language": "shell", "name": "Shell" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"success\": true,\n \"user\": {\n \"id\": 3666,\n \"name\": \"Test Driver 1498549753\",\n \"email\": \"test.driver.1489669528@nikmesoft.com\",\n \"password\": \"\",\n \"phone\": \"+841498549753\",\n \"avatar\": null,\n \"driver\": true,\n \"admin\": false,\n \"superAdmin\": false,\n \"active\": true,\n \"dispatcher\": false,\n \"inShift\": false,\n \"hasDismissedIntroModal\": false,\n \"status\": 0,\n \"startShiftTime\": null,\n \"endShiftTime\": null,\n \"lunchBreakDuration\": null,\n \"lunchBreakStart\": null,\n \"lunchBreakEnd\": null,\n \"createdAt\": \"2017-03-16T13:05:28.000Z\",\n \"updatedAt\": \"2017-06-27T07:49:13.000Z\",\n \"driverTransportationId\": null,\n \"companyId\": 46,\n \"company\": {\n \"id\": 46,\n \"name\": \"Nikme 299\",\n \"timezone\": \"Asia/Jakarta\",\n \"currency\": \"USD\",\n \"country\": {\n \"id\": \"US\",\n \"name\": \"United States\"\n },\n \"driverTransportation\": null,\n \"shiftTimes\": []\n }\n}", "language": "json" } ] } [/block] [block:html] { "html": "<span style=\"background-color: #9B708B; color:white; padding-left:5px; padding-right:5px;\">Put</span>\n<a href=\"https://docs.wimo.ae/docs/assign-task-to-driver\">Assign Task To Driver</a>" } [/block] Body parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "tasks", "0-1": "Integer array", "0-2": "One or more awbs of which the task that you want to assign to the driver." }, "cols": 3, "rows": 1 } [/block] [block:code] { "codes": [ { "code": "curl --request PUT \\\n --url https://be.wimo.ae:3001/api/v1/containers/drivers/4316 \\\n --header 'authorization: 95de9ce1f12861dca3335cc87b5cfd90'", "language": "shell" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"success\": true,\n \"results\": [\n {\n \"awb\": \"1156\",\n \"success\": false,\n \"error\": {\n \"code\": \"TASK_ALREADY_PROCESSED\",\n \"message\": \"It is already processed.\"\n }\n },\n {\n \"awb\": \"1156\",\n \"success\": true\n }\n ]\n}", "language": "json" } ] } [/block] [block:html] { "html": "<span style=\"background-color: #6BBD5B; color:white; padding-left:5px; padding-right:5px;\">Get</span>\n<a href=\"https://docs.wimo.ae/docs/get-drivers\">Get Drivers</a>\n" } [/block] [block:code] { "codes": [ { "code": "curl --request GET \\\n --url https://be.wimo.ae:3001/api/v1/drivers \\\n --header 'authorization: 319743994e9e0394ea69d86b68cf79d9'", "language": "shell" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"success\": true,\n \"users\": [\n {\n \"id\": 4445,\n \"name\": \"michael\",\n \"email\": \"\",\n \"phone\": \"+841222976366\",\n \"avatar\": \"user-avatars/1502072052183-0b877f40-bc8d-43c9-a707-53c856d69ef6.png\",\n \"inShift\": true,\n \"status\": 1,\n \"startShiftTime\": \"08:00\",\n \"endShiftTime\": \"17:00\",\n \"lunchBreakDuration\": \"60\",\n \"lunchBreakStart\": \"12:00\",\n \"lunchBreakEnd\": \"13:00\",\n \"createdAt\": \"2017-06-27T09:28:05.000Z\",\n \"updatedAt\": \"2017-08-15T02:48:43.000Z\",\n \"driverTransportationId\": null,\n \"companyId\": 5909,\n \"driverTransportation\": null,\n \"driverTeams\": [\n {\n \"id\": 1567,\n \"name\": \"Team 2\"\n }\n ]\n },\n {\n \"id\": 4601,\n \"name\": \"Test Driver\",\n \"email\": \"\",\n \"phone\": \"+84905123456\",\n \"avatar\": null,\n \"inShift\": false,\n \"status\": 0,\n \"startShiftTime\": \"08:00\",\n \"endShiftTime\": \"17:00\",\n \"lunchBreakDuration\": null,\n \"lunchBreakStart\": null,\n \"lunchBreakEnd\": null,\n \"createdAt\": \"2017-08-01T02:58:38.000Z\",\n \"updatedAt\": \"2017-08-01T02:58:38.000Z\",\n \"driverTransportationId\": null,\n \"companyId\": 5909,\n \"driverTransportation\": null,\n \"driverTeams\": [\n {\n \"id\": 1565,\n \"name\": \"team1\"\n }\n ]\n }\n ]\n}", "language": "json" } ] } [/block] [block:html] { "html": "<span style=\"background-color: #6BBD5B; color:white; padding-left:5px; padding-right:5px;\">Get</span>\n<a href=\"https://docs.wimo.ae/docs/get-driver-tasks\">Get Driver Tasks</a>" } [/block] [block:code] { "codes": [ { "code": "curl --request GET \\\n --url https://be.wimo.ae:3001/api/v1/drivers/4/tasks \\\n --header 'authorization: 319743994e9e0394ea69d86b68cf79d9'\n\n", "language": "shell" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"success\": true,\n \"tasks\": [\n {\n \"id\": 320336,\n \"awb\": \"1111\",\n \"details\": \"test\",\n \"customerNotes\": null,\n \"totalPrice\": 1111,\n \"leftToBePaid\": 1100,\n \"deliveryPrice\": null,\n \"currency\": \"USD\",\n \"inventory\": null,\n \"priority\": 126,\n \"cancelReason\": \"\",\n \"quantity\": 0,\n \"sentETA\": false,\n \"eta\": 0,\n \"etaText\": null,\n \"serviceTime\": 0,\n \"uuid\": \"SyL0LSffb\",\n \"startedAt\": \"2017-06-05T02:49:53.357Z\",\n \"completedAt\": \"2017-06-07T02:43:21.000Z\",\n \"lastLocationLat\": 16.0335328,\n \"lastLocationLng\": 108.22326247,\n \"collectPayment\": true,\n \"completeBefore\": null,\n \"completeAfter\": null,\n \"pickupTask\": true,\n \"arrivalTime\": null,\n \"mobileTaskForm\": null,\n \"createdAt\": \"2017-06-05T02:49:50.000Z\",\n \"updatedAt\": \"2017-06-07T02:43:21.000Z\",\n \"ownerId\": 1,\n \"fulfillerId\": 1,\n \"userId\": 4,\n \"teamId\": null,\n \"customerId\": null,\n \"statusId\": 9,\n \"paymentTypeId\": 2,\n \"owner\": {\n \"id\": 1,\n \"name\": \"Nikmesoft\",\n \"logo\": \"\",\n \"email\": \"nikmesoft@gmail.com\",\n \"phone\": \"0938765299\",\n \"paying\": true\n },\n \"fulfiller\": {\n \"id\": 1,\n \"name\": \"Nikmesoft\",\n \"logo\": \"\",\n \"email\": \"nikmesoft@gmail.com\",\n \"phone\": \"0938765299\",\n \"paying\": true\n },\n \"user\": {\n \"id\": 4,\n \"name\": \"michaelll\",\n \"avatar\": \"user-avatars/1500952863933-e0870f3d-07e5-47df-8047-09d9ebf1e8f5.png\",\n \"email\": null,\n \"phone\": \"+841222976366\",\n \"inShift\": true,\n \"status\": 1\n },\n \"team\": null,\n \"customer\": null,\n \"status\": {\n \"id\": 9,\n \"name\": \"Succeeded\"\n },\n \"paymentType\": {\n \"id\": 2,\n \"name\": \"Collect Credit Card\"\n },\n \"address\": {\n \"lat\": 0,\n \"lng\": 0,\n \"address\": \"test\",\n \"addressSecondLine\": \"\",\n \"city\": \"\",\n \"area\": \"\",\n \"country\": \"\",\n \"streetNumber\": \"\",\n \"streetName\": \"\",\n \"postalCode\": \"\"\n },\n \"notes\": []\n },\n {\n \"id\": 349332,\n \"awb\": \"1234\",\n \"details\": \"test\",\n \"customerNotes\": null,\n \"totalPrice\": 1234,\n \"leftToBePaid\": 1233,\n \"deliveryPrice\": null,\n \"currency\": \"USD\",\n \"inventory\": null,\n \"priority\": 128,\n \"cancelReason\": \"\",\n \"quantity\": 0,\n \"sentETA\": false,\n \"eta\": 0,\n \"etaText\": null,\n \"serviceTime\": 0,\n \"uuid\": \"SkYiQzaMb\",\n \"startedAt\": \"2017-06-13T07:26:25.436Z\",\n \"completedAt\": \"2017-06-13T07:26:43.219Z\",\n \"lastLocationLat\": 16.03354471,\n \"lastLocationLng\": 108.22325417,\n \"collectPayment\": true,\n \"completeBefore\": \"2017-06-15T05:00:00.000Z\",\n \"completeAfter\": \"2017-06-13T05:00:00.000Z\",\n \"pickupTask\": true,\n \"arrivalTime\": null,\n \"mobileTaskForm\": \"[{\\\"field_key\\\":\\\"field key\\\",\\\"answer\\\":\\\"1234ry\\\"},{\\\"field_key\\\":\\\"1\\\",\\\"answer\\\":\\\"1\\\"},{\\\"field_key\\\":\\\"user_email\\\",\\\"answer\\\":\\\"Test\\\"},{\\\"field_key\\\":\\\"true\\\",\\\"answer\\\":true}]\",\n \"createdAt\": \"2017-06-13T07:26:24.000Z\",\n \"updatedAt\": \"2017-06-13T07:30:22.000Z\",\n \"ownerId\": 1,\n \"fulfillerId\": 1,\n \"userId\": 4,\n \"teamId\": null,\n \"customerId\": null,\n \"statusId\": 9,\n \"paymentTypeId\": 2,\n \"owner\": {\n \"id\": 1,\n \"name\": \"Nikmesoft\",\n \"logo\": \"\",\n \"email\": \"nikmesoft@gmail.com\",\n \"phone\": \"0938765299\",\n \"paying\": true\n },\n \"fulfiller\": {\n \"id\": 1,\n \"name\": \"Nikmesoft\",\n \"logo\": \"\",\n \"email\": \"nikmesoft@gmail.com\",\n \"phone\": \"0938765299\",\n \"paying\": true\n },\n \"user\": {\n \"id\": 4,\n \"name\": \"michaelll\",\n \"avatar\": \"user-avatars/1500952863933-e0870f3d-07e5-47df-8047-09d9ebf1e8f5.png\",\n \"email\": null,\n \"phone\": \"+841222976366\",\n \"inShift\": true,\n \"status\": 1\n },\n \"team\": null,\n \"customer\": null,\n \"status\": {\n \"id\": 9,\n \"name\": \"Succeeded\"\n },\n \"paymentType\": {\n \"id\": 2,\n \"name\": \"Collect Credit Card\"\n },\n \"address\": {\n \"lat\": 16.03354471,\n \"lng\": 108.22325417,\n \"address\": \"test\",\n \"addressSecondLine\": \"\",\n \"city\": \"\",\n \"area\": \"\",\n \"country\": \"\",\n \"streetNumber\": \"\",\n \"streetName\": \"\",\n \"postalCode\": \"\"\n },\n \"notes\": [\n {\n \"id\": 213031,\n \"note\": null,\n \"image\": \"task-photos/1497338853006-05da6b70-0a43-488b-965f-1982d8b4682e.png\",\n \"type\": 2,\n \"createdAt\": \"2017-06-13T07:27:33.000Z\",\n \"updatedAt\": \"2017-06-13T07:27:33.000Z\",\n \"userId\": 4,\n \"taskId\": 349332,\n \"user\": {\n \"id\": 4,\n \"name\": \"michaelll\",\n \"avatar\": \"user-avatars/1500952863933-e0870f3d-07e5-47df-8047-09d9ebf1e8f5.png\"\n }\n },\n {\n \"id\": 213038,\n \"note\": null,\n \"image\": \"task-photos/1497338967674-d5833e67-37ed-465c-8cd8-4c067d5a6f56.png\",\n \"type\": 2,\n \"createdAt\": \"2017-06-13T07:28:49.000Z\",\n \"updatedAt\": \"2017-06-13T07:29:27.000Z\",\n \"userId\": 4,\n \"taskId\": 349332,\n \"user\": {\n \"id\": 4,\n \"name\": \"michaelll\",\n \"avatar\": \"user-avatars/1500952863933-e0870f3d-07e5-47df-8047-09d9ebf1e8f5.png\"\n }\n },\n {\n \"id\": 213049,\n \"note\": \"coent\",\n \"image\": null,\n \"type\": 1,\n \"createdAt\": \"2017-06-13T07:29:47.000Z\",\n \"updatedAt\": \"2017-06-13T07:30:21.000Z\",\n \"userId\": 4,\n \"taskId\": 349332,\n \"user\": {\n \"id\": 4,\n \"name\": \"michaelll\",\n \"avatar\": \"user-avatars/1500952863933-e0870f3d-07e5-47df-8047-09d9ebf1e8f5.png\"\n }\n },\n {\n \"id\": 213050,\n \"note\": null,\n \"image\": \"task-signatures/1497339021925-00d329d0-d15e-4243-9967-095c2f42e543.png\",\n \"type\": 3,\n \"createdAt\": \"2017-06-13T07:30:21.000Z\",\n \"updatedAt\": \"2017-06-13T07:30:21.000Z\",\n \"userId\": 4,\n \"taskId\": 349332,\n \"user\": {\n \"id\": 4,\n \"name\": \"michaelll\",\n \"avatar\": \"user-avatars/1500952863933-e0870f3d-07e5-47df-8047-09d9ebf1e8f5.png\"\n }\n }\n ]\n }\n ]\n}", "language": "json" } ] } [/block]