API docs by Redocly

Speedfox API (1.0.0)

Download OpenAPI specification:Download

Auth

Log In

Authorizations:
noauthAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "username": "speedfox_admin",
  • "password": "p@55w0rd"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "AUTH_SUCCESS",
  • "message": "Authentication Successful",
  • "body": {
    }
}

Refresh Token

Authorizations:
noauthAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2dlb2ludC5hZnJpY2EiLCJhdWQiOiJzcGVlZGZveC1hcGkiLCJyb2xlIjoiUk9MRV9TVVBFUlVTRVIiLCJleHAiOjE3MDUzNTI3MjAsInNpZCI6ImU2NzZmNTI2LTg5NzEtNDVhMy05NGI2LTRiMmQ1NjBiOGY5NyIsInN1YiI6InNwZWVkZm94X2FkbWluIiwiaWF0IjoxNzA1MzQ5MTIwfQ.VcxFzX_ytMQKhs27GJGEvxjdItEURCPK2f0b7HL-yUs"
}

Introspect

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "token": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2dlb2ludC5hZnJpY2EiLCJhdWQiOiJzcGVlZGZveC1hcGkiLCJyb2xlIjoiUk9MRV9TVVBFUlVTRVIiLCJleHAiOjE3MDUzNTI3MjAsInNpZCI6ImU2NzZmNTI2LTg5NzEtNDVhMy05NGI2LTRiMmQ1NjBiOGY5NyIsInN1YiI6InNwZWVkZm94X2FkbWluIiwiaWF0IjoxNzA1MzQ5MTIwfQ.VcxFzX_ytMQKhs27GJGEvxjdItEURCPK2f0b7HL-yUs"
}

Log out

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "token": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2dlb2ludC5hZnJpY2EiLCJhdWQiOiJzcGVlZGZveC1hcGkiLCJyb2xlIjoiUk9MRV9TVVBFUlVTRVIiLCJleHAiOjE3MDUyNjM2NjQsInN1YiI6InNwZWVkZm94X2FkbWluIiwiaWF0IjoxNzA1MjYwMDY0fQ.5i74h7Fd_Q63F3B9lpf3ABgGNXAJTBFG1kt7u8NcpHs"
}

Forgot Password Request

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "username": "speedfox_admin"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "200",
  • "message": "Request Forgot Password",
  • "body": {
    }
}

Reset Password

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "username": "speedfox_admin",
  • "otp": "732626",
  • "password": "p@55w0rd",
  • "confirmPassword": "p@55w0rd"
}

Response samples

Content type
application/json
Example
{
  • "status": 400,
  • "responseCode": "400",
  • "message": "Reset Password Failed",
  • "body": {
    }
}

Organizations

Save

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "contact": "speedfox test org",
  • "title": "speedfox test org"
}

Get All Organizations

Authorizations:
bearerAuth

Responses

Delete by id

Authorizations:
bearerAuth

Responses

Update Organization

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": 17,
  • "contact": "speedfox eleven",
  • "title": "speedfox eleventh"
}

Users

Add User

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "userName": "speedfoxTest",
  • "firstName": "John",
  • "lastName": "Doe",
  • "email": "johndoe@gmail.com",
  • "organizationId": 38,
  • "isSuperUser": true,
  • "isStaff": false
}

Get Users

Authorizations:
bearerAuth

Responses

Get User By Id

Authorizations:
bearerAuth

Responses

Update User

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": 10,
  • "username": "jarvish",
  • "firstName": "Simz",
  • "lastName": "Jarvis",
  • "email": "jarvis@gmailmj.com",
  • "isSuperUser": true,
  • "isStaff": false,
  • "isActive": true,
  • "dateJoined": "2024-01-15T22:33:32.679+00:00"
}

Delete User

Authorizations:
bearerAuth

Responses

Organisation User

Save

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "organizationId": "38",
  • "userId": "35",
  • "role": "",
  • "apiKey": "1rhjhvj2345678ywcmb789"
}

Get All

Authorizations:
bearerAuth

Responses

Get All By Organization ID

Authorizations:
bearerAuth

Responses

Get All By User ID

Authorizations:
bearerAuth

Responses

