{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/cancel_booking.json","auth":"never","basic_auth":false,"method":"post","params":[{"name":"api_key","type":"string","default":"","desc":"This is a 25 alphanumeric hash code provided to you by the fleet.","required":true,"in":"body","ref":"","_id":"543f0d0755bb10080009566f"},{"name":"phone_number","type":"int","default":"","desc":"This is the mobile number for the customer account.","required":true,"in":"body","ref":"","_id":"543f0d0755bb10080009566e"},{"name":"customer_pin","type":"int","default":"","desc":"You can also send the customers PIN number for verification, if this fails, the API command will fail. If left blank, no validation is done on the authenticity of the customer ID.","required":false,"in":"body","ref":"","_id":"543f0dbf15d0560800502814"},{"name":"job_id","type":"int","default":"","desc":"This is the Job ID for the booking you wish to cancel.","required":true,"in":"body","ref":"","_id":"543f0dbf15d0560800502813"},{"name":"reason","type":"string","default":"","desc":"This is a text-based reason for the cancellation. For example \"Customer requested cancellation\".","required":false,"in":"body","ref":"","_id":"543f0dbf15d0560800502812"}],"results":{"codes":[{"name":"Success","code":"{\n    \"result\": \"valid\"\n}","language":"json"},{"name":"Failure","code":"{\n    \"result\": \"error\",\n\t  \"error\": \"Reason for error (EG: Already cancelled)\"\n}","language":"json"}]},"try":true,"examples":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"cancel_booking","type":"endpoint","slug":"cancel_booking","excerpt":"This allows you to cancel an active or pending booking.","body":"This chapter describes how to cancel a booking using the CANCEL_JOB command. This is an immediate tool that can be used to cancel a job in any STATUS except for Y or V. This should also be used when a modification is required to a job so that any driver that may be en-route to the location does not continue their journey to any incorrect destinations. Modification of less vital information is currently in development and not yet available.","updates":[],"order":12,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"543f0d0755bb10080009566d","is_link":false,"parentDoc":null,"project":"543005c87d487022005b3fa8","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["543005c87d487022005b3fac","54345156edce04080040964e","543ee0c055bb1008000955b6","54c82a78ab706219009e0656","57390d0e1f4b740e00b06cb2","5741d5ab28f5fb0e0063ed36","5d1e4140522cd702b31b544b","5e321f8b5517b00012831b6a"],"_id":"543005c87d487022005b3fab","__v":8,"createdAt":"2014-10-04T14:35:52.362Z","releaseDate":"2014-10-04T14:35:52.362Z","project":"543005c87d487022005b3fa8"},"editedParams":true,"category":{"sync":{"isSync":false,"url":""},"pages":["543ee1d615d0560800502749","543ee5c015d0560800502758","543ee87715d0560800502763","543ee9e315d056080050276c","543f003c55bb100800095624","543f030555bb10080009563f","543f0b3e15d05608005027ee","543f0d0755bb10080009566d","543f0e8415d056080050281b","543f0f8f55bb10080009567e","543f109055bb100800095689","543f11d315d056080050282b","543f15c615d0560800502845","544aec7fa761f90800c41d32","545a7fae1d018b1400227eff","545e9dc97e32310e00f400ca","5603c5dde416560d00fa63ad","564ed2eb9209cf0d001d6917","56cb2acb245b841300806ea4","56e05f414685db1700d9480b","56e063e4f97d422900d639bf"],"title":"Gazoop Internal API","slug":"iwebcab-api-tools","order":1,"from_sync":false,"reference":false,"_id":"543ee0c055bb1008000955b6","__v":21,"createdAt":"2014-10-15T21:01:52.185Z","project":"543005c87d487022005b3fa8","version":"543005c87d487022005b3fab"},"createdAt":"2014-10-16T00:10:47.730Z","editedParams2":true,"user":"543005a67d487022005b3fa7","__v":2,"githubsync":""}