Document Version History
\nThis table shows a record of significant changes to the document.
\nAPI Url: https://data.lightfoot.co.uk
\nThe Lightfoot Application Programming Interface (API) is a RESTful API, using the Bearer Authentication method from OAuth2. Utilising JSON as the data structure for responses.
\nPlease note data is stored and returned in the metric system, and time is stored and returned in UTC.
\nThe API is designed to provide customers with direct access to product data held by Lightfoot. This document is aimed at both business and technical users to provide an understanding the data available via the API, and how to obtain it. To cater for these different audiences, this document will provide the following:
\nData and functionality available through the API
\nSecurity and Access to the API functionality
\nHow usage of the API is monitored and controlled
\nPostman Note: if you are using the collection in postman application, you will need to setup the parameters in your environment (url, username, password) and 'Pre-request script'. Please see Postman's documentation: https://learning.postman.com/docs/getting-started/introduction/
\nThe API uses Basic Authentication for all endpoints, and a 2-factor authentication method. All users must log in to obtain a token using their Lightfoot account credentials. Once a token has been obtained, it must then be used for further requests to obtain any data.
\nA Lightfoot account is required to login through the API and retrieve data. Please see the /login endpoint for details on how to login, and obtain a session token. Each user can only access data and entities relating to their account privilege.
\nAll API connections are encrypted using TLS (HTTPS). User sessions timeout after a period of inactivity.
\nAll successful and unsuccessful logins and usage of the API are recorded for security. Accounts are locked if 8 failed login attempts are made in consecutively, after the account password must be reset within the web portal https://my.lightfoot.co.uk/.
\nUser sessions expire after 1 hour of inactivity. If a session is no longer needed before this time then a request can be sent to the logout endpoint to terminate the current session token. More information is available in the /logout endpoint information.
\nUsage limits are in place to maintain system load and ensure consistent service for all customers. The standard limit for endpoints is 1 request per second. Exceptions are stated in the individual endpoints’ documentation.
\nShould a user reach their limit then the server will issue a 429 response with the ‘Request Limit Exceeded’ message.
\nIt is the responsibility of each API user to ensure the agreed number of requests is not exceeded. Connections may be throttled or terminated without notice if the limits are exceeded.
\nProduct usage data is available for 9 weeks from the logged / creation time.
\nPlease note all date / times are stored and returned in UTC, users preferred timezones are returned at login and on userinfo.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"OVERVIEW","slug":"overview"},{"content":"AUTHENTICATION AND SECURITY","slug":"authentication-and-security"},{"content":"USAGE THRESHOLDS","slug":"usage-thresholds"},{"content":"DATA HISTORY","slug":"data-history"}],"owner":"6999201","collectionId":"5592e7aa-86c1-4a46-a77a-30099519427b","publishedId":"S17qS9T6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"378642"},"publishDate":"2019-03-20T15:57:21.000Z"},"item":[{"name":"/login","event":[{"listen":"prerequest","script":{"id":"912bb936-0a3b-4eae-a6f0-5304a794adf7","exec":["","//pm.environment.set(\"username\", \"demo.driver@lightfoot.co.uk\");","//pm.environment.set(\"password\", \"demo123\");","pm.environment.set(\"username\", \"jay.bush@lightfoot.co.uk\");","pm.environment.set(\"password\", \"Not!76likely\");","//pm.environment.set(\"username\", \"montgomery.burns@lightfoot.co.uk\");","//pm.environment.set(\"password\", \"Password1\");"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"d76da96c-4436-4c9e-8f9a-ed492b49a10f","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"username\", \"1337link\");","pm.environment.set(\"password\", jsonData.data.apiToken);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"70e7e96b-899a-4e59-9164-d56661d236ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/login","description":"Used to authenticate the user. The endpoint will return a Session Id (token) to be used for all future calls to endpoints. The token (user session) expires after 1 (24 with the special user) hour of inactivity.
\nA Lightfoot username and password must be used on the login API to receive a session token. For all future requests to the other endpoints, bearer must be used for the username and the token as the password in the basic authentication header:
Please note, when the session token expires, the server will return a 403 status response with 'Incorrect user credentials' error message.
\nData returned in the vehicles object will list all vehicles assigned to the consumer driver account, or the fleet name and the last driven ICE fleet vehicle, and all driven fleet EV vehicles. (or both if they are a fleet driver and consumer). itemID will be vehicleID or fleetID, and itemName will be VRN or fleet name.
\n","urlObject":{"path":["v1","login"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"124dab98-3047-4aba-ab17-cfeea79a1d82","name":"/login","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://devapi.lightfoot.co.uk/v1/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Aug 2021 08:54:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.48 ()"},{"key":"X-Powered-By","value":"PHP/7.3.15"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept, Origin, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, PATCH, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"userID\": 4999,\n \"username\": \"DemoDriver\",\n \"vehicleCheckEnabled\": 1,\n \"dashcamEnabled\": 0,\n \"userTimezone\": \"Europe/London\",\n \"locale\": null,\n \"localeDisplayName\": null,\n \"isRoot\": 0,\n \"isDistributor\": 0,\n \"isFleetManager\": 0,\n \"mfaEnabled\": 0,\n \"fleetMobileTrackingApp\": 0,\n \"editLabels\": 1,\n \"EnhancedInsights\": 1,\n \"isDirectLogin\": 1,\n \"fleetWebPortal\": 0,\n \"currencySymbol\": \"£\",\n \"currencyName\": \"GBP\",\n \"unitOfMeasure\": \"Imperial\",\n \"apiToken\": \"2cd7a05adb8c28aaf9a18279fefeef129ecc8c751521f7515b5921ae25ffe19e\",\n \"vehicles\": [\n {\n \"fleetID\": 484,\n \"fleetName\": \"Demo Fleet\",\n \"VIN\": null,\n \"driverID\": 39726,\n \"yearManufactured\": 0,\n \"MOTRenewal\": \"2025-06-26\",\n \"taxRenewal\": \"2025-04-07\",\n \"vehicleID\": 17585,\n \"vehicleImage\": \"\",\n \"vehicleMake\": \"Audi\",\n \"vehicleModel\": \"A5 (2011)\",\n \"vehicleType\": \"Car\",\n \"fuel\": \"UNKNOWN\",\n \"isBatteryHealthy\": 0,\n \"VRM\": \"AB07ABC\",\n \"lastDrivenDate\": \"2024-09-24 11:04:25\",\n \"hubSerial\": 8388507,\n \"settings.audioVolume\": null,\n \"settings.endJourneyMessages\": 1,\n \"settings.inCabAssistance\": 1,\n \"settings.audioAssistance\": null,\n \"fleetManagerEmail\": null,\n \"SOC\": null,\n \"distRemaining\": null,\n \"ASevDataTimestamp\": null,\n \"isCharging\": null,\n \"latestChargeTime\": null\n }\n ],\n \"oauthToken\": null,\n \"apiV2Token\": {\n \"token_type\": \"Bearer\",\n \"expires_in\": 43200,\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJmZDZjMzFkNy01ZjdlLTExZWQtYmI5Mi0wYWRlNTNiNiIsImp0aSI6IjlmNDc4ZmJlOGU4NDU2ZjVkN2E3YTdlM2RiYjU0OTZlZWE4NGFmYjI1OTQxMTFmMGI5OWE0NTFlMTEwNjVlNDRjNDEwZWVmNWMzNTlmYmNiIiwiaWF0IjoxNzI3MTgwODcyLjE2ODg1NCwibmJmIjoxNzI3MTgwODcyLjE2ODg1NiwiZXhwIjoxNzI3MjI0MDcyLjE0NTMwNCwic3ViIjoiZGVtby5kcml2ZXJAbGlnaHRmb290LmNvLnVrIiwic2NvcGVzIjpbImVtYWlsIl19.cZ4AfJFg8X_dSeZ5j71iy_wcvJ2ZE4xB3Ym1RAnxN2gwjKPpJM-cENsjKc5Fc88s6LoSJ5vEBjMRcuUMQja-Dfr4Y5onXt0R4E-1VU88_sDpA4ntlzoqXok_navHvJkmsOF_jRdGjsFAbEQXdIvx6cfgh-y4XyPBqzDr-Iu1MuFoYxlrT-L2eTg7KlZsiZhvAvBrBueAQI7vII3Btf-YBwCtKEzcnlG2Md-PnrMJbb0zNstMmYxqI_1RMlWadoCwzpe4ZrUSljLS89-dbjDxraE71QXIDM6sWJCWIcb8oGnYpgcCTVj769SzhpSIFM2f4gykZB0PSNQWJPa51S-e9w\",\n \"refresh_token\": \"def50200ce61dbbe5ec573f4d1ed9e6258cb530e349ad75c3ad6a2570229ffd1712f995a9e8a555f8017de2f4242e9989d7148bdcbc95d0b71725903ab524334b0de1e9e448e4c6c67e8161a816c1abee2edcfecb9762b76d8c8e873a64a0a835c53f77dd76214d97e2831efb6429c344302b6fabe8e2d2a2bdfdd8fd11ba7793023142e105125c35d94891a6c5f9a10aca69577fbd236871539788ac5cc93e1fff4f32665a08ba2dc2157fe74291fbcb9bbf8dd8cd267200781e3a22ca7cdab921668dce8585890a8c9e443f971a7095d71d3bf3a90cc549515c35a2a06fd3aa9e1c63286bcdeba7fe6bd9d39d0839e5c26515f7f6d073c6b1e6db6f0ccdd8be82f3faf642a44445c5b61b081a3ec593cdf093c8bfdff13749b11be16499906197af7ab8eb108713ba282484e06d725261f93455f2edf6dc5f2876e957675cc2ff1831674f76811af2c9de6c82d3b9c795f77944a02e1ef96ce9173cda6b7f833ff50fe9741124babf09ff570b3651b5f33bd1e0b5903354e9f978f6bba96c8dd2c6752acdffb646fca2174c9710111e230a419e19ccfe6b7fff2871c8f6bbad3a382\",\n \"data\": [],\n \"meta\": {\n \"requestId\": \"dcc68f93\",\n \"datetime\": \"2024-09-24T12:27:52+00:00\"\n }\n }\n }\n}"}],"_postman_id":"70e7e96b-899a-4e59-9164-d56661d236ef"},{"name":"/driver/register","id":"8f44153b-ece1-4e9c-8bbd-5c2221f046cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\" : \"Phil\",\r\n \"lastName\" : \"Test\",\r\n \"email\" : \"biglemail@mail.com\",\r\n \"password\": \"rawpassword\",\r\n \"fleet\": {\r\n \t\"fleetCompanyName\": \"Lightfoot\",\r\n \t\"driverCode\":\"1234567\"\r\n }\r\n}"},"url":"{{url}}/v1/driver/register","description":"Purpose: Register a new driver-level account and return login details for immediate use.
\nAccepts JSON or application/x-www-form-urlencoded bodies (Slim's $request->getParams() supports both).
Validates basic user information and an optional fleet object.
\nIf provided, fleet.driverCode must contain only hexadecimal characters (letters A–F/a–f and digits 0–9). The code is normalised to lowercase before processing.
A custom validation message is returned for driverCode when invalid: \"Activation code should only contain letters and numbers\".
Middleware: TranslationMiddleware and LoggerMiddleware (no authentication required on this route; no explicit rate limiting here).
\nMethod: POST
URL: /v1/driver/register
Status Codes: 200 OK, 400 Bad Request
Not applicable for this endpoint.
\nNot applicable for this endpoint.
\nNot applicable for this endpoint.
\nSuccess: Returns 200 OK with a JSON object of the user's login details as produced by AccountHelper->registerGetLoginDetails(...). Exact field names may vary by implementation.
Validation failure: Returns 400 with a JSON object mapping invalid fields to human-readable messages. The driverCode validation uses a custom message.
Successful registration (example fields may vary):
\n{\n \"userID\": 123456,\n \"email\": \"driver@example.com\",\n \"firstName\": \"Alex\",\n \"lastName\": \"Driver\",\n \"token\": \"eyJhbGciOi...\",\n \"expiresIn\": 3600\n}\n\nValidation error (examples):
\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"firstName Required, lastName Required, email Required, password Required\"\n }\n}\n\nPurpose: Retrieve competition details and computed state for a specific competition.
\ncompetitionID (int).Method: GET
URL: /v1/driver/competition
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\n/competitions, wrapped in the state-grouping transformer but for a single item.{\n \"data\": {\n \"open\": [\n {\n \"competitionID\": 501,\n \"title\": \"September Prize Draw\",\n \"startDate\": \"2025-09-01\",\n \"endDate\": \"2025-09-30\",\n \"competitionState\": \"open\"\n }\n ]\n }\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"All of the required rules must pass for { competitionID: demoString }\"\n }\n}\nPurpose: Return competitions relevant to the authenticated user within an optional date window, grouped by state (open, closed, upcoming) and with a Terms and Conditions link.
\nstartDate/endDate are not specified, defaults to last 5 weeks to +12 weeks.termsAndConditionsLink and groups competitions by computed competitionState.Method: GET
URL: /v1/driver/competitions
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\nopen, closed, and upcoming. Each item is enriched with competitionState.{\n \"data\": {\n \"termsAndConditionsLink\": \"https://example.com/terms/competition\",\n \"open\": [\n {\n \"competitionID\": 501,\n \"title\": \"September Prize Draw\",\n \"startDate\": \"2025-09-01\",\n \"endDate\": \"2025-09-30\",\n \"competitionState\": \"open\"\n }\n ],\n \"closed\": [\n {\n \"competitionID\": 490,\n \"title\": \"August Lottery\",\n \"startDate\": \"2025-08-01\",\n \"endDate\": \"2025-08-31\",\n \"competitionState\": \"closed\"\n }\n ],\n \"upcoming\": [\n {\n \"competitionID\": 510,\n \"title\": \"October Prize\",\n \"startDate\": \"2025-10-01\",\n \"endDate\": \"2025-10-31\",\n \"competitionState\": \"upcoming\"\n }\n ]\n }\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"All of the required rules must pass for { startDate: demoString }\"\n }\n}\nPurpose: Return past (closed) competitions associated with the user (e.g., recently closed or won).
\nMethod: GET
URL: /v1/driver/myCompetitions
Status Codes: 200 OK, 401 Unauthorized, 500 Internal Server Error
None.
\nNone.
\nNot applicable.
\nNot applicable.
\nNot applicable.
\nsp_api_competition_getClosedByDriver).{\n \"data\": [\n { \"competitionID\": 490, \"title\": \"August Lottery\", \"endDate\": \"2025-08-31\" },\n { \"competitionID\": 475, \"title\": \"July Promo\", \"endDate\": \"2025-07-31\" }\n ]\n}\nPurpose: Return a consolidated dashboard for the user including device status, journeys summaries (last week/this week/last30Days/thisYear), unrevealed lotteries, new competition wins, notifications, last journey, featured competitions, and vehicles. Provides a sectionOrder object to suggest UI ordering.
Requires authenticated userID and optionally uses driverIDs attribute for journey-related sections.
Journeys breakdown keys include: last week vs this week keyed by weekStr, plus last30Days and thisYear rollups (may be empty objects).
Adds prizeDisclaimer if there are unrevealed lotteries: \"Prize value is indicative only due to exchange rate fluctuations and paid out in GBP\".
Method: GET
URL: /v1/driver/dashboard
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\n{\n \"data\": {\n \"sectionOrder\": {\n \"journeys\": 0,\n \"unrevealedLottery\": 1,\n \"newCompetitionWin\": 2,\n \"notifications\": 3,\n \"lastJourney\": 4,\n \"featuredCompetitions\": 5,\n \"vehicles\": 6\n },\n \"journeys\": {\n \"2025-W35\": { \"score\": 95.2, \"distance\": 120.4 },\n \"2025-W36\": { \"score\": 96.1, \"distance\": 98.7 },\n \"last30Days\": {},\n \"thisYear\": {}\n },\n \"unrevealedLottery\": [],\n \"newCompetitionWin\": [],\n \"notifications\": \"\",\n \"lastJourney\": { \"journeyID\": 12345, \"date\": \"2025-09-08\" },\n \"featuredCompetitions\": [ { \"competitionID\": 501, \"title\": \"September Prize\" } ],\n \"vehicles\": [ { \"vehicleID\": 77, \"registration\": \"AB12CDE\" } ]\n }\n}\n\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Something went wrong.\"\n }\n}\n\nPurpose: Return journeys for the authenticated driver's driverIDs between startDate and endDate, with options to include zero-distance trips, select units, and filter by vehicle.
startDate and endDate in format YYYY-MM-DD.endDate has no time component, it is adjusted to the end of the given day (23:59:59).zeroTrips and unitType are provided as integers and internally treated as booleans (non-zero => true).vehicleID filters to a single vehicle.Method: GET
URL: /v1/driver/journeys
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 403 Forbidden, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\n{\n \"data\": {\n \"journeys\": [\n {\n \"journeyID\": 12345,\n \"driverID\": 789,\n \"vehicleID\": 456,\n \"startDateTime\": \"2025-09-01T08:15:00Z\",\n \"endDateTime\": \"2025-09-01T08:45:00Z\",\n \"distance\": 12.4,\n \"unit\": \"mi\",\n \"type\": \"business\",\n \"score\": 96.3,\n \"note\": \"Visited client\"\n }\n ]\n }\n}\nPurpose: Return standings and details for a given league. Supports either grouped public leagues or individual leagues based on leagueType.
leagueID.leagueType query parameter:grouped: fetches a grouped public league preview via LeagueHelper->getGroupedLeague(...) (previous week).individual: fetches an individual league a user belongs to via LeagueHelper->getIndividualLeague(...) (previous week).LeagueHelper->getLeague(...) with week (defaults to lastweek).Method: GET
URL: /v1/driver/league
Status Codes: 200 OK, 400 Bad Request
Not applicable.
\nNot applicable.
\nNot applicable.
\nleagueID, leagueName, leagueType: grouped, userStatus (joined/notJoined), and preview (top positions, including the user's position if applicable).leagueType: individual and participants array (ordered with positions).participants for the given week.leagueID (int), leagueName (string), leagueType (\"grouped\"), userStatus (string), members (int, for some grouped responses), preview (array of group entries with position, leagueID/groupID, names/scores).leagueID (int), leagueName (string), optionally leagueType (\"individual\"), participants (array of participant objects). The current user's anonymized fields may be de-anonymised.{\n \"leagueID\": 2001,\n \"leagueName\": \"Public Counties League\",\n \"leagueType\": \"grouped\",\n \"userStatus\": \"joined\",\n \"members\": 128,\n \"preview\": [\n { \"position\": 1, \"groupID\": 3001, \"groupName\": \"County A\", \"score\": 97.3, \"userStatus\": \"notJoined\" },\n { \"position\": 2, \"groupID\": 3005, \"groupName\": \"County B\", \"score\": 96.1, \"userStatus\": \"joined\" },\n { \"position\": 3, \"groupID\": 3003, \"groupName\": \"County C\", \"score\": 95.9, \"userStatus\": \"notJoined\" },\n { \"position\": 4, \"groupID\": 3002, \"groupName\": \"County D\", \"score\": 95.0, \"userStatus\": \"notJoined\" }\n ]\n}\n{\n \"leagueID\": 101,\n \"leagueName\": \"Acme Fleet League\",\n \"leagueType\": \"individual\",\n \"participants\": [\n { \"position\": 1, \"driverID\": 7001, \"screenName\": \"Top Driver\", \"score\": 98.7 },\n { \"position\": 2, \"driverID\": 7002, \"screenName\": \"Jane D.\", \"score\": 97.1 }\n ]\n}\n{ \"error\": \"Incorrect League ID or not allowed.\" }\nOptional 'individual' or 'grouped' Defaults to individual
\n","type":"text/plain"},"key":"leagueType","value":"individual"},{"disabled":true,"description":{"content":"Optional 'thisweek' or 'lastweek' Defaults to lastweek
\n","type":"text/plain"},"key":"week","value":"thisweek"}],"variable":[]}},"response":[{"id":"71702f34-7c17-4783-ac28-9b9b1d8e7746","name":"/driver/league","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v1/driver/league?leagueID=4656","host":["{{url}}"],"path":["v1","driver","league"],"query":[{"key":"leagueID","value":"4656"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 07 Jun 2019 14:45:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.37 ()"},{"key":"X-Powered-By","value":"PHP/7.2.16"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Upgrade","value":"h2,h2c"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"leagueID\": 4656,\n \"leagueName\": \"test\",\n \"leagueType\": \"individual\",\n \"userStatus\": 0,\n \"leagueCategory\": \"Private\",\n \"members\": 1,\n \"participants\": [\n {\n \"leagueName\": \"test\",\n \"driverID\": 39720,\n \"screenName\": \"Handy Driver\",\n \"firstName\": \"Handy\",\n \"lastName\": \"Driver\",\n \"imageURL\": \"https://lf-profile-pictures.s3.eu-west-1.amazonaws.com/S12Wizard-1536582479.png\",\n \"score\": null,\n \"mileage\": null,\n \"isPrimary\": \"0\",\n \"leagueID\": 4656,\n \"globalUserID\": 10972,\n \"position\": 1,\n \"anonDrivers\": 0\n }\n ]\n }\n}"}],"_postman_id":"17f379f6-7c5b-4812-9960-c425c8e3355a"},{"name":"/driver/leagues","id":"cbe74537-235a-4e56-a506-605dfc31bb94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url}}/v1/driver/leagues","description":"Purpose: Retrieve the leagues that a driver is associated with.
\nProvides a comprehensive overview of the leagues a driver is part of, including various settings and identifiers associated with each league.
\nMethod: GET
URL: /v1/driver/leagues
Status Codes: 200 OK, 401 Unauthorized, 404 Not Found
Not Applicable
\nNot Applicable
\nNot Applicable
\nNot Applicable
\nNot Applicable
\nReturns an array of league objects with detailed properties for each league associated with the driver.
\n{\n \"data\": [\n {\n \"leagueID\": 0,\n \"name\": \"\",\n \"description\": \"\",\n \"privacySetting\": \"\",\n \"fleetLeague\": 0,\n \"sponsoredLeague\": 0,\n \"fleetLevelID\": 0,\n \"defaultLeague\": 0,\n \"groupUserID\": 0,\n \"userID\": 0,\n \"userEmailSetting\": 0,\n \"groupEmailSetting\": 0,\n \"admin\": null,\n \"inviteStatus\": 0,\n \"isPrimary\": \"\",\n \"anonDrivers\": 0\n }\n ]\n}\nThis API endpoint retrieves the league dashboard for the user. It returns any pending invitations that have been received but not yet accepted, along with details of the leagues the user is part of, including scores of other members within those leagues and information on leagues that are available to join.
\nMethod: GET
\nEndpoint: {{url}}/v1/driver/leagueDash
Status: 200
\nContent-Type: application/json
\nThe response is a JSON object containing the following fields:
\ndata (object): The main data object containing:
\ninvitations (array): An array of invitation objects. Each invitation object has the following structure:
\nleagueID (integer): The unique identifier for the league.
\nleagueName (string): The name of the league.
\ninviteFrom (string): The user who sent the invitation.
\npublic (object): An object representing public leagues the user can join. Each key is a league ID with the following structure:
\nleagueName (string): The name of the public league.
\nleagueType (string): The type of the league.
\nuserStatus (string): The user's status in the league.
\nscore (array): An array of score objects for the league. Each score object has:
\ncompetitionID (integer): The unique identifier for the competition.
\nleagueID (integer): The unique identifier for the league.
\ncompetitionName (string): The name of the competition.
\nname (string): The name of the participant.
\nscore (string): The score of the participant.
\nimageUrl (string): A URL to the participant's image.
\nposition (integer): The position of the participant in the league.
\nuserStatus (string): The status of the user in the league.
\nprivate (object): An object representing private leagues the user is part of. Each key is a league ID with the following structure:
\nmembers (integer): The number of members in the private league.
\nleagueName (string): The name of the private league.
\nleagueType (string): The type of the league.
\nuserStatus (string): The user's status in the league.
\nscore (array): An array of score objects for the league. Each score object has:
\nleagueName (string): The name of the league.
\ndriverID (integer): The unique identifier for the driver.
\nscreenName (string): The screen name of the driver.
\nfirstName (string): The first name of the driver.
\nlastName (string): The last name of the driver.
\nscore (integer): The score of the driver.
\nmileage (string): The mileage of the driver.
\nleagueID (integer): The unique identifier for the league.
\nglobalUserID (integer): The global user identifier.
\nposition (integer): The position of the driver in the league.
\nanonDrivers (integer): The number of anonymous drivers.
\nSuccessful Response:
\n{\n \"data\": {\n \"invitations\": [],\n \"public\": {\n \"887\": {\n \"leagueName\": \"Public League A\",\n \"leagueType\": \"Open\",\n \"userStatus\": \"Joined\",\n \"score\": [\n {\n \"competitionID\": 1,\n \"leagueID\": 887,\n \"competitionName\": \"Competition 1\",\n \"name\": \"John Doe\",\n \"score\": \"100\",\n \"imageUrl\": \"http://example.com/image.jpg\",\n \"position\": 1,\n \"userStatus\": \"Active\"\n }\n ]\n }\n },\n \"private\": {\n \"4651\": {\n \"members\": 5,\n \"leagueName\": \"Private League B\",\n \"leagueType\": \"Invite Only\",\n \"userStatus\": \"Pending\",\n \"score\": [\n {\n \"leagueName\": \"Private League B\",\n \"driverID\": 123,\n \"screenName\": \"Driver123\",\n \"firstName\": \"Alice\",\n \"lastName\": \"Smith\",\n \"score\": 95,\n \"mileage\": \"1500\",\n \"leagueID\": 4651,\n \"globalUserID\": 456,\n \"position\": 2,\n \"anonDrivers\": 1\n }\n ]\n }\n }\n }\n}\n\nError Response:
\n{\n \"error\": {\n \"code\": 400,\n \"message\": \"Bad Request\"\n }\n}\n\nIt will also consist of leagues you are in along with details for each league, including scores of others within the league, and ones eligeble to join.
\n","urlObject":{"path":["v1","driver","leagueDash"],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"Optional 'thisweek', 'lastweek' defaults to lastweek if not set.
\n","type":"text/plain"},"key":"week","value":"thisweek"}],"variable":[]}},"response":[{"id":"d3f345ed-3228-4077-a2a5-e033ee0708cb","name":"/driver/leagueDash","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/driver/leagueDash"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 08 May 2019 13:33:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.37 ()"},{"key":"X-Powered-By","value":"PHP/7.2.16"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Upgrade","value":"h2,h2c"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"invitations\": [\n {\n \"leagueID\": 4652,\n \"leagueName\": \"Raiding, Ploughing, Looting\",\n \"inviteFrom\": \"The Viking\"\n }\n ],\n \"public\": {\n \"887\": {\n \"leagueName\": \"Counties\",\n \"leagueType\": \"grouped\",\n \"userStatus\": \"joined\",\n \"score\": [\n {\n \"competitionID\": 887,\n \"leagueID\": 3832,\n \"competitionName\": \"Counties\",\n \"name\": \"Cornwall\",\n \"score\": \"DQ\",\n \"imageUrl\": \"/assets/img/leagues/counties-cornwall-flag.png\",\n \"position\": 1,\n \"userStatus\": \"notJoined\"\n },\n {\n \"competitionID\": 887,\n \"leagueID\": 4472,\n \"competitionName\": \"Counties\",\n \"name\": \"Hampshire\",\n \"score\": \"DQ\",\n \"imageUrl\": \"/assets/img/leagues/counties-hampshire-flag.png\",\n \"position\": 9,\n \"userStatus\": \"notJoined\"\n },\n {\n \"competitionID\": 887,\n \"leagueID\": 4650,\n \"competitionName\": \"Counties\",\n \"name\": \"Herefordshire\",\n \"score\": \"DQ\",\n \"imageUrl\": \"/assets/img/leagues/counties-herefordshire-flag.png\",\n \"position\": 10,\n \"userStatus\": \"joined\"\n },\n {\n \"competitionID\": 887,\n \"leagueID\": 4473,\n \"competitionName\": \"Counties\",\n \"name\": \"Kent\",\n \"score\": \"DQ\",\n \"imageUrl\": \"/assets/img/leagues/counties-kent-flag.png\",\n \"position\": 11,\n \"userStatus\": \"notJoined\"\n }\n ]\n }\n },\n \"private\": {\n \"4651\": {\n \"members\": 2,\n \"leagueName\": \"My Driving Mates\",\n \"leagueType\": \"individual\",\n \"userStatus\": \"joined\",\n \"score\": [\n {\n \"leagueName\": \"My Driving Mates\",\n \"driverID\": 39720,\n \"screenName\": \"Handy Driver\",\n \"firstName\": \"Handy\",\n \"lastName\": \"Driver\",\n \"score\": 9327,\n \"mileage\": \"505.9\",\n \"leagueID\": 4651,\n \"globalUserID\": 10972,\n \"position\": 1,\n \"anonDrivers\": 0\n },\n {\n \"leagueName\": \"My Driving Mates\",\n \"driverID\": 39720,\n \"screenName\": \"Handy Driver\",\n \"firstName\": \"Handy\",\n \"lastName\": \"Driver\",\n \"score\": 8057,\n \"mileage\": \"56.5\",\n \"leagueID\": 4651,\n \"globalUserID\": 10972,\n \"position\": 2,\n \"anonDrivers\": 0\n }\n ]\n }\n }\n }\n}"}],"_postman_id":"6f0eeb45-8e1d-4cee-879f-1bece14d8efc"},{"name":"/driver/leagueGroups","id":"698b9760-dc09-4422-babc-b2573680fd1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v1/driver/leagueGroups?leagueID=\"foot\"","description":"Purpose: Return grouped league scores (e.g., by regions/divisions) for a specific league group.
\nleagueID. Validated as int.LeagueHelper->getLeagueGroupScoresByCompetitionID(leagueID) to fetch preview rows with positions and group metadata.Method: GET
URL: /v1/driver/leagueGroups
Status Codes: 200 OK, 400 Bad Request
Not applicable.
\nNot applicable.
\nNot applicable.
\nleagueID, leagueName, groupID, groupName, scores, and will be augmented with a position key and userStatus in helper composition.[\n { \"leagueID\": 2001, \"leagueName\": \"Public Counties League\", \"groupID\": 3001, \"groupName\": \"County A\", \"score\": 97.3 },\n { \"leagueID\": 2001, \"leagueName\": \"Public Counties League\", \"groupID\": 3005, \"groupName\": \"County B\", \"score\": 96.1 }\n]\n{\n \"data\": \"No data found\"\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"All of the required rules must pass for { leagueID: demoString }\"\n }\n}\nPurpose: Return deals for the user. Currently returns a static stub JSON payload.
\nMethod: GET
URL: /v1/driver/myDeals
Status Codes: 200 OK
None.
\nNone.
\nNot applicable.
\nNot applicable.
\nNot applicable.
\n{\n \"data\": {\n \"deals\": [\n { \"title\": \"10% off accessories\", \"expires\": \"2025-12-31\" }\n ]\n }\n}\nPurpose: Return account details for the user plus their vehicles list.
\nMethod: GET
URL: /v1/driver/userInfo
Status Codes: 200 OK, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\nvehicles appended as an array from the presenter.{\n \"data\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"email\": \"jane@example.com\",\n \"speedUnits\": \"mph\",\n \"vehicles\": [\n { \"vehicleID\": 77, \"registration\": \"AB12CDE\" }\n ]\n }\n}\nPurpose: Return vehicles for the authenticated user. If no vehicles, returns \"No data found\" as data.
data to the string \"No data found\" when empty.Method: GET
URL: /v1/driver/vehicles
Status Codes: 200 OK, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\n{\n \"data\": [\n { \"vehicleID\": 77, \"registration\": \"AB12CDE\", \"hubSerial\": 1234567, \"settings.audioVolume\": 4 }\n ]\n}\n{\n \"data\": \"No data found\"\n}\n{\n \"error\": {\n \"status\": 500,\n \"message\": \"<error details>\"\n }\n}\nPurpose: Fetch electric vehicle charges for a user within a date range.
\nuserID from request context.startDate, endDate (UTC Y-m-d).Method: GET
URL: /vehicleCharges
Status Codes: 200 OK, 400 Bad Request, 500 Internal Server Error
Returns a list of vehicle charges along with metadata.
\n{\n \"charges\": [\n {\n \"id\": 1,\n \"vehicleID\": 123,\n \"startTime\": \"2025-09-01 08:00\",\n \"endTime\": \"2025-09-01 09:00\",\n \"locationType\": 2\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}\nThis section documents the Vehicle Check APIs. These endpoints support driver vehicle checks, retrieving vehicle check status, questions, and saving check answers (with optional attachments).
\nGET /vehicleCheckStatus
Purpose: Returns the completion status of a vehicle check for the logged-in user.
\nUses the authenticated user's userID (request attribute).
Wraps logic via VehicleCheckHelper::userCompletedCheck().
If an error is present, a 400 Bad Request is returned.
Method: GET
URL: /vehicleCheckStatus
Status Codes: 200 OK, 400 Bad Request
No request parameters required. The endpoint uses the _userID_ from the request attribute.
Success (200)
\n{\n \"status\": \"success\",\n \"data\": {\n \"completed\": true,\n \"lastCheckDate\": \"2025-09-07T08:00:00Z\"\n },\n \"message\": \"OK\"\n}\n\nError (400)
\n{\n \"status\": \"error\",\n \"data\": [\"Data Missing, {\"checkID\": \"Invalid\"}\"],\n \"message\": \"Invalid vehicle check data\"\n}\n\nThis section documents the Vehicle Check APIs. These endpoints support driver vehicle checks, retrieving vehicle check status, questions, and saving check answers (with optional attachments).
\n/vehicleQuestionsPurpose: Retrieves the vehicle check questions for a given vehicle, identified by VRM.
\nRequires query parameter vrm (ASCII string).
Validates via Respect\\Validation.
Returns vehicle check structure via VehicleCheckHelper::getVehicleCheck().
Method: GET
URL: /vehicleQuestions
Status Codes: 200 OK, 400 Bad Request
None.
\nSuccess (200)
\n{\n \"status\": \"success\",\n \"data\": {\n \"questions\": [\n {\n \"id\": 1,\n \"text\": \"Are tyres in good condition?\",\n \"type\": \"boolean\"\n },\n {\n \"id\": 2,\n \"text\": \"Record odometer reading\",\n \"type\": \"number\"\n }\n ]\n },\n \"message\": \"OK\"\n}\n\nError (400)
\n{\n \"status\": \"error\",\n \"data\": [\"Data Missing, {\"vrm\": \"Invalid\"}\"],\n \"message\": \"Invalid VRM provided\"\n}\n\nPurpose: Fetch weekly driving scores for the authenticated user, along with the user's preferred speed units.
\nweeklyScores with userSettings.preferredUnits taken from speedUnits request attribute.Method: GET
URL: /v1/driver/weeklyScores
Status Codes: 200 OK, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\nNot applicable.
\nNot applicable.
\n{ data: { userSettings, weeklyScores } }.{\n \"data\": {\n \"userSettings\": { \"preferredUnits\": \"mph\" },\n \"weeklyScores\": [\n { \"weekStart\": \"2025-08-25\", \"weekEnd\": \"2025-08-31\", \"score\": 95.2 },\n { \"weekStart\": \"2025-09-01\", \"weekEnd\": \"2025-09-07\", \"score\": 96.0 }\n ]\n }\n}\n{\n \"error\": {\n \"status\": 500,\n \"message\": \"Unable to fetch weekly scores\"\n }\n}\nPurpose: Enter a competition for the authenticated user.
\ncompetitionID (int). If user has insufficient points or a business rule fails, a 400 error is thrown.Method: POST
URL: /v1/driver/competition
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\nsp_api_competition_enter on success.{\n \"data\": {\n \"competitionID\": null,\n \"hasEnteredCompetition\": 1,\n \"name\": null,\n \"description\": null,\n \"imageURL\": null,\n \"startDate\": null,\n \"endDate\": null,\n \"remainingSpaces\": null,\n \"premiumEntrancePoints\": null,\n \"winnersName\": null,\n \"winnerUserID\": null,\n \"competitionType\": null,\n \"prizeCompetitionEntrantID\": null\n }\n}\n\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Insufficient points\"\n }\n}\n\nPurpose: Activate a driver within a fleet using an activation code (and optional fleet name), then return login details. Sends a welcome email if activation completes.
\nactivationCode (hex string) and optional fleetName.needsInstallationOrFleet == 0 in details, triggers welcome email via SparkPost.Method: POST
URL: /v1/driver/fleetActivation
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\n{\n \"data\": {\n \"email\": \"jane@example.com\",\n \"needsInstallationOrFleet\": 0,\n \"message\": \"Activation complete\"\n }\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"All of the required rules must pass for { activationCode: demoString }\"\n }\n}\nPurpose: Update hub/device settings for a specific vehicle by computing differences and sending updates to the hub.
\nsettings:audioVolume (int),endJourneyMessages (bool),inCabAssistance (bool),audioAssistance (int).vehicleID belongs to the authenticated user; otherwise returns a message that no changes will be made (implicitly, via comparison result being null if not found).\"No changes, hub settings not updated.\".Method: POST
URL: /v1/driver/deviceSettings
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\n{\n \"data\": {\n \"message\": \"No changes, hub settings not updated.\"\n }\n}\n{\n \"data\": {\n \"message\": \"Hub settings successfully updated.\"\n }\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"All of the required rules must pass for { settings.audioVolume: demoString }\"\n }\n}\nPurpose: Generate an expense report (CSV/PDF) for a set of journeys and email it to a recipient. Marked as possibly deprecated in code.
\n/sendExpense and /downloadExpenses endpoints.Method: POST
URL: /v1/driver/expenseReport
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\n{ \"message\": \"Successfully sent expense report.\" }\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Invalid recipientEmail\"\n }\n}\nPurpose: Set a journey's type to personal or business.
Method: POST
URL: /v1/driver/journeyType
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 403 Forbidden, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\nNot applicable.
\nJourneyHelper->updateJourneyType(...). Shape depends on helper; commonly includes the updated journey or a status.{ \"journeyID\": 12345, \"journeyType\": \"business\", \"updatedBy\": 42, \"updatedAt\": \"2025-09-09T12:34:56Z\" }\n{\n \"error\": {\n \"status\": 403,\n \"message\": \"You don't have permission to change the journey type\"\n }\n}\nPurpose: Join a league or a grouped league on behalf of the user's drivers.
\nleagueID or groupID (validated with Respect oneOf).LeagueHelper->joinLeague(driverIDs, leagueIDOrGroupID); will raise a 400 if the league is private and the user has no invitation.Method: POST
URL: /v1/driver/joinLeague
Status Codes: 200 OK, 400 Bad Request
Not applicable.
\nNot applicable.
\nNot applicable.
\n{ \"leagueID\": 101, \"status\": \"joined\" }\n{\n \"error\": {\n \"status\": 400,\n \"message\": {\n \"error\": \"Can not join a private league for which you've not had an invitation.\",\n \"leagueID\": 4651\n }\n }\n}\nPurpose: Invite a driver (by email) to join a league where the current user is an admin.
\nuserEmail (ASCII) and leagueID (int).sp_api_leagues_adminCheck; if not, returns 401 with You are not an admin.Method: POST
URL: /v1/driver/inviteLeague
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized
Not applicable.
\nNot applicable.
\nNot applicable.
\nsp_api_leagues_invite (an object describing the invitation created).{ \"leagueID\": 101, \"invitedDriverID\": 555, \"status\": \"invited\" }\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"All of the required rules must pass for { leagueID: demoString }\"\n }\n}\nPurpose: Leave a league on behalf of the user's drivers.
\nleagueID.LeagueHelper->leaveLeague(leagueID, driverIDs, userID) and returns DB result.Method: POST
URL: /v1/driver/leaveLeague
Status Codes: 200 OK, 400 Bad Request
Not applicable.
\nNot applicable.
\nNot applicable.
\n{ \"leagueID\": 101, \"status\": \"left\" }\n{\n \"data\": \"No data found\"\n}\n{\n \"error\": {\n \"status\": 500,\n \"message\": \"leagueID must be an integer number\"\n }\n}\nPurpose: Create a new league (group) for consumer fleets (where applicable).
\ngroupName (ASCII). When present and the user is a consumer driver (fleet type), creates a new private league for the driver via LeagueHelper->createLeague(userID, groupName, driverID).['No league created'].Method: POST
URL: /v1/driver/league
Status Codes: 200 OK, 400 Bad Request
Not applicable.
\nNot applicable.
\nNot applicable.
\n{ \"leagueID\": 12345, \"leagueName\": \"My Private League\", \"status\": \"created\" }\n{\n \"data\": [\n \"No league created\"\n ]\n}\n[\"<error details>\"]\nPurpose: Claim a prize for a lottery or competition. Accepts either a lottery claim (requires lotteryID and email) or a competition prize claim (requires prizeID and address/contact details). Validates postcodes by country.
lotteryID or prizeID must be provided (validated with oneOf).email (valid email).name, email, country (ISO code), address1, city, postcode (validated based on country), optional phoneNumber, address2, county.Method: POST
URL: /v1/driver/prizeClaim
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
lotteryIDprizeIDprizeIDNot applicable.
\nNot applicable.
\nNot applicable.
\n{\n \"data\": {\n \"prizeCompetitionID\": 6601,\n \"userID\": 42,\n \"status\": \"claim-recorded\"\n }\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Invalid Postcode\"\n }\n}\nPurpose: Updates user profile fields. Currently a placeholder that sends a static parameter set to AccountHelper->updateUserDetails.
\nMethod: POST
URL: /v1/driver/profile
Status Codes: 200 OK, 401 Unauthorized, 500 Internal Server Error
Not specified. Current implementation ignores request body and uses a static parameter array.
\nNot specified.
\nNot applicable.
\nNot applicable.
\nNot applicable.
\n{\n \"data\": {\n \"message\": \"Profile updated\"\n }\n}\n{\n \"error\": {\n \"status\": 500,\n \"message\": \"<internal error details>\"\n }\n}\nThis section documents the Vehicle Check APIs. These endpoints support driver vehicle checks, retrieving vehicle check status, questions, and saving check answers (with optional attachments).
\n/vehiclecheckPurpose: Saves driver’s fleet check answers, including optional attachments.
\nAccepts answers either as JSON (in data param) or as form-data.
Supports file uploads via multipart/form-data under attachments.
Uses VehicleCheckHelper::saveDriverVehicleCheck() to persist answers.
After saving, attachments are linked to the created answerID.
Method: POST
URL: /vehiclecheck
Status Codes: 200 OK, 400 Bad Request, 500 Internal Server Error
Success (200)
\n{\n \"data\": {\n \"answerID\": 2136527,\n \"vehicleCheckID\": 1,\n \"vehicleID\": 123,\n \"driverID\": 39719,\n \"checkDate\": \"2020-02-27 14:02:49\",\n \"isAdvisory\": 1,\n \"advisoryText\": \"cracked lense\",\n \"isFault\": 0,\n \"faultText\": \"\",\n \"note\": null,\n \"missedCheck\": null,\n \"lastUpdate\": null,\n \"isDismissed\": 0,\n \"updatedBy\": null,\n \"odoReading\": \"12312.7\",\n \"answerDuration\": 33\n }\n}\n\nError (400 — Missing Data)
\n{\n \"status\": \"error\",\n \"data\": [\"Data Missing, {\"vehicleID\": \"Required\"}\"],\n \"message\": \"Validation failed\"\n}\n\nError (500 — Internal Error)
\n{\n \"status\": \"error\",\n \"data\": {\n \"message\": \"Database connection failed\",\n \"code\": 5001\n },\n \"message\": \"Error saving vehicle check\"\n}\n\nPurpose: Create a note for a specific journey.
\nNone.
\nMethod: POST
URL: /v1/driver/journeyNote
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\nNot applicable.
\n{ \"message\": \"Journey note added successfully.\" }\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Validation failed: note is required\"\n }\n}\nPurpose: Create or update notes for an array of journeys.
\njourneys, creates a note if none exists; otherwise updates the existing note.Method: POST
URL: /v1/driver/journeyNotes
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\nNot applicable.
\n{ \"message\": \"Journey notes added successfully.\" }\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Validation failed: journeys is required\"\n }\n}\nPurpose: Download vehicle charge expenses in PDF or CSV format.
\nuserID from request context.chargeIds (array), reportType ('pdf'|'csv'), optional chargeLocationTypeOverride.Method: POST\nURL: /downloadVehicleChargeExpenses\nStatus Codes: 200 OK, 400 Bad Request, 500 Internal Server Error
\nReturns download URL of generated report.
\nSuccess:
\n{\n \"reportUrl\": \"https://example.com/expense_report_2025-09-08.pdf\"\n}\nError:
\n{\n \"status\": 400,\n \"data\": [\"reportType must be 'pdf' or 'csv'\"]\n}\nPurpose: Generate an expense report (PDF or CSV) for selected journeys and return a reference/download payload.
\nUses the CreateExpenseReport use case. reportType must be pdf or csv.
userID may be passed explicitly; otherwise the authenticated userID attribute is used.
Method: POST
URL: /v1/driver/downloadExpenses
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\nCreateExpenseReport use case. This may include a temporary URL, file token, or embedded data (implementation-dependent).{ \"status\": \"success\", \"reportType\": \"pdf\", \"downloadUrl\": \"https://example.com/reports/abc123.pdf\" }\n\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Validation failed: reportType must be pdf or csv\"\n }\n}\n\nDate fields use format YYYY-MM-DD. For /journeys, times are derived from dates; endDate is set to end-of-day if time omitted.
Integer booleans: zeroTrips and unitType are integers but are treated as booleans (0 => false, non-zero => true).
Permissions: Updating journey type requires edit labels permission; lacking this yields 403.
\nError handling: All endpoints route exceptions through a common Responder service, which returns JSON error bodies with appropriate HTTP codes.
\nPurpose: Generate an expense report for selected journeys and email it to specified recipients.
\nCreateExpenseReport use case. odoReading is optional and ignored when 0.Method: POST
URL: /v1/driver/sendExpense
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\nCreateExpenseReport use case, indicating success and/or identifiers for sent artifacts.{ \"status\": \"success\", \"message\": \"Expense report emailed\", \"emailRecipients\": [\"manager@example.com\"] }\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Validation failed: emails is required\"\n }\n}\nPurpose: Send vehicle charge expenses via email.
\nuserID from request context.Method: POST\nURL: /sendVehicleChargeExpense\nStatus Codes: 204 OK, 400 Bad Request, 500 Internal Server Error
\nReturns confirmation of email being sent.
\nSuccess:
\n{\n \"status\": \"success\",\n \"message\": \"Expense email sent.\"\n}\nError:
\n{\n \"status\": 400,\n \"data\": [\"chargeIds must be an array\"]\n}\nPurpose: Update the location type for a specific vehicle charge record.
\nuserID from request context. Method: POST
URL: /vehicleChargeLocationType
Status Codes: 204 No Content, 400 Bad Request, 500 Internal Server Error
Success (204 No Content): No body returned
\nError (JSON):
\n{\n \"status\": 400,\n \"data\": [\"vehicleChargeID must be an integer\"]\n}\nPurpose: Submit a vehicle odometer reading for one or more drivers.
\ndriverIDs attribute from request context. Y-m-d H:i). vehicleID as integer, odoReading as float, calibrationTime as date. 204 No Content on success if everything executes correctly.Method: POST
URL: /vehicleOdo
Status Codes: 204 No Content, 400 Bad Request, 500 Internal Server Error
Success (204 No Content): No body returned
\nError (JSON):
\n{\n \"status\": 400,\n \"data\": [\"vehicleID must be an integer\", \"odoReading must be a float\"]\n}\nstatus: HTTP status code data: Array of error messagesPurpose: Update league settings and metadata.
\nleagueID.LeagueHelper->updateLeague(...).Method: PUT
URL: /v1/driver/league
Status Codes: 200 OK, 400 Bad Request
Not applicable.
\nNot applicable.
\nNot applicable.
\n{\n \"data\": {\n \"Result\": \"Sucessfully Updated.\"\n }\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"These rules must pass for { \\\"leagueID\\\": \\\"league\\\", \\\"groupName\\\": \\\"Raiding, ploughing, looting League\\\" }\"\n }\n}\nPurpose: Set the user's primary league.
\nleagueID. Calls AccountHelper->updateUserDetails(userID, params).Method: PUT
URL: /v1/driver/primaryLeague
Status Codes: 200 OK, 400 Bad Request
Not applicable.
\nNot applicable.
\nNot applicable.
\n{ \"leagueID\": 101, \"isPrimary\": true }\n[\"<error details>\"]\nPurpose: Mark a lottery result as viewed by the user.
\nlotteryID.Method: PUT
URL: /v1/driver/prizeViewed
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\n{\n \"data\": {\n \"prizeCompetitionEntrantID\": 98765,\n \"viewedResult\": \"2025-09-09 12:34:56\",\n \"status\": \"viewed\"\n }\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"User did not enter this lottery\"\n }\n}\nPurpose: Update the note for a specific journey.
\nNone.
\nMethod: PUT
URL: /v1/driver/journeyNote
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\nNot applicable.
\n{ \"message\": \"Journey note updated successfully.\" }\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Validation failed: journeyID is required\"\n }\n}\nPurpose: Delete a league (admin-only).
\nleagueID. Calls LeagueHelper->deleteLeague(leagueID, userID).You are not an admin.Method: DELETE
URL: /v1/driver/league
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized
Not applicable.
\nNot applicable.
\nNot applicable.
\n{ \"leagueID\": 101, \"status\": \"deleted\" }\n{ \"error\": \"You are not an admin.\" }\n[\"<error details>\"]\nPurpose: Soft-delete the note for a specific journey (marks note as deleted).
\nisDelete flag to true; the note content may be retained for audit.Method: DELETE
URL: /v1/driver/journeyNote
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\nNot applicable.
\n{ \"message\": \"Journey note deleted successfully.\" }\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Validation failed: journeyID is required\"\n }\n}\nPurpose: Validate VRN and device serial, optionally an installation code, and either return a confirmation payload or complete installation and send confirmation emails.
\nvrn (required, alphanumeric after sanitization),serialNumber (required, integer),installationCode (optional string),confirmation (optional boolean).confirmation, returns details for confirmation (vehicle data, and installation if coupon code found), with sensitive vehicle fields removed.confirmation=true, will:Method: POST
URL: /v1/driver/deviceRegister
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\n{\n \"data\": {\n \"vehicle\": {\n \"VRM\": \"AB12CDE\",\n \"make\": \"Ford\",\n \"model\": \"Focus\"\n },\n \"message\": \"Confirmation required\",\n \"installation\": {\n \"installationCode\": \"WELCOME123\",\n \"message\": \"Free install\"\n }\n }\n}\n{\n \"data\": {\n \"Success\": true,\n \"message\": \"Successfully added device.\"\n }\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Vehicle Registration in use, please contact support@lightfoot.co.uk\"\n }\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Serial in use, or not valid.\"\n }\n}\nPurpose: Case-insensitive search for fleet names (and associated form fields) given a partial or full fleetName.
fleetName length >= 3 characters.Method: POST
URL: /v1/driver/fleetName
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\n{\n \"data\": [\n { \"fleetName\": \"Example Fleet\", \"requiresEmployeeId\": true },\n { \"fleetName\": \"Example Fleet B\", \"requiresEmployeeId\": false }\n ]\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": \"Fleet Name should be more than 3 characters\"\n }\n}\nPurpose: Register and/or activate a driver to a fleet in a single onboarding flow. Returns status and context; when fully activated, sends a welcome email.
\nfirstName, lastName, email, fleetName.fleetLevelName, employeeID, driverCodePin, VRM. If STORE_NUMBER is provided alongside employeeID, the combined format is <employeeID>_<storeNumber>.CreateDriverActivation; presenter maps success and duplicate outcomes, and throws for errors.activated, sets needsInstallationOrFleet to 0 and triggers welcome email.Method: POST
URL: /v1/driver/onboarding
Status Codes: 200 OK, 400 Bad Request, 401 Unauthorized, 500 Internal Server Error
Not applicable.
\nNot applicable.
\nNot applicable.
\n{ data: <object> } where the object includes a status (e.g., activated, duplicate), a message, optional code, and contextual data.{\n \"data\": {\n \"status\": \"activated\",\n \"needsInstallationOrFleet\": 0,\n \"fleetName\": \"Acme Fleet\",\n \"message\": \"Activation complete\"\n }\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": {\n \"error\": \"First Name is required, Last Name is required, Valid Email Address is required, Fleet Name is required\"\n }\n }\n}\n{\n \"error\": {\n \"status\": 400,\n \"message\": {\n \"message\": \"<context error>\",\n \"code\": 400\n }\n }\n}\nUpdate a users Locale using a 2 alpha country code e.g. en, fr, etc...
\nThe code used must to a code that is currently supported and will not error if its not.
\nThis api uses the current logged in users ID to update the locale.
\n","urlObject":{"path":["v1","driver","locale"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"df1757d9-4544-4f24-bd4a-658b5b94b95d","name":"/driver/locale","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"locale\": \"en\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/driver/locale"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 29 Aug 2025 13:42:54 GMT"},{"key":"Server","value":"Apache/2.4.38 (Debian)"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Language","value":"en"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"X-Requested-With, Content-Type, Accept, Origin, Authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, PATCH, OPTIONS"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"userId\": 1,\n \"localeId\": 1,\n \"localeCode\": \"en\",\n \"localeDisplayName\": \"English\"\n }\n}"}],"_postman_id":"177a3c17-1de1-4854-8e0b-f074e5323c40"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"