Get By Username

Authorizations:
bearerAuth

Responses

Update Organisation User

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": 12,
  • "organizationId": 13,
  • "userId": 8,
  • "role": "",
  • "apiKey": "1rhjhvj234567839"
}

Delete Organisation User

Authorizations:
bearerAuth

Responses

NetPlan Config

Get All By Organization Id

Authorizations:
bearerAuth

Responses

Add Net Plan Config

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "name": "SpeedFox ConfigurationTest",
  • "organizationId": 38
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "ADD_NET_PLAN_CONFIG",
  • "message": "Net Plan Config Added",
  • "body": {
    }
}

Get NetPlanConfig by ID

Authorizations:
bearerAuth

Responses

Get All Net Plan Configs

Authorizations:
bearerAuth

Responses

Update Netplan Config

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": 4,
  • "name": "Configss",
  • "organizationId": "13"
}

Delete NetPlan Config

Authorizations:
bearerAuth

Responses

Speedfox Configs

Get All Speedfox Configs

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_ALL_POLICIES",
  • "message": "Get All Policies",
  • "body": [
    ]
}

Get All Speedfox Configs By Organization ID

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_POLICIES",
  • "message": "Get Policies",
  • "body": [
    ]
}

Add Speedfox Customer Config

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "name": "SpeedFox testOrg",
  • "organizationId": 38,
  • "units": "mph",
  • "stage": "testing",
  • "generalSpeedRange": 80,
  • "maxSpeedLimit": 120,
  • "generalSpeedRangeGravel": 60,
  • "isGeneralSpeedRangeGravelHard": true,
  • "generalSpeedRangeTowing": 80,
  • "isGeneralSpeedRangeTowingHard": false,
  • "speedRangeVulnerablePoi": 60,
  • "isGeneralSpeedRangeVulnerablePoiHard": true,
  • "generalSpeedRangeVulnerablePoiDistance": 100,
  • "isLoggingGps": true,
  • "isLoggingLimit": true,
  • "onRampMergeSpeed": 20,
  • "isOnRampMergeLimit": true,
  • "topLimitExceedenceTarget": 100,
  • "topLimitExceedenceValue": "200",
  • "netPlanConfigId": 1,
  • "validFrom": "2024-05-01",
  • "validTo": "2024-06-09"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "ADD_POLICIES",
  • "message": "Policies Added",
  • "body": {
    }
}

Add Speedfox Config

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "name": "test 21",
  • "organizationId": 13,
  • "units": "mph",
  • "stage": "testing",
  • "generalSpeedRange": 80,
  • "maxSpeedLimit": 120,
  • "generalSpeedRangeGravel": 60,
  • "isGeneralSpeedRangeGravelHard": true,
  • "generalSpeedRangeTowing": 80,
  • "isGeneralSpeedRangeTowingHard": false,
  • "speedRangeVulnerablePoi": 60,
  • "isGeneralSpeedRangeVulnerablePoiHard": true,
  • "generalSpeedRangeVulnerablePoiDistance": 100,
  • "isLoggingGps": true,
  • "isLoggingLimit": true,
  • "onRampMergeSpeed": 20,
  • "isOnRampMergeLimit": true,
  • "topLimitExceedenceTarget": 100,
  • "topLimitExceedenceValue": "200",
  • "netPlanConfigId": 1,
  • "validFrom": "2024-05-01",
  • "validTo": "2024-06-09",
  • "geoPackageId": 0
}

Get All Speedfox Configs by Id

Authorizations:
bearerAuth

Responses

New Request

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": 8,
  • "name": "test 7",
  • "organizationId": 13,
  • "units": "mph",
  • "stage": "testing",
  • "generalSpeedRange": 80,
  • "maxSpeedLimit": 120,
  • "generalSpeedRangeGravel": 60,
  • "isGeneralSpeedRangeGravelHard": true,
  • "generalSpeedRangeTowing": 80,
  • "isGeneralSpeedRangeTowingHard": false,
  • "speedRangeVulnerablePoi": 60,
  • "isGeneralSpeedRangeVulnerablePoiHard": true,
  • "generalSpeedRangeVulnerablePoiDistance": 100,
  • "isLoggingGps": true,
  • "isLoggingLimit": true,
  • "onRampMergeSpeed": 20,
  • "isOnRampMergeLimit": true,
  • "topLimitExceedenceTarget": 100,
  • "topLimitExceedenceValue": "200",
  • "netPlanConfigId": 1,
  • "validFrom": "2024-05-01",
  • "validTo": "2024-06-09"
}

