{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f78d10bf-7bf9-44aa-ab69-54106f517ba0","name":"Fleetroot FMS API","description":"- The fleetroot API is a RESTful web service for developers to programmatically interact with fleetroot’s data and real-time delivery management functionality.\n\n- Data exchanged between clients and the API is JSON over HTTPS in Production and HTTP in Demo.\n\n- The base URL for the Fleetroot API Production - https://api.fleetroot.com and Demo - http://demoapi.fleetroot.com , all the requests on this url use post method and we need to add the specific end points mentioned below to this URL.\n\n- All sample requests in this documentation are formatted for cURL.\n\n- API key is mandatory in all the API's request.\n\n- All parameters marked with * are mandatory otherwise optional.\n\n- If you have questions about using the API, want to share some feedback, or have come across a bug you'd like to report, write us an email at info@fleetroot.com .\n\n- Fleetroot API uses key based authentication method. You can get a key from Portal Settings(Login>Menu>Settings>API Keys) in your fleetroot account. Or click here to get API key.\n\n### Response Format\n\nAll the API's will have below Response Format\n\n- The response format will be Json having status, message and data key. Data will differ for each API call, so refer to response data format in each API.\n\n {\n \"data\": {\n },\n \"status\": 1,\n \"message\": \"Success\"\n }\n\n### Response Code\n\nWhen something is wrong with a request, the API will respond with a non-1 status code in the response. To help you better understand the problem, where possible, the API overloads a number of different error codes so your application logic has as much visibility as possible into what has gone wrong.\n\nBelow mentioned are the values of the api response `status` parameters of the respective API call:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusValue Description
Success 1 The API call is success.
AlreadyExists 2The record already exists.
RecordDoesNotExists3The record does not exists.
SomethingWentWrong4Something went wrong.
FailedToCreate11Failed to create a new record.
FailedToUpdate12Failed to validate a record.
FailedToValidate14 The task has been cancelled.
InvalidOrEmptyGuid16Invalid or empty id.
InvalidOrNullParameter17Invalid or empty parameter.
Unauthorized401The request did not include an authentication token or the authentication token is invalid.
InvalidApiKey403Invalid API Key is supplied.
ApiKeyNotSupplied404API key is not supplied or empty.
\n\n### Alert Type\n\nBelow mentioned are the values of the `AlertType` parameters of the respective Alert Types:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusValue Description
CountinuesDriving 1Vehicle Countinues Driving status.
DailyDrivingLimit2Vehicle Daily Driving Limit status
Disconnection3Vehicle Disconnection status
Idling4Vehicle Idling status
Ignition5Vehicle Ignition status
OutOfOfficeHour6Vehicle Out Of Office Hour status
Overspeed7Vehicle Over speed status
Overstay8Vehicle Over stay status
TemperatureSensor9Vehicle Temperature Sensor status
Fuel10Vehicle Fuel status
PoiFence11Vehicle Poi Fence status
RashDriving12Vehicle Rash Driving status
Drain13Drain status
InactiveRFIDPunch14Vehicle Inactive RFID Punch status
TerritorialFence15Vehicle Territorial Fence status
BatteryVoltage16Vehicle Battery Voltage status
TripAlert17Commute Trip Alert status
DoorAlert18 Door Alert status
EngineTemp19Engine Temp status
TrafficFine20Traffic Fine status
\n\n### Vehicle Type\n\nBelow mentioned are the values of the `VehicleType` parameters of the respective Vehicle Type:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusValue Description
Bus 1Bus
Car2Car
Truck3Truck
Bike4Bike
Trailer5Trailer
Pickup6Pickup
Equipment7Equipment
STATIONARY8STATIONARY
Forklift9Forklift
Boat16Boat
Scooter17Scooter
SmallTruck18SmallTruck
VAN19VAN
\n\n### Fleetroot Status\n\nBelow mentioned are the values of the `FleetrootStatus` parameters of the respective Vehicle Status:\n\n\n\n\n\n
StatusValue Description
Active 1Active
Inactive2,3Inactive
\n\n### Tracking Status\n\nBelow mentioned are the values of the `TrackingStatus` parameters of the respective Tracking Status:\n\n\n\n\n\n\n\n
StatusValue Description
Running 1Running
Idling2Idling
Stopped3Stopped
Disconnected4Disconnected
\n\n### Share Tracking Type\n\nBelow mentioned are the values of the `ShareTrackingType` parameters of the respective Share Tracking Type:\n\n\n\n\n\n
StatusValue Description
Live 0Live
History1History
\n\n### Webhook Best Practices\n\nThe following guide describes some best practices for working with webhooks.\n\n- Respond quickly\n\nAfter receiving a webhook using an HTTPS endpoint, it's important to respond to the request with a 200 OK as quickly as possible.\n\nA common pattern is to store the payload in a message queue for later processing by a background worker. This reduces the chance of the request timing out and the webhook delivery counting as a failure.\n\n- Ignore duplicates\n\nAlthough the webhooks API is designed to minimize duplicate webhook events, it is still possible to receive the same event more than once. Your app should handle webhook events using idempotent operations; that is, receiving the same webhook event a second time in a row should have no additional effect.\n\n- Manage delays\n\nIn rare circumstances, you might experience delays in receiving webhooks. However, webhooks are always sent with the most recent data for the given resource.\n\n- Implement reconciliation jobs\n\nYour app shouldn't rely solely on receiving data from webhooks. Because webhook delivery isn't always guaranteed, you should implement reconciliation jobs to periodically fetch data.\n\n### Webhook Retry Policy\n\nFleetroot follows an exponential webhook retry policy whenever any webhook fails to send data to the desired notification URL or a session timeout occurs. We trigger the retry policy whenever a webhook request returns a non-200 (OK) status code in the response.\n\n- Note\n \n Fleetroot waits for 20 seconds to receive data from the destination server. If the destination server fails to send data within this timeframe, then the webhook request is timed out.\n\nThe exponential retry policy attempts to send data to the destination URL again four more times after certain intervals.\n\n\n\n\n\n\n\n
Retry Instance No.Next Resend Internal
130 mins
22 Hrs
34 Hrs
48 Hrs
\n\nIf the webhook fails to execute succesfully after the last retry attempt, Fleetroot stops retrying. You can view the Audit logs to get more details.\n\n### Territorial Fence Type\n\nBelow mentioned are the values of the `TerritorialFenceType` parameters of the respective Tracking Status:\n\n\n\n\n\n
StatusValue Description
General 1General
RestricatedZone2Restricated Zone
\n\n### POI Category Type\n\nBelow mentioned are the values of the `POICategoryType` parameters of the respective Tracking Status:\n\n\n\n\n\n\n
StatusValue Description
Circle 1Circle
Rectangle2Rectangle
Polygon3Polygon
\n\n### POI Type\n\nBelow mentioned are the values of the `POIType` parameters of the respective Tracking Status:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusValue Description
Office 1Office
Customer2Customer
Warehouse3Warehouse
General4General
School5School
Stoppage6Stoppage
ProjectSite7Project Site
Accommodation8Accommodation
ConstructionArea9Construction Area
TemporaryArea10Temporary Area
ParkingArea11Parking Area
GasStation12Gas Station
Market13Market
Supermarket14Supermarket
Store15Store
Dealer16Dealer
Restaurant17Restaurant
CenterOfDistribution18Center Of Distribution
MaintenanceWorkshop19Maintenance Workshop
Toll20Toll
Factory21Factory
ServiceStation22Service Station
MedicalCenter23Medical Center
Pharmacy24Pharmacy
Home25Home
Farm26Farm
RestrictedZone27Restricted Zone
\n\n### Point\n\nBelow mentioned point table which we need to be refer while POI fence or Geo fence creation :\n\n\n\n\n\n
NameTypeDescription
latdouble The latitude of the location
lngdoublie The longitude of the location
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"43200585","team":6871445,"collectionId":"f78d10bf-7bf9-44aa-ab69-54106f517ba0","publishedId":"2sAYkGLKao","public":true,"publicUrl":"https://documenter-api.postman.tech/view/43200585/2sAYkGLKao","privateUrl":"https://go.postman.co/documentation/43200585-f78d10bf-7bf9-44aa-ab69-54106f517ba0","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-03-21T08:27:36.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Production","id":"53963db7-f387-4f7f-9a6f-8671a86a5bb7","owner":"43200585","values":[{"key":"token","value":"","type":"default","enabled":true},{"key":"collectionName","value":"","type":"default","enabled":true},{"key":"collectionSchemaUrl","value":"","type":"default","enabled":true},{"key":"accessKey","value":"","type":"default","enabled":true},{"key":"workspaceId","value":"","type":"default","enabled":true},{"key":"collectionId","value":"","type":"default","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/ac6436fed894b5a638b04542e9ac1b089f5fc8228f8649c7c50f2d342e7d7f56","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"43200585-53963db7-f387-4f7f-9a6f-8671a86a5bb7"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAYkGLKao"}