{"swagger":"2.0","info":{"description":"Corporate APIs allows you to call a car, create users, cost centers and projects inside your own platform.<br/>Our goal making this service available is to grow and increase, even more, our integrations and possibilities uniting 99CORP and your business.<br/>With this documentation you can make it happen!","version":"v1","title":"99 Corp API","termsOfService":"","contact":{"name":"","url":"http://www.99taxis.com/corporativo","email":"contato@99taxis.com"}},"host":"api.corp.99taxis.com","basePath":"/v1","tags":[{"name":"costcenter","description":"Manage company cost centers"},{"name":"employee","description":"Manage company employees"},{"name":"job","description":"Find all rides receipts"},{"name":"project","description":"Manage company projects"},{"name":"ride","description":"Retrieves running rides information"}],"schemes":["http"],"paths":{"/costcenter":{"get":{"tags":["costcenter"],"summary":"List all company cost centers","description":"","operationId":"list","produces":["application/json"],"parameters":[{"name":"search","in":"query","description":"Cost center name query search","required":false,"type":"string"},{"name":"page","in":"query","description":"Page number","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"Page size limit","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"All Cost Centers found with query search","schema":{"type":"array","items":{"$ref":"#/definitions/CostCenterApi"}}}},"security":[{"tokenAuth":[]}]},"post":{"tags":["costcenter"],"summary":"Creates a Cost Center","description":"","operationId":"create","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CostCenterApiRegister"}}],"responses":{"200":{"description":"successful operation"},"201":{"description":"Created cost center","schema":{"$ref":"#/definitions/CostCenterApiRegister"}},"422":{"description":"Some business validation is not right"}},"security":[{"tokenAuth":[]}]}},"/costcenter/{costCenterID}":{"get":{"tags":["costcenter"],"summary":"Get a cost centers","description":"","operationId":"find","produces":["application/json"],"parameters":[{"name":"costCenterID","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Cost center found","schema":{"$ref":"#/definitions/CostCenterApi"}},"404":{"description":"Cost center not found"}},"security":[{"tokenAuth":[]}]},"delete":{"tags":["costcenter"],"summary":"Disable a Cost Center","description":"","operationId":"disable","produces":["application/json"],"parameters":[{"name":"costCenterID","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation"},"204":{"description":"Cost center disabled"},"404":{"description":"Cost center not found"}},"security":[{"tokenAuth":[]}]}},"/employee/{employeeID}/categories":{"get":{"tags":["employee"],"summary":"Get categories by employeeID","description":"","operationId":"listCategories","produces":["application/json"],"parameters":[{"name":"employeeID","in":"path","required":true,"type":"integer","format":"int64"},{"name":"fromLat","in":"query","required":true,"type":"number"},{"name":"fromLng","in":"query","required":true,"type":"number"},{"name":"toLat","in":"query","required":false,"type":"number"},{"name":"toLng","in":"query","required":false,"type":"number"},{"name":"estimatedTime","in":"query","description":"Time in seconds","required":false,"type":"integer","format":"int64"},{"name":"estimatedDistance","in":"query","description":"Distance in meters","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Categories found","schema":{"type":"array","items":{"$ref":"#/definitions/CategoryModel"}}}},"security":[{"tokenAuth":[]}]}},"/employee/{employeeID}/costcenter":{"get":{"tags":["employee"],"summary":"Get all costcenter of an employees","description":"","operationId":"listCostCenters","produces":["application/json"],"parameters":[{"name":"employeeID","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Return costcenters","schema":{"type":"array","items":{"$ref":"#/definitions/EmployeeCostCenterModelResponse"}}},"404":{"description":"Employee not found"}},"security":[{"tokenAuth":[]}]},"patch":{"tags":["employee"],"summary":"Update the cost center employees references","description":"","operationId":"updateCostCenters","produces":["application/json"],"parameters":[{"name":"employeeID","in":"path","required":true,"type":"integer","format":"int64"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmployeeCostCenterModelRequest"}}],"responses":{"200":{"description":"Cost centers added to employee"},"404":{"description":"Employee not found"},"422":{"description":"Some error to refenrece Cost Center","schema":{"type":"array","items":{"$ref":"#/definitions/ValidationError"}}}},"security":[{"tokenAuth":[]}]}},"/employee/{employeeID}/costcenter/{costCenterID}":{"delete":{"tags":["employee"],"summary":"Remove employee cost center reference","description":"","operationId":"disableCostCenter","produces":["application/json"],"parameters":[{"name":"employeeID","in":"path","required":true,"type":"integer","format":"int64"},{"name":"costCenterID","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation"},"204":{"description":"Cost Center reference ID removed"},"404":{"description":"Employee not found"}},"security":[{"tokenAuth":[]}]}},"/employee/{employeeID}":{"get":{"tags":["employee"],"summary":"Get employee by employeeID","description":"","operationId":"findEmployee","produces":["application/json"],"parameters":[{"name":"employeeID","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Employee found","schema":{"$ref":"#/definitions/EmployeeModelResponse"}},"404":{"description":"Employee not found"}},"security":[{"tokenAuth":[]}]},"put":{"tags":["employee"],"summary":"Update an employee","description":"","operationId":"update","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"employeeID","in":"path","required":true,"type":"integer","format":"int64"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmployeeRequest"}}],"responses":{"200":{"description":"Updated employee","schema":{"$ref":"#/definitions/EmployeeRequest"}},"404":{"description":"Employee not found"},"422":{"description":"Some business validation is not right","schema":{"type":"array","items":{"$ref":"#/definitions/ValidationError"}}}},"security":[{"tokenAuth":[]}]},"delete":{"tags":["employee"],"summary":"Disable a employee","description":"","operationId":"disableEmployee","produces":["application/json"],"parameters":[{"name":"employeeID","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation"},"204":{"description":"Employee disabled"},"404":{"description":"Employee not found"}},"security":[{"tokenAuth":[]}]}},"/employee":{"get":{"tags":["employee"],"summary":"Get employees for the company","description":"","operationId":"listEmployee","produces":["application/json"],"parameters":[{"name":"search","in":"query","required":false,"type":"string"},{"name":"page","in":"query","required":false,"type":"string"},{"name":"limit","in":"query","required":false,"type":"number"},{"name":"offset","in":"query","required":false,"type":"number"},{"name":"nationalId","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"Return employees for the company","schema":{"type":"array","items":{"$ref":"#/definitions/EmployeeModelResponse"}}}},"security":[{"tokenAuth":[]}]},"post":{"tags":["employee"],"summary":"Creates an employee","description":"","operationId":"createEmployee","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmployeeRequest"}}],"responses":{"200":{"description":"successful operation"},"201":{"description":"Employee created","schema":{"type":"integer","format":"int64"}},"422":{"description":"Some business validation is not right","schema":{"type":"array","items":{"$ref":"#/definitions/ValidationError"}}}},"security":[{"tokenAuth":[]}]}},"/job/{jobID}":{"get":{"tags":["job"],"summary":"Get history calls for the company","description":"","operationId":"findJob","produces":["application/json"],"parameters":[{"name":"jobID","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Return the job history","schema":{"$ref":"#/definitions/RideHistoryData"}},"400":{"description":"Bad Request"},"404":{"description":"Job ID not found"}},"security":[{"tokenAuth":[]}]}},"/job":{"get":{"tags":["job"],"summary":"Get job history using filter parameters","description":"","operationId":"jobList","produces":["application/json"],"parameters":[{"name":"startDate","in":"query","required":true,"type":"string","x-example":"2017/06/20"},{"name":"endDate","in":"query","required":true,"type":"string","x-example":"2017/06/30"},{"name":"costCenterId","in":"query","required":false,"type":"integer","format":"int64"},{"name":"projectId","in":"query","required":false,"type":"integer","format":"int64"},{"name":"taxiCategory","in":"query","required":false,"type":"string"},{"name":"page","in":"query","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","required":false,"type":"integer","format":"int64"},{"name":"offset","in":"query","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Return the job history","schema":{"type":"array","items":{"$ref":"#/definitions/RideHistory"}}},"400":{"description":"Bad Request"}},"security":[{"tokenAuth":[]}]}},"/project/{projectID}":{"get":{"tags":["project"],"summary":"Find a project","description":"","operationId":"findProject","produces":["application/json"],"parameters":[{"name":"projectID","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"List with all projects","schema":{"$ref":"#/definitions/ProjectResponseModel"}},"404":{"description":"Project not found"}},"security":[{"tokenAuth":[]}]},"put":{"tags":["project"],"summary":"Update a project","description":"","operationId":"updateProject","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectID","in":"path","required":true,"type":"integer","format":"int64"},{"in":"body","name":"name","description":"Project name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project updated"},"404":{"description":"Project not found"},"422":{"description":"Some business validation is not right"}},"security":[{"tokenAuth":[]}]},"delete":{"tags":["project"],"summary":"Disable a project","description":"","operationId":"disableProject","produces":["application/json"],"parameters":[{"name":"projectID","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation"},"204":{"description":"Project disabled"},"404":{"description":"Project not found"},"422":{"description":"Some business validation is not right"}},"security":[{"tokenAuth":[]}]}},"/project":{"get":{"tags":["project"],"summary":"List all company projects","description":"","operationId":"listProject","produces":["application/json"],"parameters":[{"name":"search","in":"query","description":"Name query search","required":false,"type":"string"},{"name":"page","in":"query","description":"Page number","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"Page limit","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"List with all projects","schema":{"type":"array","items":{"$ref":"#/definitions/ProjectResponseModel"}}}},"security":[{"tokenAuth":[]}]},"post":{"tags":["project"],"summary":"Create a project","description":"","operationId":"createProject","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ProjectModelRequest"}}],"responses":{"201":{"description":"Created project","schema":{"$ref":"#/definitions/ProjectResponseModel"}},"422":{"description":"Some business validation is not right"}},"security":[{"tokenAuth":[]}]}},"/ride":{"get":{"tags":["ride"],"summary":"Get the running ride status","description":"","operationId":"rideGet","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Return the running ride status","schema":{"type":"array","items":{"$ref":"#/definitions/RideRequestStatus"}}},"204":{"description":"No running ride"}},"security":[{"tokenAuth":[]}]},"post":{"tags":["ride"],"summary":"Call a new car","description":"","operationId":"ridePost","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/RideRequest"}}],"responses":{"200":{"description":"Created call, starting to find drivers","schema":{"$ref":"#/definitions/RideStarted"}},"204":{"description":"No drivers found with requested parameters"},"422":{"description":"Some business validation is not right"}},"security":[{"tokenAuth":[]}]}},"/ride/{rideID}":{"get":{"tags":["ride"],"summary":"Get the running ride status by ID","description":"","operationId":"rideGetLive","produces":["application/json"],"parameters":[{"name":"rideID","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Return the running ride status","schema":{"$ref":"#/definitions/RideRequestStatus"}},"204":{"description":"No running ride"}},"security":[{"tokenAuth":[]}]},"delete":{"tags":["ride"],"summary":"Cancel a running ride","description":"","operationId":"rideCancel","parameters":[{"name":"rideID","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation"},"204":{"description":"Ride was cancelled"},"404":{"description":"No ride was found with this ID"}},"security":[{"tokenAuth":[]}]}}},"securityDefinitions":{"tokenAuth":{"type":"apiKey","name":"X-Corp-Public-Token","in":"header"}},"definitions":{"CostCenterApi":{"type":"object","required":["name"],"properties":{"id":{"type":"integer","format":"int64","description":"Cost Center unique ID"},"name":{"type":"string","description":"Cost Center name","maxLength":30}}},"CostCenterApiRegister":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Cost Center name","maxLength":30}}},"Category":{"type":"object","required":["description","id","name"],"properties":{"id":{"type":"string","description":"Category identification"},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Cost Center short description"},"eta":{"type":"number","description":"ETA in minutes"}}},"CategoryModel":{"type":"object","required":["category"],"properties":{"category":{"$ref":"#/definitions/Category"},"estimate":{"$ref":"#/definitions/Estimate"},"optionals":{"type":"array","items":{"$ref":"#/definitions/Optional"}}}},"Estimate":{"type":"object","required":["currencyCode","fareText","fareTextComplement","lowerFare","upperFare"],"properties":{"lowerFare":{"type":"number","format":"double"},"upperFare":{"type":"number","format":"double"},"currencyCode":{"type":"string"},"fareText":{"type":"string"},"fareTextComplement":{"type":"string"}}},"Optional":{"type":"object","required":["description","id","title"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"}}},"EmployeeCostCenterModelResponse":{"type":"object","required":["id","name"],"properties":{"name":{"type":"string"},"id":{"type":"integer","format":"int64"}}},"ValidationError":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"field":{"type":"string"}}},"EmployeeCostCenterModelRequest":{"type":"object","required":["costCenterIDs"],"properties":{"costCenterIDs":{"type":"array","items":{"type":"number"}}}},"EmployeeModelRequest":{"type":"object","required":["categories","email","name","phone"],"properties":{"name":{"type":"string"},"phone":{"$ref":"#/definitions/EmployeePhoneModel"},"email":{"type":"string"},"nationalId":{"type":"string"},"pin":{"type":"string"},"externalId":{"type":"integer","format":"int64"},"categories":{"type":"array","items":{"type":"string"}}}},"EmployeePhoneModel":{"type":"object","required":["number"],"properties":{"number":{"type":"string"},"country":{"type":"string","example":"BRA"}}},"EmployeeRequest":{"type":"object","required":["employee"],"properties":{"employee":{"$ref":"#/definitions/EmployeeModelRequest"},"sendWelcomeEmail":{"type":"boolean"}}},"EmployeeModelResponse":{"type":"object","required":["categories","companyId","email","id","name","phone"],"properties":{"name":{"type":"string"},"phone":{"$ref":"#/definitions/EmployeePhoneModel"},"email":{"type":"string"},"companyId":{"type":"integer","format":"int64"},"nationalId":{"type":"string"},"pin":{"type":"string"},"enabled":{"type":"boolean"},"externalId":{"type":"integer","format":"int64"},"categories":{"type":"array","items":{"type":"string"}},"id":{"type":"integer","format":"int64"}}},"Driver":{"type":"object","properties":{"name":{"type":"string"},"phone":{"type":"string"},"car":{"type":"string"},"carYear":{"type":"integer","format":"int64"},"carPlate":{"type":"string"}}},"RideCompany":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"RideCostCenter":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"RideEmployee":{"type":"object","required":["email","id","name","phone","phoneCountry"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"phone":{"type":"string"},"phoneCountry":{"type":"string"},"email":{"type":"string"},"nationalId":{"type":"string"},"externalId":{"type":"integer","format":"int64"}}},"RideEvent":{"type":"object","required":["date","latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"date":{"type":"integer","format":"int64"},"address":{"type":"string"}}},"RideHistoryData":{"type":"object","required":["apiTaxiJobId","company","costCenter","driver","employee","end","fare","project","start","taxiCategoryName"],"properties":{"apiTaxiJobId":{"type":"integer","format":"int64"},"company":{"$ref":"#/definitions/RideCompany"},"employee":{"$ref":"#/definitions/RideEmployee"},"costCenter":{"$ref":"#/definitions/RideCostCenter"},"project":{"$ref":"#/definitions/RideProject"},"fare":{"type":"number"},"note":{"type":"string"},"odometer":{"type":"integer","format":"int64"},"start":{"$ref":"#/definitions/RideEvent"},"end":{"$ref":"#/definitions/RideEvent"},"driver":{"$ref":"#/definitions/Driver"},"city":{"type":"string"},"callPlatform":{"type":"string"},"requesterName":{"type":"string"},"taxiCategoryName":{"type":"string"}}},"RideProject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"RideHistory":{"type":"object","required":["rides","summary"],"properties":{"rides":{"type":"array","items":{"$ref":"#/definitions/RideHistoryData"}},"summary":{"$ref":"#/definitions/RideHistorySummary"}}},"RideHistorySummary":{"type":"object","required":["quantity","totalFare"],"properties":{"quantity":{"type":"integer","format":"int32"},"totalFare":{"type":"number"}}},"ProjectResponseModel":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"ProjectModelRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},"RideStarted":{"type":"object","required":["rideID"],"properties":{"rideID":{"type":"integer","format":"int64"}}},"RideAddress":{"type":"object","required":["latitude","longitude","number","street"],"properties":{"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"street":{"type":"string"},"number":{"type":"string"},"reference":{"type":"string"}}},"RideRequest":{"type":"object","required":["categoryID","costCenterID","employeeID","from","phoneNumber"],"properties":{"employeeID":{"type":"integer","format":"int64"},"from":{"$ref":"#/definitions/RideAddress"},"phoneNumber":{"type":"string"},"costCenterID":{"type":"integer","format":"int64"},"categoryID":{"type":"string"},"to":{"$ref":"#/definitions/RideAddress"},"notes":{"type":"string"},"projectID":{"type":"integer","format":"int64"},"optionals":{"type":"array","items":{"type":"string"}}}},"RideDriver":{"type":"object","properties":{"driverId":{"type":"integer","format":"int64"},"fullName":{"type":"string"},"phoneNumber":{"type":"string"},"carModel":{"type":"string"},"carPlate":{"type":"string"},"img":{"type":"string"},"position":{"$ref":"#/definitions/RideDriverPosition"}}},"RideDriverPosition":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"}}},"RideRequestStatus":{"type":"object","required":["categoryID","costCenterID","employeeID","from","phoneNumber"],"properties":{"employeeID":{"type":"integer","format":"int64"},"from":{"$ref":"#/definitions/RideAddress"},"phoneNumber":{"type":"string"},"costCenterID":{"type":"integer","format":"int64"},"categoryID":{"type":"string"},"to":{"$ref":"#/definitions/RideAddress"},"notes":{"type":"string"},"projectID":{"type":"integer","format":"int64"},"optionals":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"running":{"$ref":"#/definitions/RideRunning"}}},"RideRoute":{"type":"object","required":["distance","time"],"properties":{"time":{"type":"integer","format":"int32"},"distance":{"type":"integer","format":"int32"}}},"RideRunning":{"type":"object","required":["rideID"],"properties":{"rideID":{"type":"integer","format":"int64"},"jobID":{"type":"integer","format":"int64"},"driver":{"$ref":"#/definitions/RideDriver"},"route":{"$ref":"#/definitions/RideRoute"}}}}}