Delete SpeedFox Config

Authorizations:
bearerAuth

Responses

Speedfox Configurations

Get All Configurations

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_ALL_CONFIGURATIONS",
  • "message": "Get All Configurations",
  • "body": [
    ]
}

Add SpeedFox Configuration

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "name": "speedfox org test",
  • "speedFoxConfigId": 34,
  • "netPlanConfigId": 16
}

Update Speedfox Configuration

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": 8,
  • "name": "speedfox wifis",
  • "speedFoxConfigId": 9,
  • "netPlanConfigId": 1
}

Get Speedfox Configuration by Id

Authorizations:
bearerAuth

Responses

Delete SpeedFox Configuration

Authorizations:
bearerAuth

Responses

Vehicle Make

Add Vehicle Make

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "name": "Tesla",
  • "country": "usa"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "ADD_VEHICLE_MAKE",
  • "message": "Vehicle Make Added",
  • "body": {
    }
}

Get All Vehicle Makes

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_ALL_VEHICLE_MAKE",
  • "message": "Get All Vehicle Makes",
  • "body": [
    ]
}

Get Vehicle Make By Id

Authorizations:
bearerAuth

Responses

Update Vehicle Make

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "name": "Toyota",
  • "country": "za"
}

Delete Vehicle Make

Authorizations:
bearerAuth

Responses

Vehicle Group

Get Vehicle Group By Organization

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_ALL_VEHICLE_GROUP",
  • "message": "Get All Vehicle Groups",
  • "body": [
    ]
}

Get Vehicle Group By Id

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_VEHICLE_GROUP",
  • "message": "Get Vehicle Group",
  • "body": {
    }
}

Add Vehicle Group

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "name": "Speedfox Org Vehicle Group",
  • "organizationId": 38,
  • "configurationId": 18,
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "ADD_VEHICLE_GROUP",
  • "message": "Vehicle Group Added",
  • "body": {
    }
}

Update Group Vehicle

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
"{\r\n \"id\":4,\r\n \"name\":\"Vehicle Group 4\",\r\n \"organizationId\":13,\r\n \"configurationId\":8,\r\n \"isActive\":true\r\n}\r\n}"

Delete Vehicle Group

Authorizations:
bearerAuth

Responses

Vehicles

Vehicles

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "vehicleGroupId": 12,
  • "licensePlate": "AS32323",
  • "vinNumber": "viwe22",
  • "makeId": 14,
  • "model": "total",
  • "vehicleType": "private_car",
  • "inUse": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "ADD_VEHICLE",
  • "message": "Vehicle Added",
  • "body": {
    }
}

Update Vehicles

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": 12,
  • "vehicleGroupId": 5,
  • "licensePlate": "AS323322",
  • "vinNumber": "viwe223253",
  • "makeId": 3,
  • "model": "totodel",
  • "vehicleType": "private_car",
  • "inUse": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "UPDATE_VEHICLE",
  • "message": "Vehicle Updated",
  • "body": {
    }
}

Get All Vehicles

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
Example
{
  • "status": 200,
  • "responseCode": "GET_ALL_VEHICLE",
  • "message": "Get All Vehicles",
  • "body": [
    ]
}

Get All Vehicles By Organization ID

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_ALL_VEHICLE",
  • "message": "Get All Vehicles",
  • "body": [
    ]
}

Get Vehicle By Id

Authorizations:
bearerAuth

Responses

Delete Vehicle

Authorizations:
bearerAuth

Responses

Devices

Post Devices

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "pieSerial": "01234567",
  • "gpsSerial": "0234rt526",
  • "macAddress": " ",
  • "rpiSerial": " 0345uy278",
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "ADD_DEVICE",
  • "message": "Device Added",
  • "body": {
    }
}

Get All Devices

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_ALL_DEVICE",
  • "message": "Get All Devices",
  • "body": [
    ]
}

Get Devices By ID

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_DEVICE",
  • "message": "Get Device",
  • "body": {
    }
}

Delete Devices

Authorizations:
bearerAuth

Responses

Update Devices

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": 13,
  • "pieSerial": "342224 ",
  • "gpsSerial": "234rtx52673",
  • "macAddress": " ",
  • "rplSerial": " 345uyo278op",
  • "isActive": true
}

Assigned Devices

Post Assigned Devices

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "deviceId": 24,
  • "organisationId": 38,
  • "configurationId": 18,
  • "vehicleId": 31,
  • "locked": false,
  • "installed": true,
  • "dateInstalled": "",
  • "dateStopped": "",
  • "active": true
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "ADD_ASSIGNED_DEVICE",
  • "message": "Assigned Device Added",
  • "body": {
    }
}

Get All Assigned Devices

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_ALL_ASSIGNED_DEVICE",
  • "message": "Get All Assigned Devices",
  • "body": [
    ]
}

Get All Assigned Devices by ID

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_ASSIGNED_DEVICE",
  • "message": "Get Assigned Device",
  • "body": {
    }
}

Get All Assigned Devices by Organization ID

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_ALL_ASSIGNED_DEVICE",
  • "message": "Get All Assigned Devices",
  • "body": [
    ]
}

Delete Assigned Devices

Authorizations:
bearerAuth

Responses

Update Assigned Devices

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": 7,
  • "deviceId": 13,
  • "organisationId": 13,
  • "configurationId": 8,
  • "vehicleId": 12,
  • "locked": false,
  • "installed": false,
  • "dateInstalled": "",
  • "dateStopped": "",
  • "active": false
}

Wifi Connections

Post Wifi Connections

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "netPlanConfigId": 16,
  • "role": "technician",
  • "ssid": " ",
  • "userName": "JohnDoe",
  • "password": " qwerty54321"
}

Response samples

Content type
application/json
Example
{
  • "status": 200,
  • "responseCode": "ADD_WIFI",
  • "message": "Wifi Added",
  • "body": {
    }
}

Get Wifi Connections

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_ALL_WIFI",
  • "message": "Get All Wifis",
  • "body": [
    ]
}

Get Wifi Connections By ID

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_WIFI",
  • "message": "Get Wifi",
  • "body": {
    }
}

Get Wifi Connections By Organization ID

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_ALL_WIFI",
  • "message": "Get All Wifis",
  • "body": [
    ]
}

Delete Wifi Connections

Authorizations:
bearerAuth

Responses

Update Wifi Connection

Authorizations:
bearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "id": 5,
  • "netPlanConfigId": 1,
  • "role": "technician",
  • "ssid": " ",
  • "userName": "Petross",
  • "password": " 990okio6"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "UPDATE_WIFI",
  • "message": "Wifi Updated",
  • "body": {
    }
}

Test

Test

Authorizations:
noauthAuth

Responses

Statistics

Get Organization Statistics

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "responseCode": "GET_STATISTICS",
  • "message": "Get Statistics",
  • "body": {
    }
}

Reporting

Policy Report

Authorizations:
bearerAuth

Responses

Last Seen Report

Authorizations:
bearerAuth

Responses

{{localBaseUrl}}/reporting/fleet-driving-performance/11

Authorizations:
bearerAuth
header Parameters
Authorization
string
Example: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2dlb2ludC5hZnJpY2EiLCJhdWQiOiJzcGVlZGZveC1hcGkiLCJyb2xlIjoiUk9MRV9TVVBFUlVTRVIiLCJleHAiOjE3MDgxNDY5MjYsInNpZCI6ImRlNjYxMzhlLTI2MGEtNDIxNi04MWU4LTQ3Nzk1M2U5NjNiMSIsInN1YiI6InNwZWVkZm94X2FkbWluIiwiaWF0IjoxNzA4MTQzMzI2fQ.vaOVngIyxmHsnrOSJxwWyO5v1xXrWkdUDMR4BJcTJ1s

Responses

Geopackage

Get All GeoPackage

Authorizations:
bearerAuth

Responses