{ "openapi": "3.0.3", "info": { "title": "Destiny HTTP API", "version": "1.0.0", "description": "This collection includes all the standard HTTP API requests available for the Destiny API.\n\nPlease see our Destiny API Quick Start Guide if you haven't yet." }, "servers": [ { "url": "https://www.acmdestiny.net/api/v1", "description": "ACM Destiny production API" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Destiny bearer token from the authentication endpoint." } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Authentication" }, { "name": "Unit Groups" }, { "name": "Units" }, { "name": "Clients" }, { "name": "Vehicles" }, { "name": "Vehicle Groups" }, { "name": "Vehicle Expenses" }, { "name": "Vehicle Expense Types" }, { "name": "Monitoring" }, { "name": "Drivers" } ], "paths": { "/auth/token": { "get": { "tags": [ "Authentication" ], "summary": "Get Authentication Token", "operationId": "get-authentication-token", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "token": { "type": "string" } } } } }, "example": { "data": { "token": "bearer token_key" } } } } } } } }, "/auth/registration/some_token": { "get": { "tags": [ "Authentication" ], "summary": "Request Submitted Registration", "operationId": "request-submitted-registration", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } }, "description": "Requests the data for a previously submitted user registration." } }, "/auth/login": { "post": { "tags": [ "Authentication" ], "summary": "User Login", "operationId": "user-login", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "account_type": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "access_level": { "type": "object", "properties": { "level": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "product_code": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "username": { "type": "string" }, "email": { "type": "string" }, "title": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "full_name": { "type": "string" }, "position": { "type": "string" }, "employee_no": { "type": "integer", "format": "int64" }, "cellphone": { "type": "integer", "format": "int64" }, "national_id": { "type": "integer", "format": "int64" }, "timezone": { "type": "object", "properties": { "Africa/Johannesburg": { "type": "string" } } }, "country": { "type": "object", "properties": { "ZA": { "type": "string" } } }, "language": { "type": "object", "properties": { "EN": { "type": "string" } } }, "logged_in": { "type": "boolean" }, "ip": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "accessed_at": { "type": "string", "format": "date-time" }, "accessed_route": { "type": "string" }, "pubsub": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "uuid": { "type": "string" }, "publish_key": { "type": "string" }, "subscribe_key": { "type": "string" }, "sub_channels": { "type": "array", "items": { "type": "string" } } } }, "filestack": { "type": "object", "properties": { "url": { "type": "string" }, "api_key": { "type": "string" } } }, "google": { "type": "object", "properties": { "maps": { "type": "object", "properties": { "api_url": { "type": "string" }, "geocoding_url": { "type": "string" }, "api_key": { "type": "string" }, "client_id": { "type": "string" } } } } }, "sse": { "type": "object", "properties": { "url": { "type": "string" }, "telemetry_url": { "type": "string" }, "notify_url": { "type": "string" } } }, "user_photo_urls": { "type": "object", "properties": { "photo": { "type": "string" }, "profile_large": { "type": "string" }, "profile_medium": { "type": "string" }, "profile_small": { "type": "string" } } }, "partner": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } } }, "agency": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } } }, "clients": { "type": "array", "items": {} }, "settings": { "type": "object", "properties": { "test": { "type": "string" }, "theme": { "type": "string" }, "default": { "type": "boolean" }, "someArray": { "type": "array", "items": { "type": "string" } }, "someObject": { "type": "object", "properties": { "data": { "type": "string" } } }, "appearance_theme": { "type": "string" }, "fleet_track_open": { "type": "boolean" }, "general_currency": { "type": "string" }, "general_language": { "type": "string" }, "general_timezone": { "type": "string" }, "dashboard_widgets": { "type": "array", "items": {} }, "vehicles_mapStyle": { "type": "string" }, "appearance_density": { "type": "string" }, "general_dateFormat": { "type": "string" }, "general_timeFormat": { "type": "string" }, "google_map_type_id": { "type": "string" }, "vehicles_speedUnit": { "type": "string" }, "appearance_fontSize": { "type": "string" }, "notifications_types": { "type": "object", "properties": { "message": { "type": "boolean" }, "success": { "type": "boolean" }, "warning": { "type": "boolean" }, "critical": { "type": "boolean" } } }, "vehicles_showLabels": { "type": "boolean" }, "general_numberFormat": { "type": "string" }, "reports_autoGenerate": { "type": "boolean" }, "vehicles_defaultZoom": { "type": "integer", "format": "int64" }, "vehicles_mapProvider": { "type": "string" }, "vehicles_showTraffic": { "type": "boolean" }, "dashboard_autoRefresh": { "type": "boolean" }, "dashboard_defaultView": { "type": "string" }, "fleet_track_client_id": { "type": "integer", "format": "int64" }, "notifications_enabled": { "type": "boolean" }, "reports_defaultFormat": { "type": "string" }, "reports_includeCharts": { "type": "boolean" }, "vehicles_distanceUnit": { "type": "string" }, "vehicles_mapStyleDark": { "type": "string" }, "dashboard_itemsPerPage": { "type": "integer", "format": "int64" }, "general_firstDayOfWeek": { "type": "integer", "format": "int64" }, "privacy_sessionTimeout": { "type": "integer", "format": "int64" }, "privacy_shareAnalytics": { "type": "boolean" }, "privacy_shareUsageData": { "type": "boolean" }, "reports_includeDetails": { "type": "boolean" }, "vehicles_mapStyleLight": { "type": "string" }, "fleet_track_client_name": { "type": "string" }, "privacy_rememberFilters": { "type": "boolean" }, "vehicles_defaultMapType": { "type": "string" }, "vehicles_showDriverInfo": { "type": "boolean" }, "vehicles_showSpeedLimit": { "type": "boolean" }, "reports_defaultDateRange": { "type": "string" }, "vehicles_mapProviderDark": { "type": "string" }, "dashboard_refreshInterval": { "type": "integer", "format": "int64" }, "dashboard_showActiveTrips": { "type": "boolean" }, "vehicles_autoSelectClient": { "type": "boolean" }, "vehicles_mapProviderLight": { "type": "string" }, "notifications_autoMarkRead": { "type": "boolean" }, "notifications_criticalOnly": { "type": "boolean" }, "notifications_soundEnabled": { "type": "boolean" }, "privacy_rememberLastClient": { "type": "boolean" }, "appearance_sidebarCollapsed": { "type": "boolean" }, "appearance_animationsEnabled": { "type": "boolean" }, "dashboard_showParkedVehicles": { "type": "boolean" }, "notifications_refreshInterval": { "type": "integer", "format": "int64" }, "notifications_emailNotifications": { "type": "boolean" }, "notifications_desktopNotifications": { "type": "boolean" } } }, "permissions": { "type": "object", "properties": { "users": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "partners": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "agencies": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "clients": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "asset_transfer": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "user_profile": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "unit_groups": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "unit_commands": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "manage_permissions": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "send_commands": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "view_command_logs": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "units": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "units_basic_edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "units_technical": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "unit_swapping": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "assign_sim_cards": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "units_transfer": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "unit_cfg_templates": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "maps": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "map_safe_zones": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "map_location_finding": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "map_directions": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "map_markers": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "map_routing": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "vehicles": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "vehicles_admin_edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "vehicles_technical_edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "vehicles_basic_edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "assign_units": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "vehicle_groups": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "vehicle_expenses": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "drivers": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "sim_cards": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "gdspo": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "api_bridges_webfleet": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "api_bridges_rabbitmq": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "global_zones": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "client_zones": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "reports_history": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "debrief_detailed": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "debrief_summary": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "vehicle_analysis": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "vehicle_speeding": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "position_log": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "reports_status": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "status_units_detailed": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "status_units_summary": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "reports_management": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "vehicle_expenses": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "vehicle_maintenance": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "reports_events": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "events_detailed": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "events_summary": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "event_pool_report": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "event_profiles_monitored": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "event_profiles_client": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "event_pools": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } }, "client_poi": { "type": "object", "properties": { "title": { "type": "string" }, "actions": { "type": "object", "properties": { "view": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "create": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "edit": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } }, "delete": { "type": "object", "properties": { "title": { "type": "string" }, "allow": { "type": "boolean" } } } } } } } } }, "photos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "type": { "type": "string" }, "url": { "type": "string" }, "filename": { "type": "string" }, "size_bytes": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" } } } }, "websentinel_url": { "type": "string" }, "acms_url": { "type": "string", "nullable": true }, "fota": { "type": "object", "properties": { "url": { "type": "string" }, "api_key": { "type": "string" } } } } } } }, "example": { "data": { "id": 9, "account_type": { "id": 2, "name": "ACMGroup: Top Management", "description": "ACMGroup (Pty) Ltd top management.", "access_level": { "level": 2, "name": "ACMGroup [Management]" }, "product_code": null, "created_at": "2020-02-12T15:54:25+02:00", "updated_at": "2025-11-11T16:54:56+02:00" }, "username": "jason", "email": "jason@schoeman.me", "title": "Mr", "first_name": "Jason", "last_name": "Schoeman", "full_name": "Jason Schoeman", "position": "Indpenendent Consultant", "employee_no": "00001", "cellphone": "0760810777", "national_id": "7905105108081", "timezone": { "Africa/Johannesburg": "Africa/Johannesburg" }, "country": { "ZA": "South Africa" }, "language": { "EN": "English" }, "logged_in": true, "ip": "54.86.50.139", "created_at": "2020-02-12T16:42:27+00:00", "updated_at": "2025-12-16T13:19:47+00:00", "accessed_at": "2026-05-08T09:19:41+00:00", "accessed_route": "api/v1/clients/292", "pubsub": { "enabled": true, "uuid": "72e81470-14fa-4769-b91f-e0c8737292b7", "publish_key": "pub-c-967e4919-7f68-4894-9ae0-cd40ad997c01", "subscribe_key": "sub-c-b7e98078-37fd-11e8-a218-f214888d2de6", "sub_channels": [ "72e81470-14fa-4769-b91f-e0c8737292b7", "afd9895f-ec83-434f-9501-4df26cf7d994" ] }, "filestack": { "url": "https://www.filestackapi.com/api/store/S3", "api_key": "AMd29LFq4SrCjtN1n5Na4z" }, "google": { "maps": { "api_url": "https://maps.googleapis.com/maps/api/js", "geocoding_url": "https://maps.googleapis.com/maps/api/geocode/json", "api_key": "AIzaSyDw-OnQah0ou75lBbyTJqwJeGHGblukasM", "client_id": "" } }, "sse": { "url": "https://www.acmdestiny.net/sse/", "telemetry_url": "https://www.acmdestiny.net/sse/telemetry/", "notify_url": "https://www.acmdestiny.net/sse/notify/" }, "user_photo_urls": { "photo": "https://cdn.filestackcontent.com/GAGFqKhNSYaa49NFiF3P", "profile_large": "https://cdn.filestackcontent.com/resize=width:400,height:400,fit:crop/GAGFqKhNSYaa49NFiF3P", "profile_medium": "https://cdn.filestackcontent.com/resize=width:250,height:250,fit:crop/GAGFqKhNSYaa49NFiF3P", "profile_small": "https://cdn.filestackcontent.com/resize=width:150,height:150,fit:crop/GAGFqKhNSYaa49NFiF3P" }, "partner": { "id": null, "name": null }, "agency": { "id": null, "name": null }, "clients": [], "settings": { "test": "Testing", "theme": "fooTheme", "default": false, "someArray": [ "foo", "bar" ], "someObject": { "data": "someData" }, "appearance_theme": "system", "fleet_track_open": false, "general_currency": "USD", "general_language": "en", "general_timezone": "UTC", "dashboard_widgets": [], "vehicles_mapStyle": "streets", "appearance_density": "comfortable", "general_dateFormat": "MM/DD/YYYY", "general_timeFormat": "24h", "google_map_type_id": "roadmap", "vehicles_speedUnit": "kmh", "appearance_fontSize": "medium", "notifications_types": { "message": true, "success": true, "warning": true, "critical": true }, "vehicles_showLabels": true, "general_numberFormat": "en-US", "reports_autoGenerate": false, "vehicles_defaultZoom": 19, "vehicles_mapProvider": "mapbox", "vehicles_showTraffic": false, "dashboard_autoRefresh": true, "dashboard_defaultView": "grid", "fleet_track_client_id": 849, "notifications_enabled": true, "reports_defaultFormat": "pdf", "reports_includeCharts": true, "vehicles_distanceUnit": "km", "vehicles_mapStyleDark": "dark", "dashboard_itemsPerPage": 25, "general_firstDayOfWeek": 0, "privacy_sessionTimeout": 0, "privacy_shareAnalytics": false, "privacy_shareUsageData": false, "reports_includeDetails": true, "vehicles_mapStyleLight": "streets", "fleet_track_client_name": "First Help - Help Secure - Area A", "privacy_rememberFilters": true, "vehicles_defaultMapType": "roadmap", "vehicles_showDriverInfo": true, "vehicles_showSpeedLimit": false, "reports_defaultDateRange": "week", "vehicles_mapProviderDark": "mapbox", "dashboard_refreshInterval": 60, "dashboard_showActiveTrips": true, "vehicles_autoSelectClient": true, "vehicles_mapProviderLight": "mapbox", "notifications_autoMarkRead": false, "notifications_criticalOnly": false, "notifications_soundEnabled": true, "privacy_rememberLastClient": true, "appearance_sidebarCollapsed": false, "appearance_animationsEnabled": true, "dashboard_showParkedVehicles": true, "notifications_refreshInterval": 60, "notifications_emailNotifications": false, "notifications_desktopNotifications": true }, "permissions": { "users": { "title": "Users", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "partners": { "title": "Partners", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "agencies": { "title": "Agencies", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "clients": { "title": "Clients", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true }, "asset_transfer": { "title": "Asset Transfers", "allow": true } } }, "user_profile": { "title": "User Profile", "actions": { "view": { "title": "View", "allow": true }, "edit": { "title": "Edit", "allow": true } } }, "unit_groups": { "title": "Unit Groups", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "unit_commands": { "title": "Unit Commands", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true }, "manage_permissions": { "title": "Manage Permissions", "allow": true }, "send_commands": { "title": "Send Commands", "allow": true }, "view_command_logs": { "title": "View Command Logs", "allow": false } } }, "units": { "title": "Units", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true }, "units_basic_edit": { "title": "Basic Unit Editing", "allow": false }, "units_technical": { "title": "Technical Access", "allow": true }, "unit_swapping": { "title": "Unit Swapping", "allow": true }, "assign_sim_cards": { "title": "Assign SIM Cards", "allow": true }, "units_transfer": { "title": "Unit Transfers", "allow": false } } }, "unit_cfg_templates": { "title": "Unit Config Templates", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "maps": { "title": "Map Features", "actions": { "map_safe_zones": { "title": "Safe Zones", "allow": false }, "map_location_finding": { "title": "Location Finding", "allow": false }, "map_directions": { "title": "Directions", "allow": false }, "map_markers": { "title": "Markers", "allow": false }, "map_routing": { "title": "Routing", "allow": false } } }, "vehicles": { "title": "Vehicles", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "vehicles_admin_edit": { "title": "Vehicle Admin Editing", "allow": true }, "vehicles_technical_edit": { "title": "Vehicle Technical Editing", "allow": false }, "vehicles_basic_edit": { "title": "Vehicle Basic Editing", "allow": false }, "delete": { "title": "Delete", "allow": true }, "assign_units": { "title": "Assign Units", "allow": true } } }, "vehicle_groups": { "title": "Vehicle Groups", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "vehicle_expenses": { "title": "Vehicle Expenses", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "drivers": { "title": "Drivers", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "sim_cards": { "title": "SIM Cards", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "gdspo": { "title": "GDSPO Sim Cards", "actions": { "view": { "title": "View", "allow": true }, "edit": { "title": "Edit", "allow": true } } }, "api_bridges_webfleet": { "title": "Webfleet API Bridges", "actions": { "view": { "title": "View", "allow": false }, "create": { "title": "Create", "allow": false }, "edit": { "title": "Edit", "allow": false }, "delete": { "title": "Delete", "allow": false } } }, "api_bridges_rabbitmq": { "title": "RabbitMQ API Bridges", "actions": { "view": { "title": "View", "allow": false }, "create": { "title": "Create", "allow": false }, "edit": { "title": "Edit", "allow": false }, "delete": { "title": "Delete", "allow": false } } }, "global_zones": { "title": "Global Zones", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "client_zones": { "title": "Client Zones", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "reports_history": { "title": "History & Debrief Reports", "actions": { "debrief_detailed": { "title": "Debrief Detailed", "allow": true }, "debrief_summary": { "title": "Debrief Summary", "allow": true }, "vehicle_analysis": { "title": "Vehicle Analysis", "allow": true }, "vehicle_speeding": { "title": "Vehicle Speeding", "allow": true }, "position_log": { "title": "Position Log", "allow": true } } }, "reports_status": { "title": "Status Reports", "actions": { "status_units_detailed": { "title": "Unit Status Detailed", "allow": true }, "status_units_summary": { "title": "Unit Status Summary", "allow": true } } }, "reports_management": { "title": "Management Reports", "actions": { "vehicle_expenses": { "title": "Vehicle Expenditures", "allow": true }, "vehicle_maintenance": { "title": "Vehicle Maintenance", "allow": false } } }, "reports_events": { "title": "Event Reports", "actions": { "events_detailed": { "title": "Detailed Events", "allow": true }, "events_summary": { "title": "Events Summary", "allow": true }, "event_pool_report": { "title": "Event Pool Report", "allow": true } } }, "event_profiles_monitored": { "title": "Monitored Event Profiles", "actions": { "view": { "title": "View", "allow": false }, "create": { "title": "Create", "allow": false }, "edit": { "title": "Edit", "allow": false }, "delete": { "title": "Delete", "allow": false } } }, "event_profiles_client": { "title": "Client Event Profiles", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "event_pools": { "title": "Event Pools", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } }, "client_poi": { "title": "Client Points of Interest", "actions": { "view": { "title": "View", "allow": true }, "create": { "title": "Create", "allow": true }, "edit": { "title": "Edit", "allow": true }, "delete": { "title": "Delete", "allow": true } } } }, "photos": [ { "id": null, "type": "photo", "url": "https://cdn.filestackcontent.com/GAGFqKhNSYaa49NFiF3P", "filename": "generic-user-photo.png", "size_bytes": 12376, "created_at": "2017-02-02T20:14:42+02:00" }, { "id": null, "type": "profile_large", "url": "https://cdn.filestackcontent.com/resize=width:400,height:400,fit:crop/GAGFqKhNSYaa49NFiF3P", "filename": "user-profile-large.png", "size_bytes": 12376, "created_at": "2017-02-02T20:14:42+02:00" }, { "id": null, "type": "profile_medium", "url": "https://cdn.filestackcontent.com/resize=width:250,height:250,fit:crop/GAGFqKhNSYaa49NFiF3P", "filename": "user-profile-medium.png", "size_bytes": 7951, "created_at": "2017-02-02T20:14:42+02:00" }, { "id": null, "type": "profile_small", "url": "https://cdn.filestackcontent.com/resize=width:150,height:150,fit:crop/GAGFqKhNSYaa49NFiF3P", "filename": "user-profile-small.png", "size_bytes": 4432, "created_at": "2017-02-02T20:14:42+02:00" } ], "websentinel_url": "https://www.websentinel.app", "acms_url": null, "fota": { "url": "https://api.teltonika.lt", "api_key": "3903|5zJ2dLETTbEXEXSI7zCG4x8rHy7zHN3gpveFkxcM" } } } } } }, "425": { "description": "User Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "warn_fields": { "type": "array", "items": { "type": "object", "properties": { "username": { "type": "string" } } } } } }, "example": { "warn_fields": [ { "username": "The username or email address could not be found on the system." } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "warn_fields": { "type": "array", "items": { "type": "object", "properties": { "password": { "type": "string" } } } } } }, "example": { "warn_fields": [ { "password": "An incorrect password was provided for the username: demo." } ] } } } } }, "description": "Performs a user login request. If successful an HTTP code `200 OK` will be returned together with a new authorization token. Look at the `Authorization` header in the response, it will contain something like `bearer eyJ0eXAiOiJKV1...`. \n\n> **Important:** This token must be cached by you and supplied with each subsequent requests to the API through the `Authorization` HTTP header.\n\n> **Important:** The token is refreshed every few minutes by the API server. When any request is made by you and you receive the `Authorization` header, update your cache with the new token and then send the new token with each subsequent request. The old token does not immediately expire and is valid for 7 days.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } } }, "example": { "username": "{username}", "password": "{password}" } } } } } }, "/auth/logout": { "post": { "tags": [ "Authentication" ], "summary": "User Logout", "operationId": "user-logout", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "description": "Log the user out.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object" } } } } } }, "/auth/websentinel/user": { "post": { "tags": [ "Authentication" ], "summary": "WebSentinel Authentication", "operationId": "websentinel-authentication", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "description": "Authenticates a logged-in user with the WebSentinel service.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object" } } } } } }, "/auth/pwd-reset-request": { "post": { "tags": [ "Authentication" ], "summary": "Password Reset Request", "operationId": "password-reset-request", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } }, "description": "Performs a password reset request for the given email address.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" } } }, "example": { "email": "someone@somedomain.com" } } } } } }, "/auth/pwd-reset": { "post": { "tags": [ "Authentication" ], "summary": "Perform a Password Reset", "operationId": "perform-a-password-reset", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } }, "description": "Performs a password reset based on the provided data.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "token": { "type": "string" }, "password": { "type": "integer", "format": "int64" }, "repeat_password": { "type": "integer", "format": "int64" } } }, "example": { "email": "someone@somedomain.com", "token": "paste_token_here", "password": "12345678", "repeat_password": "12345678" } } } } } }, "/auth/registration": { "post": { "tags": [ "Authentication" ], "summary": "Complete User Registration", "operationId": "complete-user-registration", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } }, "description": "Provide a previous registration token and the users data to complete the user's registration process.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "first_name": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "repeat_password": { "type": "string" }, "full_name": { "type": "string" }, "email": { "type": "string" }, "timezone": { "type": "string" }, "country": { "type": "string" }, "language": { "type": "string" } } }, "example": { "token": "some_token", "first_name": "test.user", "username": "test.user", "password": "test.user", "repeat_password": "test.user", "full_name": "Test User", "email": "user.user@user.com", "timezone": "Africa/Johannesburg", "country": "ZA", "language": "EN" } } } } } }, "/auth/permission/clients/action/view": { "get": { "tags": [ "Authentication" ], "summary": "User Permission Check", "operationId": "user-permission-check", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "token": { "type": "string" } } } } }, "example": { "data": { "token": "bearer token_key" } } } } } }, "description": "Performs an organizational check for the logged in user. This includes a check whether a GET/POST/PUT/DELETE request can be performed on the supplied partner, agency or client. For convenience this request will return the user's primary details along with the user's permissions.", "parameters": [ { "name": "partner_id", "in": "query", "required": true, "schema": { "type": "string" }, "example": "{partner_id}" }, { "name": "agency_id", "in": "query", "required": true, "schema": { "type": "string" }, "example": "{agency_id}" }, { "name": "client_id", "in": "query", "required": true, "schema": { "type": "string" }, "example": "{client_id}" } ] } }, "/units/groups": { "get": { "tags": [ "Unit Groups" ], "summary": "Find Unit Group", "operationId": "find-unit-group", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "name": "Unit Group", "partner": { "id": 1, "name": "Partner Name" }, "agency": null, "client": { "id": 1, "name": "Client Name" }, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-22T14:43:31+02:00", "updated_at": null } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 1 } } } } } }, "description": "Finds one or more unit groups." } }, "/units/groups/listing": { "get": { "tags": [ "Unit Groups" ], "summary": "Unit Group Listing", "operationId": "unit-group-listing", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 1, "name": "Unit Group" } ] } } } } }, "description": "Requests a listing of unit groups which includes the id and name of each unit group." } }, "/units/groups/listing/by-client/1": { "get": { "tags": [ "Unit Groups" ], "summary": "Unit Group Listing By Client", "operationId": "unit-group-listing-by-client", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 1, "name": "Unit Group" } ] } } } } } } }, "/units/groups/1": { "get": { "tags": [ "Unit Groups" ], "summary": "Get a Unit Group", "operationId": "get-a-unit-group", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } } }, "example": { "data": { "id": 1, "name": "Unit Group", "partner": { "id": 1, "name": "Partner Name" }, "agency": null, "client": { "id": 1, "name": "Client Name" }, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-22T14:43:31+02:00", "updated_at": null } } } } } }, "description": "Requests the data for a specific unit group." } }, "/units/groups/create": { "get": { "tags": [ "Unit Groups" ], "summary": "Get Unit Group Create Form Data", "operationId": "get-unit-group-create-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "partners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } } } }, "example": { "data": { "partners": [ { "id": 1, "name": "Partner Name" } ] } } } } } }, "description": "Request to retrieve the data required for a form when creating a new unit group." } }, "/units/groups/1/edit": { "get": { "tags": [ "Unit Groups" ], "summary": "Get Unit Group Edit Form Data", "operationId": "get-unit-group-edit-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "partners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } } } }, "example": { "data": { "id": 1, "name": "Unit Group", "partner": { "id": 1, "name": "Partner Name" }, "agency": null, "client": { "id": 1, "name": "Client Name" }, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-22T14:43:31+02:00", "updated_at": null, "partners": [ { "id": 1, "name": "Partner Name" } ] } } } } } }, "description": "Requests the data required to edit an existing unit group." } }, "/units": { "get": { "tags": [ "Units" ], "summary": "Get a Unit", "operationId": "get-a-unit", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string", "nullable": true }, "stock_no": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" }, "unit_status_code": { "type": "string" }, "unit_status_name": { "type": "string" }, "unit_group_id": { "type": "string", "nullable": true }, "unit_group": { "type": "string", "nullable": true }, "ignition": { "type": "string" }, "fixed_latitude": { "type": "string", "nullable": true }, "fixed_longitude": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" }, "vehicle": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "string", "nullable": true }, "assigned_as": { "type": "string" } } }, "timezone": { "type": "string" }, "op_timezone": { "type": "string" }, "user_full_name": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "flags": { "type": "object", "properties": { "ign_connected": { "type": "boolean" }, "allow_geo_lookups": { "type": "boolean" }, "auto_correct_direction": { "type": "boolean" }, "perform_post_processing": { "type": "boolean" }, "post_process_trip_stops": { "type": "boolean" } } }, "system": { "type": "object", "properties": { "idling": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "event_idle_stop": { "type": "string" }, "speed_less_than": { "type": "string" }, "event_idle_start": { "type": "string" } } }, "trip_stop": { "type": "object", "properties": { "time": { "type": "string" }, "event": { "type": "string" }, "enabled": { "type": "boolean" } } }, "trip_start": { "type": "object", "properties": { "event": { "type": "string" }, "speed": { "type": "string" }, "enabled": { "type": "boolean" }, "distance": { "type": "string" } } }, "gps_spiking": { "type": "object", "properties": { "event": { "type": "string" }, "speed": { "type": "string" }, "enabled": { "type": "boolean" } } }, "gps_drifting": { "type": "object", "properties": { "event": { "type": "string" }, "speed": { "type": "string" }, "radius": { "type": "string" }, "enabled": { "type": "boolean" } } }, "comms_failure": { "type": "object", "properties": { "after": { "type": "string" }, "event": { "type": "string" }, "enabled": { "type": "boolean" }, "report_every": { "type": "string" }, "restored_event": { "type": "string" } } }, "faulty_ignition": { "type": "object", "properties": { "event": { "type": "string" }, "enabled": { "type": "boolean" } } } } }, "sensors": { "type": "array", "items": {} }, "standard_inputs": { "type": "array", "items": {} }, "auxiliary_inputs": { "type": "array", "items": {} }, "event_conversions": { "type": "array", "items": {} }, "notes": { "type": "array", "items": {} }, "attachments": { "type": "array", "items": {} }, "photos": { "type": "array", "items": {} } } } } }, "example": { "data": { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "imei": "5551234567890", "serial_no": null, "stock_no": null, "name": null, "unit_type_code": "acmtech", "unit_type_name": "ACMTech", "unit_model_code": "acmtrack_1", "unit_model_name": "ACMTrack v1", "unit_status_code": "factory", "unit_status_name": "Factory", "unit_group_id": null, "unit_group": null, "ignition": "input_01", "fixed_latitude": null, "fixed_longitude": null, "vehicle_id": 6, "assigned_as": "primary", "vehicle": { "id": 6, "reg_no": "123 ABC GP", "fleet_no": null, "assigned_as": "primary" }, "timezone": "UTC", "op_timezone": "auto", "user_full_name": "User Name", "user_id": 6, "created_at": "2021-04-22T13:32:48+02:00", "updated_at": null, "flags": { "ign_connected": true, "allow_geo_lookups": true, "auto_correct_direction": true, "perform_post_processing": true, "post_process_trip_stops": true }, "system": { "idling": { "enabled": true, "event_idle_stop": "ENG_IDLE:STOP", "speed_less_than": "1 kmh", "event_idle_start": "ENG_IDLE:START" }, "trip_stop": { "time": "5 minutes", "event": "TRIP_STOP", "enabled": true }, "trip_start": { "event": "TRIP_START", "speed": "10 kmh", "enabled": true, "distance": "50 meters" }, "gps_spiking": { "event": "GPS_SPIKE", "speed": "250 kmh", "enabled": true }, "gps_drifting": { "event": "GPS_DRIFTING", "speed": "10 kmh", "radius": "50 meters", "enabled": true }, "comms_failure": { "after": "60 seconds", "event": "NO_COMMS", "enabled": true, "report_every": "24 hours", "restored_event": "COMMS_OK" }, "faulty_ignition": { "event": "IGN_FAULTY", "enabled": true } }, "sensors": [], "standard_inputs": [], "auxiliary_inputs": [], "event_conversions": [], "notes": [], "attachments": [], "photos": [] } } } } } } } }, "/units#find-unit-s": { "get": { "tags": [ "Units" ], "summary": "Find Unit(s)", "operationId": "find-unit-s", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string", "nullable": true }, "stock_no": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" }, "unit_status_code": { "type": "string" }, "unit_status_name": { "type": "string" }, "unit_group_id": { "type": "string", "nullable": true }, "unit_group": { "type": "string", "nullable": true }, "ignition": { "type": "string" }, "fixed_latitude": { "type": "string", "nullable": true }, "fixed_longitude": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" }, "vehicle": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "string", "nullable": true }, "assigned_as": { "type": "string" } } }, "timezone": { "type": "string" }, "op_timezone": { "type": "string" }, "user_full_name": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "sensors": { "type": "array", "items": {} } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "imei": "5551234567890", "serial_no": null, "stock_no": null, "name": null, "unit_type_code": "acmtech", "unit_type_name": "ACMTech", "unit_model_code": "acmtrack_1", "unit_model_name": "ACMTrack v1", "unit_status_code": "factory", "unit_status_name": "Factory", "unit_group_id": null, "unit_group": null, "ignition": "input_01", "fixed_latitude": null, "fixed_longitude": null, "vehicle_id": 6, "assigned_as": "primary", "vehicle": { "id": 6, "reg_no": "123 ABC GP", "fleet_no": null, "assigned_as": "primary" }, "timezone": "UTC", "op_timezone": "auto", "user_full_name": "User Name", "user_id": 6, "created_at": "2021-04-22T13:32:48+02:00", "updated_at": null, "sensors": [] } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 4 } } } } } }, "parameters": [ { "name": "per_page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": "100" }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": "100" }, { "name": "unit_status_code", "in": "query", "required": true, "schema": { "type": "string" }, "example": "active" } ] } }, "/units/by-type/sigfox/exclusive": { "get": { "tags": [ "Units" ], "summary": "Find Units By Type", "operationId": "find-units-by-type", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string", "nullable": true }, "stock_no": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" }, "unit_status_code": { "type": "string" }, "unit_status_name": { "type": "string" }, "unit_group_id": { "type": "string", "nullable": true }, "unit_group": { "type": "string", "nullable": true }, "ignition": { "type": "string" }, "fixed_latitude": { "type": "string", "nullable": true }, "fixed_longitude": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" }, "vehicle": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "string", "nullable": true }, "assigned_as": { "type": "string" } } }, "timezone": { "type": "string" }, "op_timezone": { "type": "string" }, "user_full_name": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "sensors": { "type": "array", "items": {} } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "imei": "5551234567890", "serial_no": null, "stock_no": null, "name": null, "unit_type_code": "acmtech", "unit_type_name": "ACMTech", "unit_model_code": "acmtrack_1", "unit_model_name": "ACMTrack v1", "unit_status_code": "factory", "unit_status_name": "Factory", "unit_group_id": null, "unit_group": null, "ignition": "input_01", "fixed_latitude": null, "fixed_longitude": null, "vehicle_id": 6, "assigned_as": "primary", "vehicle": { "id": 6, "reg_no": "123 ABC GP", "fleet_no": null, "assigned_as": "primary" }, "timezone": "UTC", "op_timezone": "auto", "user_full_name": "User Name", "user_id": 6, "created_at": "2021-04-22T13:32:48+02:00", "updated_at": null, "sensors": [] } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 4 } } } } } }, "description": "Exclusive is optional.\n\nRemove /exclusive to find only units where the type matches /by-type/unit_type_code." } }, "/units/by-client": { "get": { "tags": [ "Units" ], "summary": "Unit Listing By Client", "operationId": "unit-listing-by-client", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string", "nullable": true }, "stock_no": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" }, "unit_status_code": { "type": "string" }, "unit_status_name": { "type": "string" }, "unit_group_id": { "type": "string", "nullable": true }, "unit_group": { "type": "string", "nullable": true }, "ignition": { "type": "string" }, "fixed_latitude": { "type": "string", "nullable": true }, "fixed_longitude": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" }, "vehicle": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "string", "nullable": true }, "assigned_as": { "type": "string" } } }, "timezone": { "type": "string" }, "op_timezone": { "type": "string" }, "user_full_name": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "sensors": { "type": "array", "items": {} } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "imei": "5551234567890", "serial_no": null, "stock_no": null, "name": null, "unit_type_code": "acmtech", "unit_type_name": "ACMTech", "unit_model_code": "acmtrack_1", "unit_model_name": "ACMTrack v1", "unit_status_code": "factory", "unit_status_name": "Factory", "unit_group_id": null, "unit_group": null, "ignition": "input_01", "fixed_latitude": null, "fixed_longitude": null, "vehicle_id": 6, "assigned_as": "primary", "vehicle": { "id": 6, "reg_no": "123 ABC GP", "fleet_no": null, "assigned_as": "primary" }, "timezone": "UTC", "op_timezone": "auto", "user_full_name": "User Name", "user_id": 6, "created_at": "2021-04-22T13:32:48+02:00", "updated_at": null, "sensors": [] } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 1 } } } } } }, "description": "Optional: Add /assigned or /non_assigned after id to get only units assigned to vehicles or units that was not assigned to vehicles.\n\nLeave empty to get all units assigned to specific client.", "parameters": [ { "name": "per_page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": "120" }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": "120" }, { "name": "unit_status_code", "in": "query", "required": true, "schema": { "type": "string" }, "example": "active" }, { "name": "assigned_as", "in": "query", "required": true, "schema": { "type": "string" }, "example": "primary" } ] } }, "/units/by-vehicle/assigned": { "get": { "tags": [ "Units" ], "summary": "Units Listing By Vehicle", "operationId": "units-listing-by-vehicle", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string" }, "stock_no": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" }, "unit_status_code": { "type": "string" }, "unit_status_name": { "type": "string" }, "unit_group_id": { "type": "string", "nullable": true }, "unit_group": { "type": "string", "nullable": true }, "ignition": { "type": "string" }, "fixed_latitude": { "type": "string", "nullable": true }, "fixed_longitude": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" }, "vehicle": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" } } }, "timezone": { "type": "string" }, "op_timezone": { "type": "string" }, "user_full_name": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "sensors": { "type": "array", "items": {} } } } } } }, "example": { "data": [ { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "imei": "5551234567890", "serial_no": "65G4423", "stock_no": null, "name": null, "unit_type_code": "acmtech", "unit_type_name": "ACMTech", "unit_model_code": "acmtrack_1", "unit_model_name": "ACMTrack v1", "unit_status_code": "factory", "unit_status_name": "Factory", "unit_group_id": null, "unit_group": null, "ignition": "input_01", "fixed_latitude": null, "fixed_longitude": null, "vehicle_id": 1, "assigned_as": "primary", "vehicle": { "id": 1, "reg_no": "ABC 123 GP", "fleet_no": "5551234", "assigned_as": "primary" }, "timezone": "UTC", "op_timezone": "auto", "user_full_name": "User Name", "user_id": 6, "created_at": "2021-04-22T14:18:11+02:00", "updated_at": "2021-04-22T14:31:55+02:00", "sensors": [] } ] } } } } } } }, "/units/by-vehicle/assigned-as/primary": { "get": { "tags": [ "Units" ], "summary": "Get Unit By Assigned Slot", "operationId": "get-unit-by-assigned-slot", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string", "nullable": true }, "stock_no": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" }, "unit_status_code": { "type": "string" }, "unit_status_name": { "type": "string" }, "unit_group_id": { "type": "string", "nullable": true }, "unit_group": { "type": "string", "nullable": true }, "ignition": { "type": "string" }, "fixed_latitude": { "type": "string", "nullable": true }, "fixed_longitude": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" }, "vehicle": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "string", "nullable": true }, "assigned_as": { "type": "string" } } }, "timezone": { "type": "string" }, "op_timezone": { "type": "string" }, "user_full_name": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "flags": { "type": "object", "properties": { "ign_connected": { "type": "boolean" }, "allow_geo_lookups": { "type": "boolean" }, "auto_correct_direction": { "type": "boolean" }, "perform_post_processing": { "type": "boolean" }, "post_process_trip_stops": { "type": "boolean" } } }, "system": { "type": "object", "properties": { "idling": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "event_idle_stop": { "type": "string" }, "speed_less_than": { "type": "string" }, "event_idle_start": { "type": "string" } } }, "trip_stop": { "type": "object", "properties": { "time": { "type": "string" }, "event": { "type": "string" }, "enabled": { "type": "boolean" } } }, "trip_start": { "type": "object", "properties": { "event": { "type": "string" }, "speed": { "type": "string" }, "enabled": { "type": "boolean" }, "distance": { "type": "string" } } }, "gps_spiking": { "type": "object", "properties": { "event": { "type": "string" }, "speed": { "type": "string" }, "enabled": { "type": "boolean" } } }, "gps_drifting": { "type": "object", "properties": { "event": { "type": "string" }, "speed": { "type": "string" }, "radius": { "type": "string" }, "enabled": { "type": "boolean" } } }, "comms_failure": { "type": "object", "properties": { "after": { "type": "string" }, "event": { "type": "string" }, "enabled": { "type": "boolean" }, "report_every": { "type": "string" }, "restored_event": { "type": "string" } } }, "faulty_ignition": { "type": "object", "properties": { "event": { "type": "string" }, "enabled": { "type": "boolean" } } } } }, "sensors": { "type": "array", "items": {} }, "standard_inputs": { "type": "array", "items": {} }, "auxiliary_inputs": { "type": "array", "items": {} }, "event_conversions": { "type": "array", "items": {} }, "notes": { "type": "array", "items": {} }, "attachments": { "type": "array", "items": {} }, "photos": { "type": "array", "items": {} } } } } }, "example": { "data": { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "imei": "5551234567890", "serial_no": null, "stock_no": null, "name": null, "unit_type_code": "acmtech", "unit_type_name": "ACMTech", "unit_model_code": "acmtrack_1", "unit_model_name": "ACMTrack v1", "unit_status_code": "factory", "unit_status_name": "Factory", "unit_group_id": null, "unit_group": null, "ignition": "input_01", "fixed_latitude": null, "fixed_longitude": null, "vehicle_id": 6, "assigned_as": "primary", "vehicle": { "id": 6, "reg_no": "123 ABC GP", "fleet_no": null, "assigned_as": "primary" }, "timezone": "UTC", "op_timezone": "auto", "user_full_name": "User Name", "user_id": 6, "created_at": "2021-04-22T13:32:48+02:00", "updated_at": null, "flags": { "ign_connected": true, "allow_geo_lookups": true, "auto_correct_direction": true, "perform_post_processing": true, "post_process_trip_stops": true }, "system": { "idling": { "enabled": true, "event_idle_stop": "ENG_IDLE:STOP", "speed_less_than": "1 kmh", "event_idle_start": "ENG_IDLE:START" }, "trip_stop": { "time": "5 minutes", "event": "TRIP_STOP", "enabled": true }, "trip_start": { "event": "TRIP_START", "speed": "10 kmh", "enabled": true, "distance": "50 meters" }, "gps_spiking": { "event": "GPS_SPIKE", "speed": "250 kmh", "enabled": true }, "gps_drifting": { "event": "GPS_DRIFTING", "speed": "10 kmh", "radius": "50 meters", "enabled": true }, "comms_failure": { "after": "60 seconds", "event": "NO_COMMS", "enabled": true, "report_every": "24 hours", "restored_event": "COMMS_OK" }, "faulty_ignition": { "event": "IGN_FAULTY", "enabled": true } }, "sensors": [], "standard_inputs": [], "auxiliary_inputs": [], "event_conversions": [], "notes": [], "attachments": [], "photos": [] } } } } } } } }, "/units/by-group/ids": { "get": { "tags": [ "Units" ], "summary": "Unit Listing By Group", "operationId": "unit-listing-by-group", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string" }, "stock_no": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" }, "unit_status_code": { "type": "string" }, "unit_status_name": { "type": "string" }, "unit_group_id": { "type": "integer", "format": "int64" }, "unit_group": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "ignition": { "type": "string" }, "fixed_latitude": { "type": "string", "nullable": true }, "fixed_longitude": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" }, "vehicle": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" } } }, "timezone": { "type": "string" }, "op_timezone": { "type": "string" }, "user_full_name": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "sensors": { "type": "array", "items": {} } } } } } }, "example": { "data": [ { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "imei": "5551234567890", "serial_no": "65G4423", "stock_no": null, "name": null, "unit_type_code": "acmtech", "unit_type_name": "ACMTech", "unit_model_code": "acmtrack_1", "unit_model_name": "ACMTrack v1", "unit_status_code": "factory", "unit_status_name": "Factory", "unit_group_id": 1, "unit_group": { "id": 1, "name": "Unit Group" }, "ignition": "input_01", "fixed_latitude": null, "fixed_longitude": null, "vehicle_id": 1, "assigned_as": "primary", "vehicle": { "id": 1, "reg_no": "ABC 123 GP", "fleet_no": "5551234", "assigned_as": "primary" }, "timezone": "UTC", "op_timezone": "auto", "user_full_name": "User Name", "user_id": 6, "created_at": "2021-04-22T14:18:11+02:00", "updated_at": "2021-04-22T14:45:54+02:00", "sensors": [] } ] } } } } }, "parameters": [ { "name": "group_ids", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": "1" } ] } }, "/units/non-assigned/by-partner/1": { "get": { "tags": [ "Units" ], "summary": "Units Listing By Partner", "operationId": "units-listing-by-partner", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string" }, "stock_no": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" }, "unit_status_code": { "type": "string" }, "unit_status_name": { "type": "string" }, "unit_group_id": { "type": "string", "nullable": true }, "unit_group": { "type": "string", "nullable": true }, "ignition": { "type": "string" }, "fixed_latitude": { "type": "string", "nullable": true }, "fixed_longitude": { "type": "string", "nullable": true }, "vehicle_id": { "type": "string", "nullable": true }, "assigned_as": { "type": "string", "nullable": true }, "vehicle": { "type": "string", "nullable": true }, "timezone": { "type": "string" }, "op_timezone": { "type": "string" }, "user_full_name": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "sensors": { "type": "array", "items": {} } } } } } }, "example": { "data": [ { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "imei": "5551234567890", "serial_no": "65G4423", "stock_no": null, "name": null, "unit_type_code": "acmtech", "unit_type_name": "ACMTech", "unit_model_code": "acmtrack_1", "unit_model_name": "ACMTrack v1", "unit_status_code": "factory", "unit_status_name": "Factory", "unit_group_id": null, "unit_group": null, "ignition": "input_01", "fixed_latitude": null, "fixed_longitude": null, "vehicle_id": null, "assigned_as": null, "vehicle": null, "timezone": "UTC", "op_timezone": "auto", "user_full_name": "User Name", "user_id": 6, "created_at": "2021-04-22T15:02:12+02:00", "updated_at": null, "sensors": [] } ] } } } } } } }, "/units/sensors/type/1/model/1": { "get": { "tags": [ "Units" ], "summary": "Unit Sensors LIsting By Type And Model", "operationId": "unit-sensors-listing-by-type-and-model", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } } } }, "/units/sensors/type/1": { "get": { "tags": [ "Units" ], "summary": "Unit Sensors Listing By Type", "operationId": "unit-sensors-listing-by-type", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } } } }, "/units/sensors": { "get": { "tags": [ "Units" ], "summary": "Find Unit Sensors", "operationId": "find-unit-sensors", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } } } }, "/units/listing": { "get": { "tags": [ "Units" ], "summary": "Units Listing", "operationId": "units-listing", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string" }, "stock_no": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } } } } } }, "example": { "data": [ { "id": 1, "imei": "5551234567890", "serial_no": "65G4423", "stock_no": null, "name": null } ] } } } } } } }, "/units/telemetry": { "get": { "tags": [ "Units" ], "summary": "Get Unit Telemetry", "operationId": "get-unit-telemetry", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "telemetry": { "type": "object", "properties": { "gps": { "type": "object", "properties": { "fix": { "type": "array", "items": { "type": "string" } }, "gnss": { "type": "integer", "format": "int64" }, "hdop": { "type": "integer", "format": "int64" }, "pdop": { "type": "integer", "format": "int64" }, "tdop": { "type": "string", "nullable": true }, "vdop": { "type": "string", "nullable": true }, "speed": { "type": "integer", "format": "int64" }, "heading": { "type": "integer", "format": "int64" }, "activity": { "type": "string" }, "altitude": { "type": "integer", "format": "int64" }, "latitude": { "type": "number" }, "odometer": { "type": "string", "nullable": true }, "timezone": { "type": "string" }, "trip_odo": { "type": "integer", "format": "int64" }, "longitude": { "type": "number" }, "timestamp": { "type": "string", "format": "date-time" }, "local_time": { "type": "string", "format": "date-time" }, "satellites": { "type": "integer", "format": "int64" }, "distance_km": { "type": "integer", "format": "int64" } } }, "gsm": { "type": "array", "items": { "type": "object", "properties": { "cid": { "type": "array", "items": {} }, "lac": { "type": "array", "items": {} }, "mcc": { "type": "array", "items": {} }, "mnc": { "type": "array", "items": {} }, "lcid": { "type": "array", "items": {} }, "rcpi": { "type": "array", "items": {} }, "rssi": { "type": "array", "items": {} }, "status": { "type": "array", "items": { "type": "string" } }, "carrier": { "type": "string", "nullable": true }, "data_mode": { "type": "string" }, "signal_lvl": { "type": "integer", "format": "int64" }, "signal_str": { "type": "integer", "format": "int64" } } } }, "ldps": { "type": "object", "properties": { "name": { "type": "string" }, "error": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "error_code": { "type": "string", "nullable": true } } }, "port": { "type": "integer", "format": "int64" }, "sims": { "type": "array", "items": {} }, "valid": { "type": "boolean" }, "device": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "imei": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "type": { "type": "string" }, "model": { "type": "string" }, "status": { "type": "string" }, "firm_ver": { "type": "string", "nullable": true }, "stock_no": { "type": "string", "nullable": true }, "serial_no": { "type": "string", "nullable": true }, "identifier": { "type": "string" }, "assigned_as": { "type": "string", "nullable": true } } }, "driver": { "type": "string", "nullable": true }, "events": { "type": "array", "items": {} }, "inputs": { "type": "integer", "format": "int64" }, "obd_ii": { "type": "object", "properties": { "mode_01": { "type": "array", "items": {} } } }, "seq_no": { "type": "integer", "format": "int64" }, "source": { "type": "string" }, "can_bus": { "type": "array", "items": {} }, "gateway": { "type": "string" }, "network": { "type": "object", "properties": { "mac": { "type": "string", "nullable": true }, "remote_ipv4": { "type": "string" }, "remote_ipv6": { "type": "string", "nullable": true }, "remote_port": { "type": "integer", "format": "int64" } } }, "outputs": { "type": "integer", "format": "int64" }, "sensors": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "vehicle": { "type": "string", "nullable": true }, "buffered": { "type": "boolean" }, "an_inputs": { "type": "array", "items": { "type": "number" } }, "timestamp": { "type": "string", "format": "date-time" }, "aux_inputs": { "type": "array", "items": {} }, "message_ver": { "type": "integer", "format": "int64" }, "message_type": { "type": "string" }, "transmission": { "type": "string" } } } } } } }, "example": { "data": { "telemetry": { "gps": { "fix": [ "fixed" ], "gnss": 1, "hdop": 0, "pdop": 0, "tdop": null, "vdop": null, "speed": 0, "heading": 198, "activity": "unknown", "altitude": 1678, "latitude": -26.439923, "odometer": null, "timezone": "Africa/Johannesburg", "trip_odo": 0, "longitude": 29.475668, "timestamp": "2021-02-09T11:16:53+00:00", "local_time": "2021-02-09T13:16:53+02:00", "satellites": 14, "distance_km": 0 }, "gsm": [ { "cid": [], "lac": [], "mcc": [], "mnc": [], "lcid": [], "rcpi": [], "rssi": [], "status": [ "engine", "network", "data", "connected" ], "carrier": null, "data_mode": "home_stop", "signal_lvl": 4, "signal_str": 80 } ], "ldps": { "name": "www.dummydomain.net", "error": null, "timestamp": "2021-02-09T11:17:42+00:00", "error_code": null }, "port": 5027, "sims": [], "valid": true, "device": { "id": 1, "imei": "359633101461387", "name": null, "type": "teltonika", "model": "acmtrack_1", "status": "factory", "firm_ver": null, "stock_no": null, "serial_no": null, "identifier": "imei", "assigned_as": null }, "driver": null, "events": [], "inputs": "000", "obd_ii": { "mode_01": [] }, "seq_no": 1, "source": "device", "can_bus": [], "gateway": "gateway.dummydomain.net", "network": { "mac": null, "remote_ipv4": "41.206.206.35", "remote_ipv6": null, "remote_port": 58303 }, "outputs": "00", "sensors": [ [ "eco_score", 10 ], [ "speed", 0 ], [ "ebat_volts", 12.254 ], [ "ibat_volts", 4.029 ], [ "ibat_amps", 0 ], [ "trip_odo", 0 ], [ "movement", false ], [ "ignition", "off" ], [ "sleep_mode", "no_sleep" ] ], "vehicle": null, "buffered": false, "an_inputs": [ 0.131 ], "timestamp": "2021-02-09T11:17:42+00:00", "aux_inputs": [], "message_ver": 1, "message_type": "gps", "transmission": "tcp" } } } } } } } } }, "/units/by-imei/telemetry": { "get": { "tags": [ "Units" ], "summary": "Get Unit Telemetry by IMEI", "operationId": "get-unit-telemetry-by-imei", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "telemetry": { "type": "object", "properties": { "gps": { "type": "object", "properties": { "fix": { "type": "array", "items": { "type": "string" } }, "gnss": { "type": "integer", "format": "int64" }, "hdop": { "type": "integer", "format": "int64" }, "pdop": { "type": "integer", "format": "int64" }, "tdop": { "type": "string", "nullable": true }, "vdop": { "type": "string", "nullable": true }, "speed": { "type": "integer", "format": "int64" }, "heading": { "type": "integer", "format": "int64" }, "activity": { "type": "string" }, "altitude": { "type": "integer", "format": "int64" }, "latitude": { "type": "number" }, "odometer": { "type": "string", "nullable": true }, "timezone": { "type": "string" }, "trip_odo": { "type": "integer", "format": "int64" }, "longitude": { "type": "number" }, "timestamp": { "type": "string", "format": "date-time" }, "local_time": { "type": "string", "format": "date-time" }, "satellites": { "type": "integer", "format": "int64" }, "distance_km": { "type": "integer", "format": "int64" } } }, "gsm": { "type": "array", "items": { "type": "object", "properties": { "cid": { "type": "array", "items": {} }, "lac": { "type": "array", "items": {} }, "mcc": { "type": "array", "items": {} }, "mnc": { "type": "array", "items": {} }, "lcid": { "type": "array", "items": {} }, "rcpi": { "type": "array", "items": {} }, "rssi": { "type": "array", "items": {} }, "status": { "type": "array", "items": { "type": "string" } }, "carrier": { "type": "string", "nullable": true }, "data_mode": { "type": "string" }, "signal_lvl": { "type": "integer", "format": "int64" }, "signal_str": { "type": "integer", "format": "int64" } } } }, "ldps": { "type": "object", "properties": { "name": { "type": "string" }, "error": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "error_code": { "type": "string", "nullable": true } } }, "port": { "type": "integer", "format": "int64" }, "sims": { "type": "array", "items": {} }, "valid": { "type": "boolean" }, "device": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "imei": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "type": { "type": "string" }, "model": { "type": "string" }, "status": { "type": "string" }, "firm_ver": { "type": "string", "nullable": true }, "stock_no": { "type": "string", "nullable": true }, "serial_no": { "type": "string", "nullable": true }, "identifier": { "type": "string" }, "assigned_as": { "type": "string", "nullable": true } } }, "driver": { "type": "string", "nullable": true }, "events": { "type": "array", "items": {} }, "inputs": { "type": "integer", "format": "int64" }, "obd_ii": { "type": "object", "properties": { "mode_01": { "type": "array", "items": {} } } }, "seq_no": { "type": "integer", "format": "int64" }, "source": { "type": "string" }, "can_bus": { "type": "array", "items": {} }, "gateway": { "type": "string" }, "network": { "type": "object", "properties": { "mac": { "type": "string", "nullable": true }, "remote_ipv4": { "type": "string" }, "remote_ipv6": { "type": "string", "nullable": true }, "remote_port": { "type": "integer", "format": "int64" } } }, "outputs": { "type": "integer", "format": "int64" }, "sensors": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "vehicle": { "type": "string", "nullable": true }, "buffered": { "type": "boolean" }, "an_inputs": { "type": "array", "items": { "type": "number" } }, "timestamp": { "type": "string", "format": "date-time" }, "aux_inputs": { "type": "array", "items": {} }, "message_ver": { "type": "integer", "format": "int64" }, "message_type": { "type": "string" }, "transmission": { "type": "string" } } } } } } }, "example": { "data": { "telemetry": { "gps": { "fix": [ "fixed" ], "gnss": 1, "hdop": 0, "pdop": 0, "tdop": null, "vdop": null, "speed": 0, "heading": 198, "activity": "unknown", "altitude": 1678, "latitude": -26.439923, "odometer": null, "timezone": "Africa/Johannesburg", "trip_odo": 0, "longitude": 29.475668, "timestamp": "2021-02-09T11:16:53+00:00", "local_time": "2021-02-09T13:16:53+02:00", "satellites": 14, "distance_km": 0 }, "gsm": [ { "cid": [], "lac": [], "mcc": [], "mnc": [], "lcid": [], "rcpi": [], "rssi": [], "status": [ "engine", "network", "data", "connected" ], "carrier": null, "data_mode": "home_stop", "signal_lvl": 4, "signal_str": 80 } ], "ldps": { "name": "www.dummydomain.net", "error": null, "timestamp": "2021-02-09T11:17:42+00:00", "error_code": null }, "port": 5027, "sims": [], "valid": true, "device": { "id": 1, "imei": "359633101461387", "name": null, "type": "teltonika", "model": "acmtrack_1", "status": "factory", "firm_ver": null, "stock_no": null, "serial_no": null, "identifier": "imei", "assigned_as": null }, "driver": null, "events": [], "inputs": "000", "obd_ii": { "mode_01": [] }, "seq_no": 1, "source": "device", "can_bus": [], "gateway": "gateway.dummydomain.net", "network": { "mac": null, "remote_ipv4": "41.206.206.35", "remote_ipv6": null, "remote_port": 58303 }, "outputs": "00", "sensors": [ [ "eco_score", 10 ], [ "speed", 0 ], [ "ebat_volts", 12.254 ], [ "ibat_volts", 4.029 ], [ "ibat_amps", 0 ], [ "trip_odo", 0 ], [ "movement", false ], [ "ignition", "off" ], [ "sleep_mode", "no_sleep" ] ], "vehicle": null, "buffered": false, "an_inputs": [ 0.131 ], "timestamp": "2021-02-09T11:17:42+00:00", "aux_inputs": [], "message_ver": 1, "message_type": "gps", "transmission": "tcp" } } } } } } } } }, "/units/by-serial-no/telemetry": { "get": { "tags": [ "Units" ], "summary": "Get Unit Telemetry by Serial No.", "operationId": "get-unit-telemetry-by-serial-no", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "telemetry": { "type": "object", "properties": { "gps": { "type": "object", "properties": { "fix": { "type": "array", "items": { "type": "string" } }, "gnss": { "type": "integer", "format": "int64" }, "hdop": { "type": "integer", "format": "int64" }, "pdop": { "type": "integer", "format": "int64" }, "tdop": { "type": "string", "nullable": true }, "vdop": { "type": "string", "nullable": true }, "speed": { "type": "integer", "format": "int64" }, "heading": { "type": "integer", "format": "int64" }, "activity": { "type": "string" }, "altitude": { "type": "integer", "format": "int64" }, "latitude": { "type": "number" }, "odometer": { "type": "string", "nullable": true }, "timezone": { "type": "string" }, "trip_odo": { "type": "integer", "format": "int64" }, "longitude": { "type": "number" }, "timestamp": { "type": "string", "format": "date-time" }, "local_time": { "type": "string", "format": "date-time" }, "satellites": { "type": "integer", "format": "int64" }, "distance_km": { "type": "integer", "format": "int64" } } }, "gsm": { "type": "array", "items": { "type": "object", "properties": { "cid": { "type": "array", "items": {} }, "lac": { "type": "array", "items": {} }, "mcc": { "type": "array", "items": {} }, "mnc": { "type": "array", "items": {} }, "lcid": { "type": "array", "items": {} }, "rcpi": { "type": "array", "items": {} }, "rssi": { "type": "array", "items": {} }, "status": { "type": "array", "items": { "type": "string" } }, "carrier": { "type": "string", "nullable": true }, "data_mode": { "type": "string" }, "signal_lvl": { "type": "integer", "format": "int64" }, "signal_str": { "type": "integer", "format": "int64" } } } }, "ldps": { "type": "object", "properties": { "name": { "type": "string" }, "error": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "error_code": { "type": "string", "nullable": true } } }, "port": { "type": "integer", "format": "int64" }, "sims": { "type": "array", "items": {} }, "valid": { "type": "boolean" }, "device": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "imei": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "type": { "type": "string" }, "model": { "type": "string" }, "status": { "type": "string" }, "firm_ver": { "type": "string", "nullable": true }, "stock_no": { "type": "string", "nullable": true }, "serial_no": { "type": "string", "nullable": true }, "identifier": { "type": "string" }, "assigned_as": { "type": "string", "nullable": true } } }, "driver": { "type": "string", "nullable": true }, "events": { "type": "array", "items": {} }, "inputs": { "type": "integer", "format": "int64" }, "obd_ii": { "type": "object", "properties": { "mode_01": { "type": "array", "items": {} } } }, "seq_no": { "type": "integer", "format": "int64" }, "source": { "type": "string" }, "can_bus": { "type": "array", "items": {} }, "gateway": { "type": "string" }, "network": { "type": "object", "properties": { "mac": { "type": "string", "nullable": true }, "remote_ipv4": { "type": "string" }, "remote_ipv6": { "type": "string", "nullable": true }, "remote_port": { "type": "integer", "format": "int64" } } }, "outputs": { "type": "integer", "format": "int64" }, "sensors": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "vehicle": { "type": "string", "nullable": true }, "buffered": { "type": "boolean" }, "an_inputs": { "type": "array", "items": { "type": "number" } }, "timestamp": { "type": "string", "format": "date-time" }, "aux_inputs": { "type": "array", "items": {} }, "message_ver": { "type": "integer", "format": "int64" }, "message_type": { "type": "string" }, "transmission": { "type": "string" } } } } } } }, "example": { "data": { "telemetry": { "gps": { "fix": [ "fixed" ], "gnss": 1, "hdop": 0, "pdop": 0, "tdop": null, "vdop": null, "speed": 0, "heading": 198, "activity": "unknown", "altitude": 1678, "latitude": -26.439923, "odometer": null, "timezone": "Africa/Johannesburg", "trip_odo": 0, "longitude": 29.475668, "timestamp": "2021-02-09T11:16:53+00:00", "local_time": "2021-02-09T13:16:53+02:00", "satellites": 14, "distance_km": 0 }, "gsm": [ { "cid": [], "lac": [], "mcc": [], "mnc": [], "lcid": [], "rcpi": [], "rssi": [], "status": [ "engine", "network", "data", "connected" ], "carrier": null, "data_mode": "home_stop", "signal_lvl": 4, "signal_str": 80 } ], "ldps": { "name": "www.dummydomain.net", "error": null, "timestamp": "2021-02-09T11:17:42+00:00", "error_code": null }, "port": 5027, "sims": [], "valid": true, "device": { "id": 1, "imei": "359633101461387", "name": null, "type": "teltonika", "model": "acmtrack_1", "status": "factory", "firm_ver": null, "stock_no": null, "serial_no": null, "identifier": "imei", "assigned_as": null }, "driver": null, "events": [], "inputs": "000", "obd_ii": { "mode_01": [] }, "seq_no": 1, "source": "device", "can_bus": [], "gateway": "gateway.dummydomain.net", "network": { "mac": null, "remote_ipv4": "41.206.206.35", "remote_ipv6": null, "remote_port": 58303 }, "outputs": "00", "sensors": [ [ "eco_score", 10 ], [ "speed", 0 ], [ "ebat_volts", 12.254 ], [ "ibat_volts", 4.029 ], [ "ibat_amps", 0 ], [ "trip_odo", 0 ], [ "movement", false ], [ "ignition", "off" ], [ "sleep_mode", "no_sleep" ] ], "vehicle": null, "buffered": false, "an_inputs": [ 0.131 ], "timestamp": "2021-02-09T11:17:42+00:00", "aux_inputs": [], "message_ver": 1, "message_type": "gps", "transmission": "tcp" } } } } } } } } }, "/units/view": { "get": { "tags": [ "Units" ], "summary": "Units View", "operationId": "units-view", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string" }, "stock_no": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" }, "unit_status_code": { "type": "string" }, "unit_status_name": { "type": "string" }, "unit_group_id": { "type": "integer", "format": "int64" }, "unit_group": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "ignition": { "type": "string" }, "fixed_latitude": { "type": "string", "nullable": true }, "fixed_longitude": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" }, "vehicle": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" } } }, "timezone": { "type": "string" }, "op_timezone": { "type": "string" }, "user_full_name": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "flags": { "type": "object", "properties": { "ign_connected": { "type": "boolean" }, "allow_geo_lookups": { "type": "boolean" }, "auto_correct_direction": { "type": "boolean" }, "perform_post_processing": { "type": "boolean" }, "post_process_trip_stops": { "type": "boolean" } } }, "system": { "type": "object", "properties": { "idling": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "event_idle_stop": { "type": "string" }, "speed_less_than": { "type": "string" }, "event_idle_start": { "type": "string" } } }, "trip_stop": { "type": "object", "properties": { "time": { "type": "string" }, "event": { "type": "string" }, "enabled": { "type": "boolean" } } }, "trip_start": { "type": "object", "properties": { "event": { "type": "string" }, "speed": { "type": "string" }, "enabled": { "type": "boolean" }, "distance": { "type": "string" } } }, "gps_spiking": { "type": "object", "properties": { "event": { "type": "string" }, "speed": { "type": "string" }, "enabled": { "type": "boolean" } } }, "gps_drifting": { "type": "object", "properties": { "event": { "type": "string" }, "speed": { "type": "string" }, "radius": { "type": "string" }, "enabled": { "type": "boolean" } } }, "comms_failure": { "type": "object", "properties": { "after": { "type": "string" }, "event": { "type": "string" }, "enabled": { "type": "boolean" }, "report_every": { "type": "string" }, "restored_event": { "type": "string" } } }, "faulty_ignition": { "type": "object", "properties": { "event": { "type": "string" }, "enabled": { "type": "boolean" } } } } }, "sensors": { "type": "array", "items": {} }, "standard_inputs": { "type": "array", "items": {} }, "auxiliary_inputs": { "type": "array", "items": {} }, "event_conversions": { "type": "array", "items": {} }, "notes": { "type": "array", "items": {} }, "attachments": { "type": "array", "items": {} }, "photos": { "type": "array", "items": {} }, "partners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "agencies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "unit_types": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "unit_models": { "type": "object", "properties": { "acmtech": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "calamp": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "gosafe": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "queclink": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "teltonika": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "gt06": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "wist": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "cobd": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "sigfox": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } } } }, "unit_statuses": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "config_templates": { "type": "array", "items": {} }, "sensor_data": { "type": "array", "items": {} }, "timezones": { "type": "object", "properties": { "Africa/Johannesburg": { "type": "string" }, "UTC": { "type": "string" } } }, "units_of_measurement": { "type": "array", "items": { "type": "object", "properties": { "unit": { "type": "string" }, "symbol": { "type": "string" }, "description": { "type": "string" } } } } } } } }, "example": { "data": { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "imei": "5551234567890", "serial_no": "65G4423", "stock_no": null, "name": null, "unit_type_code": "acmtech", "unit_type_name": "ACMTech", "unit_model_code": "acmtrack_1", "unit_model_name": "ACMTrack v1", "unit_status_code": "factory", "unit_status_name": "Factory", "unit_group_id": 1, "unit_group": { "id": 1, "name": "Unit Group" }, "ignition": "input_01", "fixed_latitude": null, "fixed_longitude": null, "vehicle_id": 1, "assigned_as": "primary", "vehicle": { "id": 1, "reg_no": "ABC 123 GP", "fleet_no": "5551234", "assigned_as": "primary" }, "timezone": "UTC", "op_timezone": "auto", "user_full_name": "User Name", "user_id": 6, "created_at": "2021-04-22T14:18:11+02:00", "updated_at": "2021-04-22T14:45:54+02:00", "flags": { "ign_connected": true, "allow_geo_lookups": true, "auto_correct_direction": true, "perform_post_processing": true, "post_process_trip_stops": true }, "system": { "idling": { "enabled": true, "event_idle_stop": "ENG_IDLE:STOP", "speed_less_than": "1 kmh", "event_idle_start": "ENG_IDLE:START" }, "trip_stop": { "time": "5 minutes", "event": "TRIP_STOP", "enabled": true }, "trip_start": { "event": "TRIP_START", "speed": "10 kmh", "enabled": true, "distance": "50 meters" }, "gps_spiking": { "event": "GPS_SPIKE", "speed": "250 kmh", "enabled": true }, "gps_drifting": { "event": "GPS_DRIFTING", "speed": "10 kmh", "radius": "50 meters", "enabled": true }, "comms_failure": { "after": "60 seconds", "event": "NO_COMMS", "enabled": true, "report_every": "24 hours", "restored_event": "COMMS_OK" }, "faulty_ignition": { "event": "IGN_FAULTY", "enabled": true } }, "sensors": [], "standard_inputs": [], "auxiliary_inputs": [], "event_conversions": [], "notes": [], "attachments": [], "photos": [], "partners": [ { "id": 1, "name": "Partner Name" } ], "agencies": [ { "id": 1, "name": "Agency Name" } ], "clients": [ { "id": 2, "name": "Agency Client Name 2" }, { "id": 1, "name": "Client Name" } ], "unit_types": [ { "code": "acmtech", "name": "ACMTech" }, { "code": "calamp", "name": "Calamp" }, { "code": "gosafe", "name": "Gosafe" }, { "code": "queclink", "name": "Queclink" }, { "code": "teltonika", "name": "Teltonika" }, { "code": "gt06", "name": "GT06" }, { "code": "wist", "name": "Wist" }, { "code": "cobd", "name": "CObd" }, { "code": "sigfox", "name": "SigFox" } ], "unit_models": { "acmtech": [ { "code": "acmtrack_1", "name": "ACMTrack v1" }, { "code": "acmtrack_2", "name": "ACMTrack v2" } ], "calamp": [ { "code": "atu_620", "name": "ATU-620" }, { "code": "ttu_700", "name": "TTU-720" }, { "code": "ttu_1200", "name": "TTU-1200" }, { "code": "ttu_2830", "name": "TTU-2830" }, { "code": "ttu_2840", "name": "TTU-2840 XTREME" }, { "code": "lmu_200", "name": "LMU-200" }, { "code": "lmu_300", "name": "LMU-300" }, { "code": "lmu_303x", "name": "LMU-303-X" }, { "code": "lmu_400", "name": "LMU-400" }, { "code": "lmu_600", "name": "LMU-600" }, { "code": "lmu_700", "name": "LMU-700" }, { "code": "lmu_800", "name": "LMU-800" }, { "code": "lmu_900", "name": "LMU-900" }, { "code": "lmu_1100", "name": "LMU-1100" }, { "code": "lmu_1200", "name": "LMU-1200" }, { "code": "lmu_2010", "name": "LMU-2010" }, { "code": "lmu_2030", "name": "LMU-2030" }, { "code": "lmu_2100", "name": "LMU-2100" }, { "code": "lmu_2600", "name": "LMU-2600" }, { "code": "lmu_3200", "name": "LMU-3200" }, { "code": "lmu_4200", "name": "LMU-4200" }, { "code": "lmu_4520", "name": "LMU-4250" }, { "code": "lmu_5530", "name": "LMU-5530" }, { "code": "mdt_7p", "name": "MDT-7P" } ], "gosafe": [ { "code": "g1s", "name": "G1S" }, { "code": "g2p", "name": "G2P" }, { "code": "g3a", "name": "G3A" }, { "code": "g3c", "name": "G3C" }, { "code": "g3s", "name": "G3S" }, { "code": "g6s", "name": "G6S" }, { "code": "g7s", "name": "G7S" }, { "code": "g79w", "name": "G79W" } ], "queclink": [ { "code": "gl200", "name": "GL200" }, { "code": "gl300", "name": "GL300" }, { "code": "gl300vc", "name": "GL300VC" }, { "code": "gl300w", "name": "GL300W" }, { "code": "gl500", "name": "GL500" }, { "code": "gl505", "name": "GL505" }, { "code": "gl520", "name": "GL520" }, { "code": "gl3000w", "name": "GL3000W" } ], "teltonika": [ { "code": "fm36m1", "name": "FM36M1" }, { "code": "fm3001", "name": "FM3001" }, { "code": "fm3612", "name": "FM3612" }, { "code": "fm6300", "name": "FM6300" }, { "code": "fmb001", "name": "FMB001" }, { "code": "fmb002", "name": "FMB002" }, { "code": "fmb003", "name": "FMB003" }, { "code": "fmb010", "name": "FMB010" }, { "code": "fmb020", "name": "FMB020" }, { "code": "fmb110", "name": "FMB110" }, { "code": "fmb120", "name": "FMB120" }, { "code": "fmb122", "name": "FMB122" }, { "code": "fmb125", "name": "FMB125" }, { "code": "fmb130", "name": "FMB130" }, { "code": "fmb140", "name": "FMB140" }, { "code": "fmb202", "name": "FMB202" }, { "code": "fmb204", "name": "FMB204" }, { "code": "fmb208", "name": "FMB208" }, { "code": "fmb630", "name": "FMB630" }, { "code": "fmb640", "name": "FMB640" }, { "code": "fmb900", "name": "FMB900" }, { "code": "fmb920", "name": "FMB920" }, { "code": "fmb964", "name": "FMB964" }, { "code": "fmc001", "name": "FMC001" }, { "code": "fmc125", "name": "FMC125" }, { "code": "fmc130", "name": "FMC130" }, { "code": "fmc640", "name": "FMC640" }, { "code": "fmm001", "name": "FMM001" }, { "code": "fmm125", "name": "FMM125" }, { "code": "fmm130", "name": "FMM130" }, { "code": "fmm640", "name": "FMM640" }, { "code": "fmu125", "name": "FMU125" }, { "code": "fmu126", "name": "FMU126" }, { "code": "fmu130", "name": "FMU130" }, { "code": "fmt100", "name": "FMT100" }, { "code": "msp500", "name": "MSP500" }, { "code": "mtb100", "name": "MTB100" }, { "code": "tmt250", "name": "TMT250" } ], "gt06": [ { "code": "gt06", "name": "GT06" } ], "wist": [ { "code": "wist", "name": "Wist" } ], "cobd": [ { "code": "cobd", "name": "CObd" } ], "sigfox": [ { "code": "foxy", "name": "Foxy" } ] }, "unit_statuses": [ { "code": "factory", "name": "Factory" }, { "code": "pre_stock_pending", "name": "Pre-stock Pending" }, { "code": "post_stock_pending", "name": "Post-stock Pending" }, { "code": "ready", "name": "Ready" }, { "code": "pre_active", "name": "Pre-Active" }, { "code": "active", "name": "Active" }, { "code": "maintenance", "name": "Maintenance" } ], "config_templates": [], "sensor_data": [], "timezones": { "Africa/Johannesburg": "Africa/Johannesburg", "UTC": "UTC (GMT+00)" }, "units_of_measurement": [ { "unit": "celsius", "symbol": "\u00b0C", "description": "\u00b0C [Celsius]" }, { "unit": "fahrenheit", "symbol": "\u00b0F", "description": "\u00b0F [Fahrenheit]" }, { "unit": "litre", "symbol": "l", "description": "\u2113 [Litre]" }, { "unit": "gallon_us", "symbol": "gal (US)", "description": "Gallons [US]" }, { "unit": "gallon_uk", "symbol": "gal (UK)", "description": "Gallons [UK]]" }, { "unit": "percent", "symbol": "%", "description": "% [Percentage]" }, { "unit": "psi", "symbol": "psi", "description": "Psi" }, { "unit": "bar", "symbol": "bar", "description": "Bar" }, { "unit": "pascal", "symbol": "Pa", "description": "Pascal" }, { "unit": "rpm", "symbol": "RPM", "description": "RPM" }, { "unit": "count", "symbol": "#", "description": "Count" } ] } } } } } } } }, "/units/basic/edit": { "get": { "tags": [ "Units" ], "summary": "Get Units Basic Edit Form Data", "operationId": "get-units-basic-edit-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string" }, "name": { "type": "string", "nullable": true }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "unit_group_id": { "type": "integer", "format": "int64" }, "unit_group": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" } } } } }, "example": { "data": { "id": 1, "imei": "5551234567890", "serial_no": "65G4423", "name": null, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "unit_group_id": 1, "unit_group": { "id": 1, "name": "Unit Group" }, "unit_type_code": "acmtech", "unit_type_name": "ACMTech", "unit_model_code": "acmtrack_1", "unit_model_name": "ACMTrack v1" } } } } } } } }, "/units/basic": { "get": { "tags": [ "Units" ], "summary": "Get Unit Basic Information", "operationId": "get-unit-basic-information", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string" }, "name": { "type": "string", "nullable": true }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "unit_group_id": { "type": "integer", "format": "int64" }, "unit_group": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" } } } } }, "example": { "data": { "id": 1, "imei": "5551234567890", "serial_no": "65G4423", "name": null, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "unit_group_id": 1, "unit_group": { "id": 1, "name": "Unit Group" }, "unit_type_code": "acmtech", "unit_type_name": "ACMTech", "unit_model_code": "acmtrack_1", "unit_model_name": "ACMTrack v1" } } } } } } } }, "/units/create": { "get": { "tags": [ "Units" ], "summary": "Get Unit Create Form Data", "operationId": "get-unit-create-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "partners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "unit_types": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "unit_models": { "type": "object", "properties": { "acmtech": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "calamp": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "gosafe": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "queclink": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "teltonika": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "gt06": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "wist": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "cobd": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "sigfox": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } } } }, "unit_statuses": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "sensor_data": { "type": "array", "items": {} }, "timezones": { "type": "object", "properties": { "Africa/Johannesburg": { "type": "string" }, "UTC": { "type": "string" } } }, "config_templates": { "type": "array", "items": {} }, "units_of_measurement": { "type": "array", "items": { "type": "object", "properties": { "unit": { "type": "string" }, "symbol": { "type": "string" }, "description": { "type": "string" } } } } } } } }, "example": { "data": { "partners": [ { "id": 1, "name": "Partner Name" } ], "unit_types": [ { "code": "acmtech", "name": "ACMTech" }, { "code": "calamp", "name": "Calamp" }, { "code": "gosafe", "name": "Gosafe" }, { "code": "queclink", "name": "Queclink" }, { "code": "teltonika", "name": "Teltonika" }, { "code": "gt06", "name": "GT06" }, { "code": "wist", "name": "Wist" }, { "code": "cobd", "name": "CObd" }, { "code": "sigfox", "name": "SigFox" } ], "unit_models": { "acmtech": [ { "code": "acmtrack_1", "name": "ACMTrack v1" }, { "code": "acmtrack_2", "name": "ACMTrack v2" } ], "calamp": [ { "code": "atu_620", "name": "ATU-620" }, { "code": "ttu_700", "name": "TTU-720" }, { "code": "ttu_1200", "name": "TTU-1200" }, { "code": "ttu_2830", "name": "TTU-2830" }, { "code": "ttu_2840", "name": "TTU-2840 XTREME" }, { "code": "lmu_200", "name": "LMU-200" }, { "code": "lmu_300", "name": "LMU-300" }, { "code": "lmu_303x", "name": "LMU-303-X" }, { "code": "lmu_400", "name": "LMU-400" }, { "code": "lmu_600", "name": "LMU-600" }, { "code": "lmu_700", "name": "LMU-700" }, { "code": "lmu_800", "name": "LMU-800" }, { "code": "lmu_900", "name": "LMU-900" }, { "code": "lmu_1100", "name": "LMU-1100" }, { "code": "lmu_1200", "name": "LMU-1200" }, { "code": "lmu_2010", "name": "LMU-2010" }, { "code": "lmu_2030", "name": "LMU-2030" }, { "code": "lmu_2100", "name": "LMU-2100" }, { "code": "lmu_2600", "name": "LMU-2600" }, { "code": "lmu_3200", "name": "LMU-3200" }, { "code": "lmu_4200", "name": "LMU-4200" }, { "code": "lmu_4520", "name": "LMU-4250" }, { "code": "lmu_5530", "name": "LMU-5530" }, { "code": "mdt_7p", "name": "MDT-7P" } ], "gosafe": [ { "code": "g1s", "name": "G1S" }, { "code": "g2p", "name": "G2P" }, { "code": "g3a", "name": "G3A" }, { "code": "g3c", "name": "G3C" }, { "code": "g3s", "name": "G3S" }, { "code": "g6s", "name": "G6S" }, { "code": "g7s", "name": "G7S" }, { "code": "g79w", "name": "G79W" } ], "queclink": [ { "code": "gl200", "name": "GL200" }, { "code": "gl300", "name": "GL300" }, { "code": "gl300vc", "name": "GL300VC" }, { "code": "gl300w", "name": "GL300W" }, { "code": "gl500", "name": "GL500" }, { "code": "gl505", "name": "GL505" }, { "code": "gl520", "name": "GL520" }, { "code": "gl3000w", "name": "GL3000W" } ], "teltonika": [ { "code": "fm36m1", "name": "FM36M1" }, { "code": "fm3001", "name": "FM3001" }, { "code": "fm3612", "name": "FM3612" }, { "code": "fm6300", "name": "FM6300" }, { "code": "fmb001", "name": "FMB001" }, { "code": "fmb002", "name": "FMB002" }, { "code": "fmb003", "name": "FMB003" }, { "code": "fmb010", "name": "FMB010" }, { "code": "fmb020", "name": "FMB020" }, { "code": "fmb110", "name": "FMB110" }, { "code": "fmb120", "name": "FMB120" }, { "code": "fmb122", "name": "FMB122" }, { "code": "fmb125", "name": "FMB125" }, { "code": "fmb130", "name": "FMB130" }, { "code": "fmb140", "name": "FMB140" }, { "code": "fmb202", "name": "FMB202" }, { "code": "fmb204", "name": "FMB204" }, { "code": "fmb208", "name": "FMB208" }, { "code": "fmb630", "name": "FMB630" }, { "code": "fmb640", "name": "FMB640" }, { "code": "fmb900", "name": "FMB900" }, { "code": "fmb920", "name": "FMB920" }, { "code": "fmb964", "name": "FMB964" }, { "code": "fmc001", "name": "FMC001" }, { "code": "fmc125", "name": "FMC125" }, { "code": "fmc130", "name": "FMC130" }, { "code": "fmc640", "name": "FMC640" }, { "code": "fmm001", "name": "FMM001" }, { "code": "fmm125", "name": "FMM125" }, { "code": "fmm130", "name": "FMM130" }, { "code": "fmm640", "name": "FMM640" }, { "code": "fmu125", "name": "FMU125" }, { "code": "fmu126", "name": "FMU126" }, { "code": "fmu130", "name": "FMU130" }, { "code": "fmt100", "name": "FMT100" }, { "code": "msp500", "name": "MSP500" }, { "code": "mtb100", "name": "MTB100" }, { "code": "tmt250", "name": "TMT250" } ], "gt06": [ { "code": "gt06", "name": "GT06" } ], "wist": [ { "code": "wist", "name": "Wist" } ], "cobd": [ { "code": "cobd", "name": "CObd" } ], "sigfox": [ { "code": "foxy", "name": "Foxy" } ] }, "unit_statuses": [ { "code": "factory", "name": "Factory" }, { "code": "pre_stock_pending", "name": "Pre-stock Pending" }, { "code": "post_stock_pending", "name": "Post-stock Pending" }, { "code": "ready", "name": "Ready" }, { "code": "pre_active", "name": "Pre-Active" }, { "code": "active", "name": "Active" }, { "code": "maintenance", "name": "Maintenance" } ], "sensor_data": [], "timezones": { "Africa/Johannesburg": "Africa/Johannesburg", "UTC": "UTC (GMT+00)" }, "config_templates": [], "units_of_measurement": [ { "unit": "celsius", "symbol": "\u00b0C", "description": "\u00b0C [Celsius]" }, { "unit": "fahrenheit", "symbol": "\u00b0F", "description": "\u00b0F [Fahrenheit]" }, { "unit": "litre", "symbol": "l", "description": "\u2113 [Litre]" }, { "unit": "gallon_us", "symbol": "gal (US)", "description": "Gallons [US]" }, { "unit": "gallon_uk", "symbol": "gal (UK)", "description": "Gallons [UK]]" }, { "unit": "percent", "symbol": "%", "description": "% [Percentage]" }, { "unit": "psi", "symbol": "psi", "description": "Psi" }, { "unit": "bar", "symbol": "bar", "description": "Bar" }, { "unit": "pascal", "symbol": "Pa", "description": "Pascal" }, { "unit": "rpm", "symbol": "RPM", "description": "RPM" }, { "unit": "count", "symbol": "#", "description": "Count" } ] } } } } } } } }, "/units/edit": { "get": { "tags": [ "Units" ], "summary": "Get Unit Edit From Data", "operationId": "get-unit-edit-from-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "imei": { "type": "integer", "format": "int64" }, "serial_no": { "type": "string" }, "stock_no": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" }, "unit_status_code": { "type": "string" }, "unit_status_name": { "type": "string" }, "unit_group_id": { "type": "integer", "format": "int64" }, "unit_group": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "ignition": { "type": "string" }, "fixed_latitude": { "type": "string", "nullable": true }, "fixed_longitude": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" }, "vehicle": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "assigned_as": { "type": "string" } } }, "timezone": { "type": "string" }, "op_timezone": { "type": "string" }, "user_full_name": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "flags": { "type": "object", "properties": { "ign_connected": { "type": "boolean" }, "allow_geo_lookups": { "type": "boolean" }, "auto_correct_direction": { "type": "boolean" }, "perform_post_processing": { "type": "boolean" }, "post_process_trip_stops": { "type": "boolean" } } }, "system": { "type": "object", "properties": { "idling": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "event_idle_stop": { "type": "string" }, "speed_less_than": { "type": "string" }, "event_idle_start": { "type": "string" } } }, "trip_stop": { "type": "object", "properties": { "time": { "type": "string" }, "event": { "type": "string" }, "enabled": { "type": "boolean" } } }, "trip_start": { "type": "object", "properties": { "event": { "type": "string" }, "speed": { "type": "string" }, "enabled": { "type": "boolean" }, "distance": { "type": "string" } } }, "gps_spiking": { "type": "object", "properties": { "event": { "type": "string" }, "speed": { "type": "string" }, "enabled": { "type": "boolean" } } }, "gps_drifting": { "type": "object", "properties": { "event": { "type": "string" }, "speed": { "type": "string" }, "radius": { "type": "string" }, "enabled": { "type": "boolean" } } }, "comms_failure": { "type": "object", "properties": { "after": { "type": "string" }, "event": { "type": "string" }, "enabled": { "type": "boolean" }, "report_every": { "type": "string" }, "restored_event": { "type": "string" } } }, "faulty_ignition": { "type": "object", "properties": { "event": { "type": "string" }, "enabled": { "type": "boolean" } } } } }, "sensors": { "type": "array", "items": {} }, "standard_inputs": { "type": "array", "items": {} }, "auxiliary_inputs": { "type": "array", "items": {} }, "event_conversions": { "type": "array", "items": {} }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "note": { "type": "string" } } } }, "attachments": { "type": "array", "items": {} }, "photos": { "type": "array", "items": {} }, "partners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "agencies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "unit_types": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "unit_models": { "type": "object", "properties": { "acmtech": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "calamp": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "gosafe": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "queclink": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "teltonika": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "gt06": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "wist": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "cobd": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "sigfox": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } } } }, "unit_statuses": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "config_templates": { "type": "array", "items": {} }, "sensor_data": { "type": "array", "items": {} }, "timezones": { "type": "object", "properties": { "Africa/Johannesburg": { "type": "string" }, "UTC": { "type": "string" } } }, "units_of_measurement": { "type": "array", "items": { "type": "object", "properties": { "unit": { "type": "string" }, "symbol": { "type": "string" }, "description": { "type": "string" } } } } } } } }, "example": { "data": { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "imei": "5551234567890", "serial_no": "65G4423", "stock_no": null, "name": null, "unit_type_code": "acmtech", "unit_type_name": "ACMTech", "unit_model_code": "acmtrack_1", "unit_model_name": "ACMTrack v1", "unit_status_code": "factory", "unit_status_name": "Factory", "unit_group_id": 1, "unit_group": { "id": 1, "name": "Unit Group" }, "ignition": "input_01", "fixed_latitude": null, "fixed_longitude": null, "vehicle_id": 1, "assigned_as": "primary", "vehicle": { "id": 1, "reg_no": "ABC 123 GP", "fleet_no": "5551234", "assigned_as": "primary" }, "timezone": "UTC", "op_timezone": "auto", "user_full_name": "User Name", "user_id": 6, "created_at": "2021-04-22T14:18:11+02:00", "updated_at": "2021-04-23T08:58:12+02:00", "flags": { "ign_connected": true, "allow_geo_lookups": true, "auto_correct_direction": true, "perform_post_processing": true, "post_process_trip_stops": true }, "system": { "idling": { "enabled": true, "event_idle_stop": "ENG_IDLE:STOP", "speed_less_than": "1 kmh", "event_idle_start": "ENG_IDLE:START" }, "trip_stop": { "time": "5 minutes", "event": "TRIP_STOP", "enabled": true }, "trip_start": { "event": "TRIP_START", "speed": "10 kmh", "enabled": true, "distance": "50 meters" }, "gps_spiking": { "event": "GPS_SPIKE", "speed": "250 kmh", "enabled": true }, "gps_drifting": { "event": "GPS_DRIFTING", "speed": "10 kmh", "radius": "50 meters", "enabled": true }, "comms_failure": { "after": "60 seconds", "event": "NO_COMMS", "enabled": true, "report_every": "24 hours", "restored_event": "COMMS_OK" }, "faulty_ignition": { "event": "IGN_FAULTY", "enabled": true } }, "sensors": [], "standard_inputs": [], "auxiliary_inputs": [], "event_conversions": [], "notes": [ { "id": 23, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-22T15:51:01+02:00", "note": "This is an additional note." } ], "attachments": [], "photos": [], "partners": [ { "id": 1, "name": "Partner Name" } ], "agencies": [ { "id": 1, "name": "Agency Name" } ], "clients": [ { "id": 2, "name": "Agency Client Name 2" }, { "id": 1, "name": "Client Name" } ], "unit_types": [ { "code": "acmtech", "name": "ACMTech" }, { "code": "calamp", "name": "Calamp" }, { "code": "gosafe", "name": "Gosafe" }, { "code": "queclink", "name": "Queclink" }, { "code": "teltonika", "name": "Teltonika" }, { "code": "gt06", "name": "GT06" }, { "code": "wist", "name": "Wist" }, { "code": "cobd", "name": "CObd" }, { "code": "sigfox", "name": "SigFox" } ], "unit_models": { "acmtech": [ { "code": "acmtrack_1", "name": "ACMTrack v1" }, { "code": "acmtrack_2", "name": "ACMTrack v2" } ], "calamp": [ { "code": "atu_620", "name": "ATU-620" }, { "code": "ttu_700", "name": "TTU-720" }, { "code": "ttu_1200", "name": "TTU-1200" }, { "code": "ttu_2830", "name": "TTU-2830" }, { "code": "ttu_2840", "name": "TTU-2840 XTREME" }, { "code": "lmu_200", "name": "LMU-200" }, { "code": "lmu_300", "name": "LMU-300" }, { "code": "lmu_303x", "name": "LMU-303-X" }, { "code": "lmu_400", "name": "LMU-400" }, { "code": "lmu_600", "name": "LMU-600" }, { "code": "lmu_700", "name": "LMU-700" }, { "code": "lmu_800", "name": "LMU-800" }, { "code": "lmu_900", "name": "LMU-900" }, { "code": "lmu_1100", "name": "LMU-1100" }, { "code": "lmu_1200", "name": "LMU-1200" }, { "code": "lmu_2010", "name": "LMU-2010" }, { "code": "lmu_2030", "name": "LMU-2030" }, { "code": "lmu_2100", "name": "LMU-2100" }, { "code": "lmu_2600", "name": "LMU-2600" }, { "code": "lmu_3200", "name": "LMU-3200" }, { "code": "lmu_4200", "name": "LMU-4200" }, { "code": "lmu_4520", "name": "LMU-4250" }, { "code": "lmu_5530", "name": "LMU-5530" }, { "code": "mdt_7p", "name": "MDT-7P" } ], "gosafe": [ { "code": "g1s", "name": "G1S" }, { "code": "g2p", "name": "G2P" }, { "code": "g3a", "name": "G3A" }, { "code": "g3c", "name": "G3C" }, { "code": "g3s", "name": "G3S" }, { "code": "g6s", "name": "G6S" }, { "code": "g7s", "name": "G7S" }, { "code": "g79w", "name": "G79W" } ], "queclink": [ { "code": "gl200", "name": "GL200" }, { "code": "gl300", "name": "GL300" }, { "code": "gl300vc", "name": "GL300VC" }, { "code": "gl300w", "name": "GL300W" }, { "code": "gl500", "name": "GL500" }, { "code": "gl505", "name": "GL505" }, { "code": "gl520", "name": "GL520" }, { "code": "gl3000w", "name": "GL3000W" } ], "teltonika": [ { "code": "fm36m1", "name": "FM36M1" }, { "code": "fm3001", "name": "FM3001" }, { "code": "fm3612", "name": "FM3612" }, { "code": "fm6300", "name": "FM6300" }, { "code": "fmb001", "name": "FMB001" }, { "code": "fmb002", "name": "FMB002" }, { "code": "fmb003", "name": "FMB003" }, { "code": "fmb010", "name": "FMB010" }, { "code": "fmb020", "name": "FMB020" }, { "code": "fmb110", "name": "FMB110" }, { "code": "fmb120", "name": "FMB120" }, { "code": "fmb122", "name": "FMB122" }, { "code": "fmb125", "name": "FMB125" }, { "code": "fmb130", "name": "FMB130" }, { "code": "fmb140", "name": "FMB140" }, { "code": "fmb202", "name": "FMB202" }, { "code": "fmb204", "name": "FMB204" }, { "code": "fmb208", "name": "FMB208" }, { "code": "fmb630", "name": "FMB630" }, { "code": "fmb640", "name": "FMB640" }, { "code": "fmb900", "name": "FMB900" }, { "code": "fmb920", "name": "FMB920" }, { "code": "fmb964", "name": "FMB964" }, { "code": "fmc001", "name": "FMC001" }, { "code": "fmc125", "name": "FMC125" }, { "code": "fmc130", "name": "FMC130" }, { "code": "fmc640", "name": "FMC640" }, { "code": "fmm001", "name": "FMM001" }, { "code": "fmm125", "name": "FMM125" }, { "code": "fmm130", "name": "FMM130" }, { "code": "fmm640", "name": "FMM640" }, { "code": "fmu125", "name": "FMU125" }, { "code": "fmu126", "name": "FMU126" }, { "code": "fmu130", "name": "FMU130" }, { "code": "fmt100", "name": "FMT100" }, { "code": "msp500", "name": "MSP500" }, { "code": "mtb100", "name": "MTB100" }, { "code": "tmt250", "name": "TMT250" } ], "gt06": [ { "code": "gt06", "name": "GT06" } ], "wist": [ { "code": "wist", "name": "Wist" } ], "cobd": [ { "code": "cobd", "name": "CObd" } ], "sigfox": [ { "code": "foxy", "name": "Foxy" } ] }, "unit_statuses": [ { "code": "factory", "name": "Factory" }, { "code": "pre_stock_pending", "name": "Pre-stock Pending" }, { "code": "post_stock_pending", "name": "Post-stock Pending" }, { "code": "ready", "name": "Ready" }, { "code": "pre_active", "name": "Pre-Active" }, { "code": "active", "name": "Active" }, { "code": "maintenance", "name": "Maintenance" } ], "config_templates": [], "sensor_data": [], "timezones": { "Africa/Johannesburg": "Africa/Johannesburg", "UTC": "UTC (GMT+00)" }, "units_of_measurement": [ { "unit": "celsius", "symbol": "\u00b0C", "description": "\u00b0C [Celsius]" }, { "unit": "fahrenheit", "symbol": "\u00b0F", "description": "\u00b0F [Fahrenheit]" }, { "unit": "litre", "symbol": "l", "description": "\u2113 [Litre]" }, { "unit": "gallon_us", "symbol": "gal (US)", "description": "Gallons [US]" }, { "unit": "gallon_uk", "symbol": "gal (UK)", "description": "Gallons [UK]]" }, { "unit": "percent", "symbol": "%", "description": "% [Percentage]" }, { "unit": "psi", "symbol": "psi", "description": "Psi" }, { "unit": "bar", "symbol": "bar", "description": "Bar" }, { "unit": "pascal", "symbol": "Pa", "description": "Pascal" }, { "unit": "rpm", "symbol": "RPM", "description": "RPM" }, { "unit": "count", "symbol": "#", "description": "Count" } ] } } } } } } } }, "/units/history": { "get": { "tags": [ "Units" ], "summary": "Get Unit History", "operationId": "get-unit-history", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "user_full_name": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "changes": { "type": "array", "items": {} } } } } } }, "example": { "data": [ { "type": "unit.created", "user_full_name": "Piet Pompies", "user_id": 12, "created_at": "2020-02-27T10:12:51+02:00", "changes": [] }, { "type": "unit.archived", "user_full_name": "Jan Pierawiet", "user_id": 11, "created_at": "2021-06-01T10:12:33+02:00", "changes": { "agency.name": { "from": null, "to": "ACM Technology", "label": "Agency Name" }, "op_timezone": { "from": null, "to": "auto", "label": "OP Timezone" }, "sensors": [], "standard_inputs": [], "auxiliary_inputs": [], "analog_inputs": [], "event_conversions": [] } } ] } } } } } } }, "/units/status/detailed": { "get": { "tags": [ "Units" ], "summary": "Get Unit Comms Status (Detailed)", "operationId": "get-unit-comms-status-detailed", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } }, "description": "Returns the current status of all accessable units." } }, "/units/status/summary/clients": { "get": { "tags": [ "Units" ], "summary": "Get Unit Comms Status Summary (Grouped by Client)", "operationId": "get-unit-comms-status-summary-grouped-by-client", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } }, "description": "Returns the current status of all accessable units." } }, "/units/comms-status/summary/by-clients": { "get": { "tags": [ "Units" ], "summary": "Get Unit Comms Status (By Client)", "operationId": "get-unit-comms-status-by-client", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } }, "description": "Requests a summary of unit communication status for a specific clients. The clients id's can be provided as comma separated values. The returned data contains the total number of units active, inactive, offline or that have never communicated to the server. The totals are updated every 10 minutes." } }, "/units/comms-status/summary/by-agencies/1,2,3": { "get": { "tags": [ "Units" ], "summary": "Get Unit Comms Status (By Agency)", "operationId": "get-unit-comms-status-by-agency", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } }, "description": "Requests a summary of unit communication status for a specific agencies. The agency id's can be provided as comma separated values. The returned data contains the total number of units active, inactive, offline or that have never communicated to the server. The totals are updated every 10 minutes." } }, "/units/comms-status/summary/by-partners/1,2,3": { "get": { "tags": [ "Units" ], "summary": "Get Unit Comms Status (By Partner)", "operationId": "get-unit-comms-status-by-partner", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } }, "description": "Requests a summary of unit communication status for a specific partners. The partner id's can be provided as comma separated values. The returned data contains the total number of units active, inactive, offline or that have never communicated to the server. The totals are updated every 10 minutes." } }, "/units/comms-status/summary/totals": { "get": { "tags": [ "Units" ], "summary": "Get Unit Comms Status Totals", "operationId": "get-unit-comms-status-totals", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } }, "description": "Requests a summary of unit communication status for a specific partners. The partner id's can be provided as comma separated values. The returned data contains the total number of units active, inactive, offline or that have never communicated to the server. The totals are updated every 10 minutes." } }, "/clients": { "get": { "tags": [ "Clients" ], "summary": "Find Client(s)", "operationId": "find-client-s", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "reference_no": { "type": "string", "nullable": true }, "fin_account_no": { "type": "string", "nullable": true }, "fin_sub_account_no": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 3, "name": "Client Name", "reference_no": null, "fin_account_no": null, "fin_sub_account_no": null, "description": null, "partner": { "id": 2, "name": "Partner Name" }, "agency": null, "created_at": "2021-04-22T09:49:19+02:00", "updated_at": null } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 1 } } } } } }, "parameters": [ { "name": "_query", "in": "query", "required": false, "schema": { "type": "string" }, "example": "First Help" } ] } }, "/clients/listing/by-partner/1": { "get": { "tags": [ "Clients" ], "summary": "Clients Listing By Partner", "operationId": "clients-listing-by-partner", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 1, "name": "First Client" }, { "id": 2, "name": "Second Client" } ] } } } } } } }, "/clients/listing/by-agency/1": { "get": { "tags": [ "Clients" ], "summary": "Clients Listing By Agency", "operationId": "clients-listing-by-agency", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 4, "name": "Agency Client Name" } ] } } } } } } }, "/clients/listing/no-agency": { "get": { "tags": [ "Clients" ], "summary": "Clients Listing With No Agency", "operationId": "clients-listing-with-no-agency", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 3, "name": "Client One" }, { "id": 1, "name": "Client Two" }, { "id": 2, "name": "Client Three" } ] } } } } }, "description": "A optional partner id can be added.\nTo search for clients without agency assignment under a specific partner.\n\n```\nhttps://www.dummydomain.com/api/v1/clients/listing/no-agency/[/1]\n```" } }, "/clients/listing": { "get": { "tags": [ "Clients" ], "summary": "Client Listing", "operationId": "client-listing", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 4, "name": "Agency Client Name" }, { "id": 3, "name": "Client Name" } ] } } } } } } }, "/clients/1/contacts": { "get": { "tags": [ "Clients" ], "summary": "Get Client Contacts By Id", "operationId": "get-client-contacts-by-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "contacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "contact_type_id": { "type": "integer", "format": "int64" }, "contact_type_name": { "type": "string" }, "contact_name": { "type": "string" }, "cellphone": { "type": "string" }, "phone_office": { "type": "string", "nullable": true }, "phone_home": { "type": "string", "nullable": true }, "email": { "type": "string" }, "fax": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } } } } } }, "example": { "data": { "contacts": [ { "id": 2, "contact_type_id": 1, "contact_type_name": "Primary Contact", "contact_name": "Client Contact", "cellphone": "555 123 4567", "phone_office": null, "phone_home": null, "email": "client.contact@email.com", "fax": null, "note": null, "created_at": "2021-04-22T10:46:09+02:00", "updated_at": null } ] } } } } } } } }, "/clients/contacts": { "get": { "tags": [ "Clients" ], "summary": "Get Client Contacts", "operationId": "get-client-contacts", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "contact_type_id": { "type": "integer", "format": "int64" }, "contact_type_name": { "type": "string" }, "contact_name": { "type": "string" }, "cellphone": { "type": "string" }, "phone_office": { "type": "string", "nullable": true }, "phone_home": { "type": "string", "nullable": true }, "email": { "type": "string" }, "fax": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "contact_type_id": 1, "contact_type_name": "Primary Contact", "contact_name": "Client Contact", "cellphone": "555 123 4567", "phone_office": null, "phone_home": null, "email": "client.contact@email.com", "fax": null, "note": null, "partner": { "id": 2, "name": "Partner Name" }, "agency": null, "client": { "id": 3, "name": "Client Name" }, "created_at": "2021-04-22T10:45:11+02:00", "updated_at": null } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 2 } } } } } } } }, "/clients/contact-types": { "get": { "tags": [ "Clients" ], "summary": "Get Client Contact Types", "operationId": "get-client-contact-types", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } } } }, "/clients/create": { "get": { "tags": [ "Clients" ], "summary": "Get Client Create Form Data", "operationId": "get-client-create-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "partners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "agencies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "contact_types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "location_types": { "type": "object", "properties": { "office": { "type": "string" }, "branch": { "type": "string" }, "depo": { "type": "string" }, "home": { "type": "string" }, "service_center": { "type": "string" }, "delivery": { "type": "string" }, "installation": { "type": "string" }, "control_room": { "type": "string" } } } } } } }, "example": { "data": { "partners": [ { "id": 1, "name": "Partner Name" } ], "agencies": [ { "id": 1, "name": "Agency Name" } ], "contact_types": [ { "id": 1, "name": "Primary Contact" }, { "id": 2, "name": "Alternative Contact" }, { "id": 3, "name": "Emergency Contact" }, { "id": 4, "name": "Financial Contact" }, { "id": 5, "name": "Installation Contact" }, { "id": 6, "name": "Technical Contact" }, { "id": 7, "name": "Service Center Contact" }, { "id": 8, "name": "Delivery Contact" }, { "id": 9, "name": "Control Room Contact" } ], "location_types": { "office": "Office Address", "branch": "Branch Address", "depo": "Depo Address", "home": "Home Address", "service_center": "Service Center Address", "delivery": "Delivery Address", "installation": "Installation Address", "control_room": "Control Room Address" } } } } } } } } }, "/clients/1/edit": { "get": { "tags": [ "Clients" ], "summary": "Get Client Edit Form Data", "operationId": "get-client-edit-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "reference_no": { "type": "string", "nullable": true }, "fin_account_no": { "type": "string", "nullable": true }, "fin_sub_account_no": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "contact_type_id": { "type": "integer", "format": "int64" }, "contact_type_name": { "type": "string" }, "contact_name": { "type": "string" }, "cellphone": { "type": "string" }, "phone_office": { "type": "string", "nullable": true }, "phone_home": { "type": "string", "nullable": true }, "email": { "type": "string" }, "fax": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } }, "locations": { "type": "array", "items": {} }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "note": { "type": "string" } } } }, "attachments": { "type": "array", "items": {} }, "partners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "agencies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "contact_types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "location_types": { "type": "object", "properties": { "office": { "type": "string" }, "branch": { "type": "string" }, "depo": { "type": "string" }, "home": { "type": "string" }, "service_center": { "type": "string" }, "delivery": { "type": "string" }, "installation": { "type": "string" }, "control_room": { "type": "string" } } } } } } }, "example": { "data": { "id": 1, "name": "Client Name", "reference_no": null, "fin_account_no": null, "fin_sub_account_no": null, "description": null, "partner": { "id": 1, "name": "Partner Name" }, "agency": null, "created_at": "2021-01-25T12:33:14+02:00", "updated_at": null, "contacts": [ { "id": 2, "contact_type_id": 1, "contact_type_name": "Primary Contact", "contact_name": "Client Contact", "cellphone": "555 123 4567", "phone_office": null, "phone_home": null, "email": "client.contact@email.com", "fax": null, "note": null, "created_at": "2021-04-22T10:46:09+02:00", "updated_at": null }, { "id": 3, "contact_type_id": 1, "contact_type_name": "Primary Contact", "contact_name": "Contact Name", "cellphone": "082 5552222", "phone_office": "011 222 2222", "phone_home": "012 222 2222", "email": "contact@email.com", "fax": "011 222 2223", "note": "This is an example note", "created_at": "2021-04-22T11:32:26+02:00", "updated_at": null } ], "locations": [], "notes": [ { "id": 1, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-22T11:27:01+02:00", "note": "This is an example note." } ], "attachments": [], "partners": [ { "id": 1, "name": "Partner Name" } ], "agencies": [ { "id": 1, "name": "Agency Name" } ], "contact_types": [ { "id": 1, "name": "Primary Contact" }, { "id": 2, "name": "Alternative Contact" }, { "id": 3, "name": "Emergency Contact" }, { "id": 4, "name": "Financial Contact" }, { "id": 5, "name": "Installation Contact" }, { "id": 6, "name": "Technical Contact" }, { "id": 7, "name": "Service Center Contact" }, { "id": 8, "name": "Delivery Contact" }, { "id": 9, "name": "Control Room Contact" } ], "location_types": { "office": "Office Address", "branch": "Branch Address", "depo": "Depo Address", "home": "Home Address", "service_center": "Service Center Address", "delivery": "Delivery Address", "installation": "Installation Address", "control_room": "Control Room Address" } } } } } } } } }, "/clients#get-a-client": { "get": { "tags": [ "Clients" ], "summary": "Get a Client", "operationId": "get-a-client", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "reference_no": { "type": "string", "nullable": true }, "fin_account_no": { "type": "string", "nullable": true }, "fin_sub_account_no": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "contact_type_id": { "type": "integer", "format": "int64" }, "contact_type_name": { "type": "string" }, "contact_name": { "type": "string" }, "cellphone": { "type": "integer", "format": "int64" }, "phone_office": { "type": "integer", "format": "int64" }, "phone_home": { "type": "integer", "format": "int64" }, "email": { "type": "string" }, "fax": { "type": "string", "nullable": true }, "note": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } }, "locations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "location_type": { "type": "string" }, "address": { "type": "string" }, "place_id": { "type": "string", "nullable": true }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "note": { "type": "string" } } } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "filename": { "type": "string" }, "description": { "type": "string" }, "size_bytes": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } } } } } }, "example": { "data": { "id": 281, "name": "JASON SCHOEMAN", "reference_no": null, "fin_account_no": null, "fin_sub_account_no": null, "description": null, "partner": { "id": 1, "name": "ACMGroup (Pty) Ltd" }, "agency": { "id": null, "name": null }, "created_at": "2022-04-26T16:27:52+02:00", "updated_at": null, "contacts": [ { "id": 1389, "contact_type_id": 1, "contact_type_name": "Primary Contact", "contact_name": "Jason Schoeman", "cellphone": "0760810777", "phone_office": "0760810777", "phone_home": "0760810777", "email": "jason@schoeman.me", "fax": null, "note": "Only mobile number may be contacted with email.", "created_at": "2025-11-13T12:09:11+02:00", "updated_at": null } ], "locations": [ { "id": 60, "location_type": "office", "address": "17 Hellier St, Barrydale, 6750, South Africa", "place_id": null, "latitude": -33.908394, "longitude": 20.725821, "created_at": "2025-11-13T12:09:49+02:00", "updated_at": null } ], "notes": [ { "id": 665, "user_id": 5, "user_full_name": "Jason #Admin", "created_at": "2025-11-13T12:08:44+02:00", "note": "This is a personal account of Jason Schoeman" } ], "attachments": [ { "id": 46, "user_id": 5, "user_full_name": "Jason #Admin", "url": "https://cdn.filestackcontent.com/dTFvRMAzRjiGHrzySVTZ", "type": "image/jpeg", "filename": "20210509_183700.jpg", "description": "20210509_183700.jpg", "size_bytes": 2696932, "created_at": "2025-11-13T13:30:01+02:00", "updated_at": null } ] } } } } } } } }, "/clients#get-a-client-1": { "get": { "tags": [ "Clients" ], "summary": "Get a Client", "operationId": "get-a-client-1", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The requested resource or operation result." }, "notices": { "type": "array", "items": { "type": "string" }, "description": "Informational messages about a successful operation." }, "pagination": { "type": "object", "description": "Paging metadata (list endpoints)." } } } } } } } } }, "/vehicles": { "get": { "tags": [ "Vehicles" ], "summary": "Find Vehicles", "operationId": "find-vehicles", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "integer", "format": "int64" }, "agency": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "driver_id": { "type": "string", "nullable": true }, "driver": { "type": "string", "nullable": true }, "vehicle_event_profile_id": { "type": "string", "nullable": true }, "vehicle_group_id": { "type": "string", "nullable": true }, "vehicle_group": { "type": "string", "nullable": true }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "icon_name": { "type": "string" }, "vin": { "type": "string", "nullable": true }, "engine_no": { "type": "string", "nullable": true }, "vehicle_make": { "type": "string", "nullable": true }, "vehicle_model": { "type": "string", "nullable": true }, "vehicle_color": { "type": "string", "nullable": true }, "vehicle_year": { "type": "string", "nullable": true }, "odo_veh_km": { "type": "string", "nullable": true }, "odo_gps_km": { "type": "string", "nullable": true }, "service_interval_km": { "type": "string", "nullable": true }, "service_interval_month": { "type": "string", "nullable": true }, "prev_service_km": { "type": "string", "nullable": true }, "next_service_km": { "type": "string", "nullable": true }, "prev_service_date": { "type": "string", "nullable": true }, "next_service_date": { "type": "string", "nullable": true }, "prev_license_date": { "type": "string", "nullable": true }, "license_exp_date": { "type": "string", "nullable": true }, "prev_permit_date": { "type": "string", "nullable": true }, "permit_exp_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "unit_id": { "type": "integer", "format": "int64" }, "unit_assigned_as": { "type": "string" }, "unit_imei": { "type": "integer", "format": "int64" }, "unit_serial_no": { "type": "string" }, "unit_stock_no": { "type": "string", "nullable": true }, "unit_name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string" }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 318, "partner_id": 1, "partner": { "id": 1, "name": "Partner name" }, "agency_id": 1, "agency": { "id": 1, "name": "Agency Name" }, "client_id": 15, "client": { "id": 15, "name": "Client Name" }, "driver_id": null, "driver": null, "vehicle_event_profile_id": null, "vehicle_group_id": null, "vehicle_group": null, "reg_no": "ABC 123 GP", "fleet_no": "5551234", "icon_name": "pin-01-green.svg", "vin": null, "engine_no": null, "vehicle_make": null, "vehicle_model": null, "vehicle_color": null, "vehicle_year": null, "odo_veh_km": null, "odo_gps_km": null, "service_interval_km": null, "service_interval_month": null, "prev_service_km": null, "next_service_km": null, "prev_service_date": null, "next_service_date": null, "prev_license_date": null, "license_exp_date": null, "prev_permit_date": null, "permit_exp_date": null, "created_at": "2020-10-01T09:38:27+02:00", "updated_at": null, "unit_id": 341, "unit_assigned_as": "primary", "unit_imei": "5551234567890", "unit_serial_no": "65G4423", "unit_stock_no": null, "unit_name": null, "unit_type_code": "sigfox", "unit_type_name": "SigFox", "unit_model_code": "foxy", "unit_model_name": "Foxy" } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": "https://www.dummydomain.net/api/v1/vehicles?page=2", "first_item": 1, "last_item": 30 } } } } } } } }, "/vehicles/listing": { "get": { "tags": [ "Vehicles" ], "summary": "Vehicles Listing", "operationId": "vehicles-listing", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" } } } } } }, "example": { "data": [ { "id": 318, "reg_no": "ABC 123 GP", "fleet_no": "5551234" }, { "id": 9, "reg_no": "CBA 321 PG", "fleet_no": "4321555" } ] } } } } } } }, "/vehicles/create": { "get": { "tags": [ "Vehicles" ], "summary": "Get Vehicle Create Form Data", "operationId": "get-vehicle-create-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "driver_id": { "type": "string", "nullable": true }, "driver": { "type": "string", "nullable": true }, "vehicle_event_profile_id": { "type": "string", "nullable": true }, "vehicle_group_id": { "type": "string", "nullable": true }, "vehicle_group": { "type": "string", "nullable": true }, "reg_no": { "type": "string" }, "fleet_no": { "type": "string", "nullable": true }, "icon_name": { "type": "string", "nullable": true }, "vin": { "type": "string", "nullable": true }, "engine_no": { "type": "string", "nullable": true }, "vehicle_make": { "type": "string", "nullable": true }, "vehicle_model": { "type": "string", "nullable": true }, "vehicle_color": { "type": "string", "nullable": true }, "vehicle_year": { "type": "string", "nullable": true }, "odo_veh_km": { "type": "string", "nullable": true }, "odo_gps_km": { "type": "string", "nullable": true }, "service_interval_km": { "type": "string", "nullable": true }, "service_interval_month": { "type": "string", "nullable": true }, "prev_service_km": { "type": "string", "nullable": true }, "next_service_km": { "type": "string", "nullable": true }, "prev_service_date": { "type": "string", "nullable": true }, "next_service_date": { "type": "string", "nullable": true }, "prev_license_date": { "type": "string", "nullable": true }, "license_exp_date": { "type": "string", "nullable": true }, "prev_permit_date": { "type": "string", "nullable": true }, "permit_exp_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "unit_id": { "type": "string", "nullable": true }, "unit_assigned_as": { "type": "string", "nullable": true }, "unit_imei": { "type": "string", "nullable": true }, "unit_serial_no": { "type": "string", "nullable": true }, "unit_stock_no": { "type": "string", "nullable": true }, "unit_name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string", "nullable": true }, "unit_type_name": { "type": "string", "nullable": true }, "unit_model_code": { "type": "string", "nullable": true }, "unit_model_name": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "driver_id": null, "driver": null, "vehicle_event_profile_id": null, "vehicle_group_id": null, "vehicle_group": null, "reg_no": "ABC 123 GP", "fleet_no": null, "icon_name": null, "vin": null, "engine_no": null, "vehicle_make": null, "vehicle_model": null, "vehicle_color": null, "vehicle_year": null, "odo_veh_km": null, "odo_gps_km": null, "service_interval_km": null, "service_interval_month": null, "prev_service_km": null, "next_service_km": null, "prev_service_date": null, "next_service_date": null, "prev_license_date": null, "license_exp_date": null, "prev_permit_date": null, "permit_exp_date": null, "created_at": "2021-02-03T14:33:07+02:00", "updated_at": "2021-04-21T14:50:50+02:00", "unit_id": null, "unit_assigned_as": null, "unit_imei": null, "unit_serial_no": null, "unit_stock_no": null, "unit_name": null, "unit_type_code": null, "unit_type_name": null, "unit_model_code": null, "unit_model_name": null } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 4 } } } } } } } }, "/vehicles/listing/by-client": { "get": { "tags": [ "Vehicles" ], "summary": "Vehicles Option Listing By Client", "operationId": "vehicles-option-listing-by-client", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" } } } } } }, "example": { "data": [ { "id": 1, "reg_no": "ABC 123 GP", "fleet_no": "5551234" } ] } } } } } } }, "/vehicles/maintenance/by-client": { "get": { "tags": [ "Vehicles" ], "summary": "Vehicles Maintenance By Client", "operationId": "vehicles-maintenance-by-client", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" } } } } } }, "example": { "data": [ { "id": 1, "reg_no": "ABC 123 GP", "fleet_no": "5551234" } ] } } } } }, "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": "1381" } ] } }, "/vehicles/maintenance/by-group": { "get": { "tags": [ "Vehicles" ], "summary": "Vehicles Maintenance By Group", "operationId": "vehicles-maintenance-by-group", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" } } } } } }, "example": { "data": [ { "id": 1, "reg_no": "ABC 123 GP", "fleet_no": "5551234" } ] } } } } } } }, "/vehicles/by-client/with-units": { "get": { "tags": [ "Vehicles" ], "summary": "Vehicles Listing By Client (With units)", "operationId": "vehicles-listing-by-client-with-units", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "integer", "format": "int64" }, "agency": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "driver_id": { "type": "string", "nullable": true }, "driver": { "type": "string", "nullable": true }, "vehicle_event_profile_id": { "type": "string", "nullable": true }, "vehicle_group_id": { "type": "string", "nullable": true }, "vehicle_group": { "type": "string", "nullable": true }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "icon_name": { "type": "string" }, "vin": { "type": "string", "nullable": true }, "engine_no": { "type": "string", "nullable": true }, "vehicle_make": { "type": "string", "nullable": true }, "vehicle_model": { "type": "string", "nullable": true }, "vehicle_color": { "type": "string", "nullable": true }, "vehicle_year": { "type": "string", "nullable": true }, "odo_veh_km": { "type": "string", "nullable": true }, "odo_gps_km": { "type": "string", "nullable": true }, "service_interval_km": { "type": "string", "nullable": true }, "service_interval_month": { "type": "string", "nullable": true }, "prev_service_km": { "type": "string", "nullable": true }, "next_service_km": { "type": "string", "nullable": true }, "prev_service_date": { "type": "string", "nullable": true }, "next_service_date": { "type": "string", "nullable": true }, "prev_license_date": { "type": "string", "nullable": true }, "license_exp_date": { "type": "string", "nullable": true }, "prev_permit_date": { "type": "string", "nullable": true }, "permit_exp_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "unit_id": { "type": "integer", "format": "int64" }, "unit_assigned_as": { "type": "string" }, "unit_imei": { "type": "integer", "format": "int64" }, "unit_serial_no": { "type": "string", "nullable": true }, "unit_stock_no": { "type": "string", "nullable": true }, "unit_name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": 1, "agency": { "id": 1, "name": "Agency Name" }, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "driver_id": null, "driver": null, "vehicle_event_profile_id": null, "vehicle_group_id": null, "vehicle_group": null, "reg_no": "ABC 123 GP", "fleet_no": "5551234", "icon_name": "pickup-singlecab-orange.svg", "vin": null, "engine_no": null, "vehicle_make": null, "vehicle_model": null, "vehicle_color": null, "vehicle_year": null, "odo_veh_km": null, "odo_gps_km": null, "service_interval_km": null, "service_interval_month": null, "prev_service_km": null, "next_service_km": null, "prev_service_date": null, "next_service_date": null, "prev_license_date": null, "license_exp_date": null, "prev_permit_date": null, "permit_exp_date": null, "created_at": "2020-02-12T19:46:40+02:00", "updated_at": "2020-04-22T14:35:38+02:00", "unit_id": 1, "unit_assigned_as": "primary", "unit_imei": "5551234567890", "unit_serial_no": null, "unit_stock_no": null, "unit_name": null, "unit_type_code": "teltonika", "unit_type_name": "Teltonika", "unit_model_code": "fmb920", "unit_model_name": "FMB920" } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 1 } } } } } } } }, "/vehicles/by-client": { "get": { "tags": [ "Vehicles" ], "summary": "Vehicles Listing By Client", "operationId": "vehicles-listing-by-client", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "integer", "format": "int64" }, "agency": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "driver_id": { "type": "string", "nullable": true }, "driver": { "type": "string", "nullable": true }, "vehicle_event_profile_id": { "type": "string", "nullable": true }, "vehicle_group_id": { "type": "string", "nullable": true }, "vehicle_group": { "type": "string", "nullable": true }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "icon_name": { "type": "string" }, "vin": { "type": "string", "nullable": true }, "engine_no": { "type": "string", "nullable": true }, "vehicle_make": { "type": "string", "nullable": true }, "vehicle_model": { "type": "string", "nullable": true }, "vehicle_color": { "type": "string", "nullable": true }, "vehicle_year": { "type": "string", "nullable": true }, "odo_veh_km": { "type": "string", "nullable": true }, "odo_gps_km": { "type": "string", "nullable": true }, "service_interval_km": { "type": "string", "nullable": true }, "service_interval_month": { "type": "string", "nullable": true }, "prev_service_km": { "type": "string", "nullable": true }, "next_service_km": { "type": "string", "nullable": true }, "prev_service_date": { "type": "string", "nullable": true }, "next_service_date": { "type": "string", "nullable": true }, "prev_license_date": { "type": "string", "nullable": true }, "license_exp_date": { "type": "string", "nullable": true }, "prev_permit_date": { "type": "string", "nullable": true }, "permit_exp_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "unit_id": { "type": "integer", "format": "int64" }, "unit_assigned_as": { "type": "string" }, "unit_imei": { "type": "integer", "format": "int64" }, "unit_serial_no": { "type": "string", "nullable": true }, "unit_stock_no": { "type": "string", "nullable": true }, "unit_name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": 1, "agency": { "id": 1, "name": "Agency Name" }, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "driver_id": null, "driver": null, "vehicle_event_profile_id": null, "vehicle_group_id": null, "vehicle_group": null, "reg_no": "ABC 123 GP", "fleet_no": "5551234", "icon_name": "pickup-singlecab-orange.svg", "vin": null, "engine_no": null, "vehicle_make": null, "vehicle_model": null, "vehicle_color": null, "vehicle_year": null, "odo_veh_km": null, "odo_gps_km": null, "service_interval_km": null, "service_interval_month": null, "prev_service_km": null, "next_service_km": null, "prev_service_date": null, "next_service_date": null, "prev_license_date": null, "license_exp_date": null, "prev_permit_date": null, "permit_exp_date": null, "created_at": "2020-02-12T19:46:40+02:00", "updated_at": "2020-04-22T14:35:38+02:00", "unit_id": 1, "unit_assigned_as": "primary", "unit_imei": "5551234567890", "unit_serial_no": null, "unit_stock_no": null, "unit_name": null, "unit_type_code": "teltonika", "unit_type_name": "Teltonika", "unit_model_code": "fmb920", "unit_model_name": "FMB920" } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 1 } } } } } } } }, "/vehicles/by-group/ids/with-units": { "get": { "tags": [ "Vehicles" ], "summary": "Vehicles Listing By Group (With Units)", "operationId": "vehicles-listing-by-group-with-units", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "integer", "format": "int64" }, "agency": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "driver_id": { "type": "string", "nullable": true }, "driver": { "type": "string", "nullable": true }, "vehicle_event_profile_id": { "type": "string", "nullable": true }, "vehicle_group_id": { "type": "integer", "format": "int64" }, "vehicle_group": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "icon_name": { "type": "string", "nullable": true }, "vin": { "type": "string", "nullable": true }, "engine_no": { "type": "string", "nullable": true }, "vehicle_make": { "type": "string", "nullable": true }, "vehicle_model": { "type": "string", "nullable": true }, "vehicle_color": { "type": "string", "nullable": true }, "vehicle_year": { "type": "string", "nullable": true }, "odo_veh_km": { "type": "string", "nullable": true }, "odo_gps_km": { "type": "string", "nullable": true }, "service_interval_km": { "type": "string", "nullable": true }, "service_interval_month": { "type": "string", "nullable": true }, "prev_service_km": { "type": "string", "nullable": true }, "next_service_km": { "type": "string", "nullable": true }, "prev_service_date": { "type": "string", "nullable": true }, "next_service_date": { "type": "string", "nullable": true }, "prev_license_date": { "type": "string", "nullable": true }, "license_exp_date": { "type": "string", "nullable": true }, "prev_permit_date": { "type": "string", "nullable": true }, "permit_exp_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "unit_id": { "type": "integer", "format": "int64" }, "unit_assigned_as": { "type": "string" }, "unit_imei": { "type": "integer", "format": "int64" }, "unit_serial_no": { "type": "string", "nullable": true }, "unit_stock_no": { "type": "string", "nullable": true }, "unit_name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 6, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": 1, "agency": { "id": 1, "name": "Agency Name" }, "client_id": 2, "client": { "id": 2, "name": "Client Name" }, "driver_id": null, "driver": null, "vehicle_event_profile_id": null, "vehicle_group_id": 2, "vehicle_group": { "id": 2, "name": "Internal Fleet" }, "reg_no": "ABC 123 GP", "fleet_no": "5551234", "icon_name": null, "vin": null, "engine_no": null, "vehicle_make": null, "vehicle_model": null, "vehicle_color": null, "vehicle_year": null, "odo_veh_km": null, "odo_gps_km": null, "service_interval_km": null, "service_interval_month": null, "prev_service_km": null, "next_service_km": null, "prev_service_date": null, "next_service_date": null, "prev_license_date": null, "license_exp_date": null, "prev_permit_date": null, "permit_exp_date": null, "created_at": "2020-02-27T10:56:12+02:00", "updated_at": "2021-04-21T13:20:49+02:00", "unit_id": 6, "unit_assigned_as": "primary", "unit_imei": "5551234567890", "unit_serial_no": null, "unit_stock_no": null, "unit_name": null, "unit_type_code": "teltonika", "unit_type_name": "Teltonika", "unit_model_code": "fmb125", "unit_model_name": "FMB125" }, { "id": 6, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": 1, "agency": { "id": 1, "name": "Agency Name" }, "client_id": 2, "client": { "id": 2, "name": "Client Name" }, "driver_id": null, "driver": null, "vehicle_event_profile_id": null, "vehicle_group_id": 2, "vehicle_group": { "id": 2, "name": "Internal Fleet" }, "reg_no": "CBA 321 PG", "fleet_no": "5551234", "icon_name": null, "vin": null, "engine_no": null, "vehicle_make": null, "vehicle_model": null, "vehicle_color": null, "vehicle_year": null, "odo_veh_km": null, "odo_gps_km": null, "service_interval_km": null, "service_interval_month": null, "prev_service_km": null, "next_service_km": null, "prev_service_date": null, "next_service_date": null, "prev_license_date": null, "license_exp_date": null, "prev_permit_date": null, "permit_exp_date": null, "created_at": "2020-02-27T10:56:12+02:00", "updated_at": "2021-04-21T13:20:49+02:00", "unit_id": 6, "unit_assigned_as": "backup_1", "unit_imei": "0987654321555", "unit_serial_no": null, "unit_stock_no": null, "unit_name": null, "unit_type_code": "teltonika", "unit_type_name": "Teltonika", "unit_model_code": "fmb125", "unit_model_name": "FMB125" } ] } } } } }, "parameters": [ { "name": "group_ids", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": "2" } ] } }, "/vehicles/by-group/ids": { "get": { "tags": [ "Vehicles" ], "summary": "Vehicles Listing By Group", "operationId": "vehicles-listing-by-group", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "integer", "format": "int64" }, "agency": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "driver_id": { "type": "string", "nullable": true }, "driver": { "type": "string", "nullable": true }, "vehicle_event_profile_id": { "type": "string", "nullable": true }, "vehicle_group_id": { "type": "integer", "format": "int64" }, "vehicle_group": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "icon_name": { "type": "string", "nullable": true }, "vin": { "type": "string", "nullable": true }, "engine_no": { "type": "string", "nullable": true }, "vehicle_make": { "type": "string", "nullable": true }, "vehicle_model": { "type": "string", "nullable": true }, "vehicle_color": { "type": "string", "nullable": true }, "vehicle_year": { "type": "string", "nullable": true }, "odo_veh_km": { "type": "string", "nullable": true }, "odo_gps_km": { "type": "string", "nullable": true }, "service_interval_km": { "type": "string", "nullable": true }, "service_interval_month": { "type": "string", "nullable": true }, "prev_service_km": { "type": "string", "nullable": true }, "next_service_km": { "type": "string", "nullable": true }, "prev_service_date": { "type": "string", "nullable": true }, "next_service_date": { "type": "string", "nullable": true }, "prev_license_date": { "type": "string", "nullable": true }, "license_exp_date": { "type": "string", "nullable": true }, "prev_permit_date": { "type": "string", "nullable": true }, "permit_exp_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "unit_id": { "type": "integer", "format": "int64" }, "unit_assigned_as": { "type": "string" }, "unit_imei": { "type": "integer", "format": "int64" }, "unit_serial_no": { "type": "string", "nullable": true }, "unit_stock_no": { "type": "string", "nullable": true }, "unit_name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 6, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": 1, "agency": { "id": 1, "name": "Agency Name" }, "client_id": 2, "client": { "id": 2, "name": "Client Name" }, "driver_id": null, "driver": null, "vehicle_event_profile_id": null, "vehicle_group_id": 2, "vehicle_group": { "id": 2, "name": "Internal Fleet" }, "reg_no": "ABC 123 GP", "fleet_no": "5551234", "icon_name": null, "vin": null, "engine_no": null, "vehicle_make": null, "vehicle_model": null, "vehicle_color": null, "vehicle_year": null, "odo_veh_km": null, "odo_gps_km": null, "service_interval_km": null, "service_interval_month": null, "prev_service_km": null, "next_service_km": null, "prev_service_date": null, "next_service_date": null, "prev_license_date": null, "license_exp_date": null, "prev_permit_date": null, "permit_exp_date": null, "created_at": "2020-02-27T10:56:12+02:00", "updated_at": "2021-04-21T13:20:49+02:00", "unit_id": 6, "unit_assigned_as": "primary", "unit_imei": "5551234567890", "unit_serial_no": null, "unit_stock_no": null, "unit_name": null, "unit_type_code": "teltonika", "unit_type_name": "Teltonika", "unit_model_code": "fmb125", "unit_model_name": "FMB125" }, { "id": 6, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": 1, "agency": { "id": 1, "name": "Agency Name" }, "client_id": 2, "client": { "id": 2, "name": "Client Name" }, "driver_id": null, "driver": null, "vehicle_event_profile_id": null, "vehicle_group_id": 2, "vehicle_group": { "id": 2, "name": "Internal Fleet" }, "reg_no": "ABC 123 GP", "fleet_no": "POOL VEHICLE", "icon_name": null, "vin": "DEMO12345123", "engine_no": null, "vehicle_make": "GWM", "vehicle_model": "STEED 5", "vehicle_color": "WHITE", "vehicle_year": 2018, "odo_veh_km": null, "odo_gps_km": null, "service_interval_km": null, "service_interval_month": null, "prev_service_km": null, "next_service_km": null, "prev_service_date": null, "next_service_date": null, "prev_license_date": null, "license_exp_date": null, "prev_permit_date": null, "permit_exp_date": null, "created_at": "2020-02-27T10:56:12+02:00", "updated_at": "2021-04-21T13:20:49+02:00", "unit_id": 6, "unit_assigned_as": "backup_1", "unit_imei": "321654987654", "unit_serial_no": "321654987654", "unit_stock_no": "321654987654 - ABC", "unit_name": null, "unit_type_code": "teltonika", "unit_type_name": "Teltonika", "unit_model_code": "fmb125", "unit_model_name": "FMB125" } ] } } } } }, "parameters": [ { "name": "group_ids", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": "2" } ] } }, "/vehicles/with-units": { "get": { "tags": [ "Vehicles" ], "summary": "Vehicles Listing (With Units)", "operationId": "vehicles-listing-with-units", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "integer", "format": "int64" }, "agency": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "driver_id": { "type": "string", "nullable": true }, "driver": { "type": "string", "nullable": true }, "vehicle_event_profile_id": { "type": "string", "nullable": true }, "vehicle_group_id": { "type": "string", "nullable": true }, "vehicle_group": { "type": "string", "nullable": true }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "icon_name": { "type": "string" }, "vin": { "type": "string", "nullable": true }, "engine_no": { "type": "string", "nullable": true }, "vehicle_make": { "type": "string", "nullable": true }, "vehicle_model": { "type": "string", "nullable": true }, "vehicle_color": { "type": "string", "nullable": true }, "vehicle_year": { "type": "string", "nullable": true }, "odo_veh_km": { "type": "string", "nullable": true }, "odo_gps_km": { "type": "string", "nullable": true }, "service_interval_km": { "type": "string", "nullable": true }, "service_interval_month": { "type": "string", "nullable": true }, "prev_service_km": { "type": "string", "nullable": true }, "next_service_km": { "type": "string", "nullable": true }, "prev_service_date": { "type": "string", "nullable": true }, "next_service_date": { "type": "string", "nullable": true }, "prev_license_date": { "type": "string", "nullable": true }, "license_exp_date": { "type": "string", "nullable": true }, "prev_permit_date": { "type": "string", "nullable": true }, "permit_exp_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "unit_id": { "type": "integer", "format": "int64" }, "unit_assigned_as": { "type": "string" }, "unit_imei": { "type": "integer", "format": "int64" }, "unit_serial_no": { "type": "string", "nullable": true }, "unit_stock_no": { "type": "string", "nullable": true }, "unit_name": { "type": "string", "nullable": true }, "unit_type_code": { "type": "string" }, "unit_type_name": { "type": "string" }, "unit_model_code": { "type": "string" }, "unit_model_name": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string" }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 318, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": 1, "agency": { "id": 1, "name": "Agency Name" }, "client_id": 15, "client": { "id": 15, "name": "Client Name" }, "driver_id": null, "driver": null, "vehicle_event_profile_id": null, "vehicle_group_id": null, "vehicle_group": null, "reg_no": "ABC 123 GP", "fleet_no": "5551234", "icon_name": "pin-01-green.svg", "vin": null, "engine_no": null, "vehicle_make": null, "vehicle_model": null, "vehicle_color": null, "vehicle_year": null, "odo_veh_km": null, "odo_gps_km": null, "service_interval_km": null, "service_interval_month": null, "prev_service_km": null, "next_service_km": null, "prev_service_date": null, "next_service_date": null, "prev_license_date": null, "license_exp_date": null, "prev_permit_date": null, "permit_exp_date": null, "created_at": "2020-10-01T09:38:27+02:00", "updated_at": null, "unit_id": 341, "unit_assigned_as": "primary", "unit_imei": "5551234567890", "unit_serial_no": null, "unit_stock_no": null, "unit_name": null, "unit_type_code": "sigfox", "unit_type_name": "SigFox", "unit_model_code": "foxy", "unit_model_name": "Foxy" } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": "https://www.dummydomain.net/api/v1/vehicles/with-units?page=2", "first_item": 1, "last_item": 30 } } } } } } } }, "/vehicles/edit": { "get": { "tags": [ "Vehicles" ], "summary": "Get Vehicle Edit Form Data", "operationId": "get-vehicle-edit-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "driver_id": { "type": "string", "nullable": true }, "driver": { "type": "string", "nullable": true }, "vehicle_event_profile_id": { "type": "string", "nullable": true }, "vehicle_group_id": { "type": "string", "nullable": true }, "vehicle_group": { "type": "string", "nullable": true }, "reg_no": { "type": "string" }, "fleet_no": { "type": "string", "nullable": true }, "icon_name": { "type": "string", "nullable": true }, "vin": { "type": "string", "nullable": true }, "engine_no": { "type": "string", "nullable": true }, "vehicle_make": { "type": "string", "nullable": true }, "vehicle_model": { "type": "string", "nullable": true }, "vehicle_color": { "type": "string", "nullable": true }, "vehicle_year": { "type": "string", "nullable": true }, "odo_veh_km": { "type": "string", "nullable": true }, "odo_gps_km": { "type": "string", "nullable": true }, "service_interval_km": { "type": "string", "nullable": true }, "service_interval_month": { "type": "string", "nullable": true }, "prev_service_km": { "type": "string", "nullable": true }, "next_service_km": { "type": "string", "nullable": true }, "prev_service_date": { "type": "string", "nullable": true }, "next_service_date": { "type": "string", "nullable": true }, "prev_license_date": { "type": "string", "nullable": true }, "license_exp_date": { "type": "string", "nullable": true }, "prev_permit_date": { "type": "string", "nullable": true }, "permit_exp_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "vehicle_status_code": { "type": "string" }, "vehicle_status_name": { "type": "string" }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "note": { "type": "string" } } } }, "attachments": { "type": "array", "items": {} }, "assigned_units": { "type": "array", "items": {} } } } } }, "example": { "data": { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "driver_id": null, "driver": null, "vehicle_event_profile_id": null, "vehicle_group_id": null, "vehicle_group": null, "reg_no": "ABC 123 GP", "fleet_no": null, "icon_name": null, "vin": null, "engine_no": null, "vehicle_make": null, "vehicle_model": null, "vehicle_color": null, "vehicle_year": null, "odo_veh_km": null, "odo_gps_km": null, "service_interval_km": null, "service_interval_month": null, "prev_service_km": null, "next_service_km": null, "prev_service_date": null, "next_service_date": null, "prev_license_date": null, "license_exp_date": null, "prev_permit_date": null, "permit_exp_date": null, "created_at": "2021-02-03T14:33:07+02:00", "updated_at": null, "vehicle_status_code": "active", "vehicle_status_name": "Active", "notes": [ { "id": 1, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-21T14:00:38+02:00", "note": "This is an Postman note." }, { "id": 2, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-21T14:04:33+02:00", "note": "This is an example note." } ], "attachments": [], "assigned_units": [] } } } } } } } }, "/vehicles#get-a-vehicle": { "get": { "tags": [ "Vehicles" ], "summary": "Get a Vehicle", "operationId": "get-a-vehicle", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "partner_id": { "type": "integer", "format": "int64" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency_id": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "client_id": { "type": "integer", "format": "int64" }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "driver_id": { "type": "string", "nullable": true }, "driver": { "type": "string", "nullable": true }, "vehicle_event_profile_id": { "type": "string", "nullable": true }, "vehicle_group_id": { "type": "string", "nullable": true }, "vehicle_group": { "type": "string", "nullable": true }, "reg_no": { "type": "string" }, "fleet_no": { "type": "string", "nullable": true }, "icon_name": { "type": "string", "nullable": true }, "vin": { "type": "string", "nullable": true }, "engine_no": { "type": "string", "nullable": true }, "vehicle_make": { "type": "string", "nullable": true }, "vehicle_model": { "type": "string", "nullable": true }, "vehicle_color": { "type": "string", "nullable": true }, "vehicle_year": { "type": "string", "nullable": true }, "odo_veh_km": { "type": "string", "nullable": true }, "odo_gps_km": { "type": "string", "nullable": true }, "service_interval_km": { "type": "string", "nullable": true }, "service_interval_month": { "type": "string", "nullable": true }, "prev_service_km": { "type": "string", "nullable": true }, "next_service_km": { "type": "string", "nullable": true }, "prev_service_date": { "type": "string", "nullable": true }, "next_service_date": { "type": "string", "nullable": true }, "prev_license_date": { "type": "string", "nullable": true }, "license_exp_date": { "type": "string", "nullable": true }, "prev_permit_date": { "type": "string", "nullable": true }, "permit_exp_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "vehicle_status_code": { "type": "string" }, "vehicle_status_name": { "type": "string" }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "note": { "type": "string" } } } }, "attachments": { "type": "array", "items": {} }, "assigned_units": { "type": "array", "items": {} } } } } }, "example": { "data": { "id": 1, "partner_id": 1, "partner": { "id": 1, "name": "Partner Name" }, "agency_id": null, "agency": null, "client_id": 1, "client": { "id": 1, "name": "Client Name" }, "driver_id": null, "driver": null, "vehicle_event_profile_id": null, "vehicle_group_id": null, "vehicle_group": null, "reg_no": "ABC 123 GP", "fleet_no": null, "icon_name": null, "vin": null, "engine_no": null, "vehicle_make": null, "vehicle_model": null, "vehicle_color": null, "vehicle_year": null, "odo_veh_km": null, "odo_gps_km": null, "service_interval_km": null, "service_interval_month": null, "prev_service_km": null, "next_service_km": null, "prev_service_date": null, "next_service_date": null, "prev_license_date": null, "license_exp_date": null, "prev_permit_date": null, "permit_exp_date": null, "created_at": "2021-02-03T14:33:07+02:00", "updated_at": null, "vehicle_status_code": "active", "vehicle_status_name": "Active", "notes": [ { "id": 1, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-21T14:00:38+02:00", "note": "This is an Postman note." }, { "id": 2, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-21T14:04:33+02:00", "note": "This is an example note." } ], "attachments": [], "assigned_units": [] } } } } } } } }, "/vehicles/primary/telemetry": { "get": { "tags": [ "Vehicles" ], "summary": "Get Vehicle Telemetry", "operationId": "get-vehicle-telemetry", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "telemetry": { "type": "object", "properties": { "gps": { "type": "object", "properties": { "fix": { "type": "array", "items": { "type": "string" } }, "gnss": { "type": "integer", "format": "int64" }, "hdop": { "type": "integer", "format": "int64" }, "pdop": { "type": "integer", "format": "int64" }, "tdop": { "type": "string", "nullable": true }, "vdop": { "type": "string", "nullable": true }, "speed": { "type": "integer", "format": "int64" }, "heading": { "type": "integer", "format": "int64" }, "activity": { "type": "string" }, "altitude": { "type": "integer", "format": "int64" }, "latitude": { "type": "number" }, "odometer": { "type": "string", "nullable": true }, "timezone": { "type": "string" }, "trip_odo": { "type": "integer", "format": "int64" }, "longitude": { "type": "number" }, "timestamp": { "type": "string", "format": "date-time" }, "local_time": { "type": "string", "format": "date-time" }, "satellites": { "type": "integer", "format": "int64" }, "distance_km": { "type": "integer", "format": "int64" } } }, "gsm": { "type": "array", "items": { "type": "object", "properties": { "cid": { "type": "array", "items": {} }, "lac": { "type": "array", "items": {} }, "mcc": { "type": "array", "items": {} }, "mnc": { "type": "array", "items": {} }, "lcid": { "type": "array", "items": {} }, "rcpi": { "type": "array", "items": {} }, "rssi": { "type": "array", "items": {} }, "status": { "type": "array", "items": { "type": "string" } }, "carrier": { "type": "string", "nullable": true }, "data_mode": { "type": "string" }, "signal_lvl": { "type": "integer", "format": "int64" }, "signal_str": { "type": "integer", "format": "int64" } } } }, "ldps": { "type": "object", "properties": { "name": { "type": "string" }, "error": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "error_code": { "type": "string", "nullable": true } } }, "port": { "type": "integer", "format": "int64" }, "sims": { "type": "array", "items": {} }, "valid": { "type": "boolean" }, "device": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "imei": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "type": { "type": "string" }, "model": { "type": "string" }, "status": { "type": "string" }, "firm_ver": { "type": "string", "nullable": true }, "stock_no": { "type": "string", "nullable": true }, "serial_no": { "type": "string", "nullable": true }, "identifier": { "type": "string" }, "assigned_as": { "type": "string", "nullable": true } } }, "driver": { "type": "string", "nullable": true }, "events": { "type": "array", "items": {} }, "inputs": { "type": "integer", "format": "int64" }, "obd_ii": { "type": "object", "properties": { "mode_01": { "type": "array", "items": {} } } }, "seq_no": { "type": "integer", "format": "int64" }, "source": { "type": "string" }, "can_bus": { "type": "array", "items": {} }, "gateway": { "type": "string" }, "network": { "type": "object", "properties": { "mac": { "type": "string", "nullable": true }, "remote_ipv4": { "type": "string" }, "remote_ipv6": { "type": "string", "nullable": true }, "remote_port": { "type": "integer", "format": "int64" } } }, "outputs": { "type": "integer", "format": "int64" }, "sensors": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "vehicle": { "type": "string", "nullable": true }, "buffered": { "type": "boolean" }, "an_inputs": { "type": "array", "items": { "type": "number" } }, "timestamp": { "type": "string", "format": "date-time" }, "aux_inputs": { "type": "array", "items": {} }, "message_ver": { "type": "integer", "format": "int64" }, "message_type": { "type": "string" }, "transmission": { "type": "string" } } } } } } }, "example": { "data": { "telemetry": { "gps": { "fix": [ "fixed" ], "gnss": 1, "hdop": 0, "pdop": 0, "tdop": null, "vdop": null, "speed": 0, "heading": 198, "activity": "unknown", "altitude": 1678, "latitude": -26.439923, "odometer": null, "timezone": "Africa/Johannesburg", "trip_odo": 0, "longitude": 29.475668, "timestamp": "2021-02-09T11:16:53+00:00", "local_time": "2021-02-09T13:16:53+02:00", "satellites": 14, "distance_km": 0 }, "gsm": [ { "cid": [], "lac": [], "mcc": [], "mnc": [], "lcid": [], "rcpi": [], "rssi": [], "status": [ "engine", "network", "data", "connected" ], "carrier": null, "data_mode": "home_stop", "signal_lvl": 4, "signal_str": 80 } ], "ldps": { "name": "www.dummydomain.net", "error": null, "timestamp": "2021-02-09T11:17:42+00:00", "error_code": null }, "port": 5027, "sims": [], "valid": true, "device": { "id": 1, "imei": "359633101461387", "name": null, "type": "teltonika", "model": "acmtrack_1", "status": "factory", "firm_ver": null, "stock_no": null, "serial_no": null, "identifier": "imei", "assigned_as": null }, "driver": null, "events": [], "inputs": "000", "obd_ii": { "mode_01": [] }, "seq_no": 1, "source": "device", "can_bus": [], "gateway": "gateway.dummydomain.net", "network": { "mac": null, "remote_ipv4": "41.206.206.35", "remote_ipv6": null, "remote_port": 58303 }, "outputs": "00", "sensors": [ [ "eco_score", 10 ], [ "speed", 0 ], [ "ebat_volts", 12.254 ], [ "ibat_volts", 4.029 ], [ "ibat_amps", 0 ], [ "trip_odo", 0 ], [ "movement", false ], [ "ignition", "off" ], [ "sleep_mode", "no_sleep" ] ], "vehicle": null, "buffered": false, "an_inputs": [ 0.131 ], "timestamp": "2021-02-09T11:17:42+00:00", "aux_inputs": [], "message_ver": 1, "message_type": "gps", "transmission": "tcp" } } } } } } }, "description": "/primary/ can also be /backup_1/ or /backup_2/" } }, "/vehicles/status/location/by-client": { "get": { "tags": [ "Vehicles" ], "summary": "Get Vehicle Location Status by Client", "operationId": "get-vehicle-location-status-by-client", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "vehicle_make": { "type": "string" }, "vehicle_model": { "type": "string" }, "client_name": { "type": "string" }, "driver_name": { "type": "string" }, "vehicle_group_name": { "type": "string" }, "unit_assigned_as": { "type": "string" }, "local_time": { "type": "string", "format": "date-time" }, "timezone": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "speed": { "type": "integer", "format": "int64" }, "heading": { "type": "integer", "format": "int64" }, "gps_fix": { "type": "array", "items": { "type": "string" } }, "odometer": { "type": "integer", "format": "int64" }, "address": { "type": "string" }, "hours_behind": { "type": "number" }, "comms_status_code": { "type": "string" } } } } } }, "example": { "data": [ { "id": 1, "reg_no": "ABC123GP", "fleet_no": "001", "vehicle_make": "Toyota", "vehicle_model": "Fortuner", "client_name": "ACM Technology", "driver_name": "John Doe", "vehicle_group_name": "Internal Fleet", "unit_assigned_as": "primary", "local_time": "2024-07-24T08:51:07+02:00", "timezone": "Africa/Johannesburg", "latitude": -26.084087, "longitude": 27.937792, "speed": 14, "heading": 351, "gps_fix": [ "fixed" ], "odometer": 12345, "address": "15 Street X, Suburb, City", "hours_behind": 0.01, "comms_status_code": "online" }, { "id": 2, "reg_no": "ABC555GP", "fleet_no": null, "vehicle_make": null, "vehicle_model": null, "client_name": "ACM Technology", "driver_name": null, "vehicle_group_name": "Internal Fleet", "unit_assigned_as": "backup_1", "local_time": "2024-07-24T07:43:12+02:00", "timezone": "Africa/Johannesburg", "latitude": -28.344227, "longitude": 31.298598, "speed": 0, "heading": 25, "gps_fix": [], "odometer": null, "address": "25 Street X, Suburb, City", "hours_behind": 2.6, "comms_status_code": "offline" }, { "id": 3, "reg_no": "DEF321GP", "fleet_no": null, "vehicle_make": null, "vehicle_model": null, "client_name": "ACM Technology", "driver_name": null, "vehicle_group_name": null, "unit_assigned_as": "primary", "local_time": "2024-07-24T08:50:55+02:00", "timezone": "Africa/Johannesburg", "latitude": -26.028498, "longitude": 27.947467, "speed": 120.4, "heading": 227, "gps_fix": [ "fixed" ], "odometer": null, "address": "102 Street X, Suburb, City", "hours_behind": 0.02, "comms_status_code": "online" } ] } } } } }, "description": "Returns the latest location status data for each vehicle under a specific client or clients.\n\nFollowing are two examples for using this request:\n\n1. Returns the location status data for all clients accessable to the user of the API: `/api/v1/vehicles/status/location/by-client/all`\n2. Returns the location status data for the client id `555`. If the user of the API is a client level user, the id will be ignored and only accessable data will be returned: `/api/v1/vehicles/status/location/by-client/555`\n \n\n_Note: If it seems that you are receiving duplicate records it is because a vehicle may be fitted with multiple GPS device/tracking units. In order to only see the data of the primary device (recommended as backup devices often have less data available) you can add the_ `?unit_assigned_as=primary` _filtering parameter, for example_:\n\n```\n/api/v1/vehicles/status/location/by-client/all?unit_assigned_as=primary\n\n ```\n\nThe request returns an array of objects having the following fields:\n\n- `id (int)`: The vehicle's database id.\n- `reg_no (string)`: Vehicle's registration number.\n- `fleet_no (string|null)`: Vehicle's fleet number.\n- `vehicle_make (string|null)`: Vehicle's make.\n- `vehicle_model (string|null)`: Vehicle's model.\n- `client_name (string)`: Client/customer name.\n- `driver_name (string|null)`: Active or assigned Driver name.\n- `vehicle_group_name (string|null)`: Vehicle's group name.\n- `unit_assigned_as (string)`: Can be `primary`, `backup_1, backup_2.`\n- `local_time (ISO 8601 date and time string|null)`: The local time of the GPS recording, local meaning the timezone where the GPS device finds itself in. It can be null if no GPS data has been captured by the device yet.\n- `timezone (string)`: The configured/active timezone of the GPS device.\n- `latitude (float)`: The decimal latitude in degrees.\n- `longitude (float)`: The decimal longitude in degrees.\n- `speed (int|float)`: The current GPS speed in km/h.\n- `heading (int|float)`: The current GPS heading in degrees where 0 = North.\n- `gps_fix (array of strings)`: Can be an empty array or have a combination of the following values: `\"fixed\", \"predicted\", \"diff_corrected\", \"last_known\", \"2d\", \"logged\", \"invalid_time\", \"on_no_fix\", \"sleep\"`. In most cases the array will be empty or only contain `\"on_no_fix\"` if there is no GPS fix.\n- `odometer (int)`: Odometer in meters. This is currently only availble if the GPS device is configured to supply the odometer, returns 0 if no odometer is available.\n- `address (int|null)`: Current address of the vehicle if available.\n- `hours_behind (float)`: Can be used to determine how long ago the device transmitted a GPS location, the device's timezone is taken into account.\n- `comms_status_code (string)`: Current communication status. Can be `\"online\", \"inactive\", \"offline\", \"never\"`.", "parameters": [ { "name": "unit_assigned_as", "in": "query", "required": true, "schema": { "type": "string" }, "example": "primary" } ] } }, "/vehicles/status/location/by-vehicle-group": { "get": { "tags": [ "Vehicles" ], "summary": "Get Vehicle Location Status by Group", "operationId": "get-vehicle-location-status-by-group", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "vehicle_make": { "type": "string" }, "vehicle_model": { "type": "string" }, "client_name": { "type": "string" }, "driver_name": { "type": "string" }, "vehicle_group_name": { "type": "string" }, "unit_assigned_as": { "type": "string" }, "local_time": { "type": "string", "format": "date-time" }, "timezone": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "speed": { "type": "integer", "format": "int64" }, "heading": { "type": "integer", "format": "int64" }, "gps_fix": { "type": "array", "items": { "type": "string" } }, "odometer": { "type": "integer", "format": "int64" }, "address": { "type": "string" }, "hours_behind": { "type": "number" }, "comms_status_code": { "type": "string" } } } } } }, "example": { "data": [ { "id": 1, "reg_no": "ABC123GP", "fleet_no": "001", "vehicle_make": "Toyota", "vehicle_model": "Fortuner", "client_name": "ACM Technology", "driver_name": "John Doe", "vehicle_group_name": "Internal Fleet", "unit_assigned_as": "primary", "local_time": "2024-07-24T08:51:07+02:00", "timezone": "Africa/Johannesburg", "latitude": -26.084087, "longitude": 27.937792, "speed": 14, "heading": 351, "gps_fix": [ "fixed" ], "odometer": 12345, "address": "15 Street X, Suburb, City", "hours_behind": 0.01, "comms_status_code": "online" }, { "id": 2, "reg_no": "ABC555GP", "fleet_no": null, "vehicle_make": null, "vehicle_model": null, "client_name": "ACM Technology", "driver_name": null, "vehicle_group_name": "Internal Fleet", "unit_assigned_as": "backup_1", "local_time": "2024-07-24T07:43:12+02:00", "timezone": "Africa/Johannesburg", "latitude": -28.344227, "longitude": 31.298598, "speed": 0, "heading": 25, "gps_fix": [], "odometer": null, "address": "25 Street X, Suburb, City", "hours_behind": 2.6, "comms_status_code": "offline" }, { "id": 3, "reg_no": "DEF321GP", "fleet_no": null, "vehicle_make": null, "vehicle_model": null, "client_name": "ACM Technology", "driver_name": null, "vehicle_group_name": null, "unit_assigned_as": "primary", "local_time": "2024-07-24T08:50:55+02:00", "timezone": "Africa/Johannesburg", "latitude": -26.028498, "longitude": 27.947467, "speed": 120.4, "heading": 227, "gps_fix": [ "fixed" ], "odometer": null, "address": "102 Street X, Suburb, City", "hours_behind": 0.02, "comms_status_code": "online" } ] } } } } }, "description": "Returns the latest location status data for each vehicle under a specific vehicle group.\n\n_Note: If it seems that you are receiving duplicate records it is because a vehicle may be fitted with multiple GPS device/tracking units. In order to only see the data of the primary device (recommended as backup devices often have less data available) you can add the_ `?unit_assigned_as=primary` _filtering parameter, for example:_\n\n```\n/api/v1/vehicles/status/location/by-client/all?unit_assigned_as=primary\n\n ```\n\nThe request returns an array of objects having the following fields:\n\n- `id (int)`: The vehicle's database id.\n \n- `reg_no (string)`: Vehicle's registration number.\n \n- `fleet_no (string|null)`: Vehicle's fleet number.\n \n- `vehicle_make (string|null)`: Vehicle's make.\n \n- `vehicle_model (string|null)`: Vehicle's model.\n \n- `client_name (string)`: Client/customer name.\n \n- `driver_name (string|null)`: Active or assigned Driver name.\n \n- `vehicle_group_name (string|null)`: Vehicle's group name.\n \n- `unit_assigned_as (string)`: Can be `primary`, `backup_1, backup_2.`\n \n- `local_time (ISO 8601 date and time string|null)`: The local time of the GPS recording, local meaning the timezone where the GPS device finds itself in. It can be null if no GPS data has been captured by the device yet.\n \n- `timezone (string)`: The configured/active timezone of the GPS device.\n \n- `latitude (float)`: The decimal latitude in degrees.\n \n- `longitude (float)`: The decimal longitude in degrees.\n \n- `speed (int|float)`: The current GPS speed in km/h.\n \n- `heading (int|float)`: The current GPS heading in degrees where 0 = North.\n \n- `gps_fix (array of strings)`: Can be an empty array or have a combination of the following values: `\"fixed\", \"predicted\", \"diff_corrected\", \"last_known\", \"2d\", \"logged\", \"invalid_time\", \"on_no_fix\", \"sleep\"`. In most cases the array will be empty or only contain `\"on_no_fix\"` if there is no GPS fix.\n \n- `odometer (int)`: Odometer in meters. This is currently only availble if the GPS device is configured to supply the odometer, returns 0 if no odometer is available.\n \n- `address (int|null)`: Current address of the vehicle if available.\n \n- `hours_behind (float)`: Can be used to determine how long ago the device transmitted a GPS location, the device's timezone is taken into account.\n \n- `comms_status_code (string)`: Current communication status. Can be `\"online\", \"inactive\", \"offline\", \"never\"`.", "parameters": [ { "name": "unit_assigned_as", "in": "query", "required": true, "schema": { "type": "string" }, "example": "primary" } ] } }, "/vehicles/status/trip/by-client": { "get": { "tags": [ "Vehicles" ], "summary": "Get Vehicle Trip Status by Client", "operationId": "get-vehicle-trip-status-by-client", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "vehicle_make": { "type": "string" }, "vehicle_model": { "type": "string" }, "client_name": { "type": "string" }, "driver_name": { "type": "string" }, "vehicle_group_name": { "type": "string" }, "unit_assigned_as": { "type": "string" }, "local_time": { "type": "string", "format": "date-time" }, "timezone": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "speed": { "type": "integer", "format": "int64" }, "heading": { "type": "integer", "format": "int64" }, "gps_fix": { "type": "array", "items": { "type": "string" } }, "odometer": { "type": "integer", "format": "int64" }, "address": { "type": "string" }, "hours_behind": { "type": "number" }, "comms_status_code": { "type": "string" }, "day_trip_no": { "type": "integer", "format": "int64" }, "active_trip": { "type": "object", "properties": { "avg_speed": { "type": "number" }, "max_speed": { "type": "integer", "format": "int64" }, "started_at": { "type": "string", "format": "date-time" }, "distance_km": { "type": "number" }, "start_address": { "type": "string" }, "durations": { "type": "object", "properties": { "total": { "type": "string" }, "engine": { "type": "string" }, "idling": { "type": "string" }, "driving": { "type": "string" }, "speeding": { "type": "string" } } } } } } } } } }, "example": { "data": [ { "id": 1, "reg_no": "ABC123GP", "fleet_no": "001", "vehicle_make": "Toyota", "vehicle_model": "Fortuner", "client_name": "ACM Technology", "driver_name": "John Doe", "vehicle_group_name": "Internal Fleet", "unit_assigned_as": "primary", "local_time": "2024-07-24T08:51:07+02:00", "timezone": "Africa/Johannesburg", "latitude": -26.084087, "longitude": 27.937792, "speed": 14, "heading": 351, "gps_fix": [ "fixed" ], "odometer": 12345, "address": "15 Street X, Suburb, City", "hours_behind": 0.01, "comms_status_code": "online", "day_trip_no": 12, "active_trip": { "avg_speed": 16.637, "max_speed": 27, "started_at": "2024-07-24T08:48:46+02:00", "distance_km": 1.0913, "start_address": "15 Street X, Suburb, City", "durations": { "total": "00:03:39", "engine": "00:03:39", "idling": "00:00:00", "driving": "00:03:39", "speeding": "00:00:00" } } }, { "id": 2, "reg_no": "ABC555GP", "fleet_no": null, "vehicle_make": null, "vehicle_model": null, "client_name": "ACM Technology", "driver_name": null, "vehicle_group_name": "Internal Fleet", "unit_assigned_as": "backup_1", "local_time": "2024-07-24T07:43:12+02:00", "timezone": "Africa/Johannesburg", "latitude": -28.344227, "longitude": 31.298598, "speed": 0, "heading": 25, "gps_fix": [], "odometer": null, "address": "25 Street X, Suburb, City", "hours_behind": 2.6, "comms_status_code": "offline", "day_trip_no": 0, "active_trip": null }, { "id": 3, "reg_no": "DEF321GP", "fleet_no": null, "vehicle_make": null, "vehicle_model": null, "client_name": "ACM Technology", "driver_name": null, "vehicle_group_name": null, "unit_assigned_as": "primary", "local_time": "2024-07-24T08:50:55+02:00", "timezone": "Africa/Johannesburg", "latitude": -26.028498, "longitude": 27.947467, "speed": 120.4, "heading": 227, "gps_fix": [ "fixed" ], "odometer": null, "address": "102 Street X, Suburb, City", "hours_behind": 0.02, "comms_status_code": "online", "day_trip_no": 4, "active_trip": { "avg_speed": 102.45, "max_speed": 136.1, "started_at": "2024-07-24T07:40:00+02:00", "distance_km": 102.311, "start_address": "34 Street X, Suburb, City", "durations": { "total": "01:10:55", "engine": "01:10:55", "idling": "00:03:50", "driving": "01:07:10", "speeding": "00:02:21" } } } ] } } } } }, "description": "Returns the latest location and current trip status data (if trip in progress) for each vehicle under a specific client or clients.\n\nFollowing are two examples for using this request:\n\n1. Returns the location status data for all clients accessable to the user of the API: `/api/v1/vehicles/status/trip/by-client/all`\n2. Returns the location status data for the client id `555`. If the user of the API is a client level user, the id will be ignored and only accessable data will be returned: `/api/v1/vehicles/status/trip/by-client/555`\n \n\n_Note: If it seems that you are receiving duplicate records it is because a vehicle may be fitted with multiple GPS device/tracking units. In order to only see the data of the primary device (recommended as backup devices often have less data available) you can add the_ `?unit_assigned_as=primary` _filtering parameter, for example_:\n\n```\n/api/v1/vehicles/status/location/by-client/all?unit_assigned_as=primary\n\n ```\n\nThe request returns an array of objects having the following fields:\n\n- `id (int)`: The vehicle's database id.\n- `reg_no (string)`: Vehicle's registration number.\n- `fleet_no (string|null)`: Vehicle's fleet number.\n- `vehicle_make (string|null)`: Vehicle's make.\n- `vehicle_model (string|null)`: Vehicle's model.\n- `client_name (string)`: Client/customer name.\n- `driver_name (string|null)`: Active or assigned Driver name.\n- `vehicle_group_name (string|null)`: Vehicle's group name.\n- `unit_assigned_as (string)`: Can be `primary`, `backup_1, backup_2.`\n- `local_time (ISO 8601 date and time string|null)`: The local time of the GPS recording, local meaning the timezone where the GPS device finds itself in. It can be null if no GPS data has been captured by the device yet.\n- `timezone (string)`: The configured/active timezone of the GPS device.\n- `latitude (float)`: The decimal latitude in degrees.\n- `longitude (float)`: The decimal longitude in degrees.\n- `speed (int|float)`: The current GPS speed in km/h.\n- `heading (int|float)`: The current GPS heading in degrees where 0 = North.\n- `gps_fix (array of strings)`: Can be an empty array or have a combination of the following values: `\"fixed\", \"predicted\", \"diff_corrected\", \"last_known\", \"2d\", \"logged\", \"invalid_time\", \"on_no_fix\", \"sleep\"`. In most cases the array will be empty or only contain `\"on_no_fix\"` if there is no GPS fix.\n- `odometer (int)`: Odometer in meters. This is currently only availble if the GPS device is configured to supply the odometer, returns 0 if no odometer is available.\n- `address (int|null)`: Current address of the vehicle if available.\n- `hours_behind (float)`: Can be used to determine how long ago the device transmitted a GPS location, the device's timezone is taken into account.\n- `comms_status_code (string)`: Current communication status. Can be `\"online\", \"inactive\", \"offline\", \"never\"`.\n- day_trip_no (int): The trip number of the day if a trip is active.\n- active_trip (Object|null): The active trip data object if a trip is active, null if no trip is active.\n \n\nThe `active_trip` object contains the following fields and sub-fields:\n\n- `avg_speed (float)`: The average speed of the active trip in km/h.\n \n- `max_speed (float|int)`: The maximum speed in km/h reached during the active trip.\n \n- `started_at (ISO 8601 date and time string|null)`: The local time when the GPS trip started.\n \n- `distance_km (float)`: The distance travelled in the active trip.\n \n- `start_address (string|null)`: The starting address of the active trip.\n \n- `durations (Object)`: The various durations in \"HH:MM:SS\" recorded during the active trip.", "parameters": [ { "name": "unit_assigned_as", "in": "query", "required": true, "schema": { "type": "string" }, "example": "primary" }, { "name": "comms_status_code", "in": "query", "required": true, "schema": { "type": "string" }, "example": "active" } ] } }, "/vehicles/status/trip/by-vehicle-group": { "get": { "tags": [ "Vehicles" ], "summary": "Get Vehicle Trip Status by Group", "operationId": "get-vehicle-trip-status-by-group", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "integer", "format": "int64" }, "vehicle_make": { "type": "string" }, "vehicle_model": { "type": "string" }, "client_name": { "type": "string" }, "driver_name": { "type": "string" }, "vehicle_group_name": { "type": "string" }, "unit_assigned_as": { "type": "string" }, "local_time": { "type": "string", "format": "date-time" }, "timezone": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "speed": { "type": "integer", "format": "int64" }, "heading": { "type": "integer", "format": "int64" }, "gps_fix": { "type": "array", "items": { "type": "string" } }, "odometer": { "type": "integer", "format": "int64" }, "address": { "type": "string" }, "hours_behind": { "type": "number" }, "comms_status_code": { "type": "string" }, "day_trip_no": { "type": "integer", "format": "int64" }, "active_trip": { "type": "object", "properties": { "avg_speed": { "type": "number" }, "max_speed": { "type": "integer", "format": "int64" }, "started_at": { "type": "string", "format": "date-time" }, "distance_km": { "type": "number" }, "start_address": { "type": "string" }, "durations": { "type": "object", "properties": { "total": { "type": "string" }, "engine": { "type": "string" }, "idling": { "type": "string" }, "driving": { "type": "string" }, "speeding": { "type": "string" } } } } } } } } } }, "example": { "data": [ { "id": 1, "reg_no": "ABC123GP", "fleet_no": "001", "vehicle_make": "Toyota", "vehicle_model": "Fortuner", "client_name": "ACM Technology", "driver_name": "John Doe", "vehicle_group_name": "Internal Fleet", "unit_assigned_as": "primary", "local_time": "2024-07-24T08:51:07+02:00", "timezone": "Africa/Johannesburg", "latitude": -26.084087, "longitude": 27.937792, "speed": 14, "heading": 351, "gps_fix": [ "fixed" ], "odometer": 12345, "address": "15 Street X, Suburb, City", "hours_behind": 0.01, "comms_status_code": "online", "day_trip_no": 12, "active_trip": { "avg_speed": 16.637, "max_speed": 27, "started_at": "2024-07-24T08:48:46+02:00", "distance_km": 1.0913, "start_address": "15 Street X, Suburb, City", "durations": { "total": "00:03:39", "engine": "00:03:39", "idling": "00:00:00", "driving": "00:03:39", "speeding": "00:00:00" } } }, { "id": 2, "reg_no": "ABC555GP", "fleet_no": null, "vehicle_make": null, "vehicle_model": null, "client_name": "ACM Technology", "driver_name": null, "vehicle_group_name": "Internal Fleet", "unit_assigned_as": "backup_1", "local_time": "2024-07-24T07:43:12+02:00", "timezone": "Africa/Johannesburg", "latitude": -28.344227, "longitude": 31.298598, "speed": 0, "heading": 25, "gps_fix": [], "odometer": null, "address": "25 Street X, Suburb, City", "hours_behind": 2.6, "comms_status_code": "offline", "day_trip_no": 0, "active_trip": null }, { "id": 3, "reg_no": "DEF321GP", "fleet_no": null, "vehicle_make": null, "vehicle_model": null, "client_name": "ACM Technology", "driver_name": null, "vehicle_group_name": null, "unit_assigned_as": "primary", "local_time": "2024-07-24T08:50:55+02:00", "timezone": "Africa/Johannesburg", "latitude": -26.028498, "longitude": 27.947467, "speed": 120.4, "heading": 227, "gps_fix": [ "fixed" ], "odometer": null, "address": "102 Street X, Suburb, City", "hours_behind": 0.02, "comms_status_code": "online", "day_trip_no": 4, "active_trip": { "avg_speed": 102.45, "max_speed": 136.1, "started_at": "2024-07-24T07:40:00+02:00", "distance_km": 102.311, "start_address": "34 Street X, Suburb, City", "durations": { "total": "01:10:55", "engine": "01:10:55", "idling": "00:03:50", "driving": "01:07:10", "speeding": "00:02:21" } } } ] } } } } }, "description": "Returns the latest location and current active trip status data (if trip in progress) for each vehicle under a specific vehicle group.\n\n_Note: If it seems that you are receiving duplicate records it is because a vehicle may be fitted with multiple GPS device/tracking units. In order to only see the data of the primary device (recommended as backup devices often have less data available) you can add the_ `?unit_assigned_as=primary` _filtering parameter, for example_:\n\n```\n/api/v1/vehicles/status/trip/by-vehicle-group/555?unit_assigned_as=primary\n\n ```\n\nThe request returns an array of objects having the following fields:\n\n- `id (int)`: The vehicle's database id.\n- `reg_no (string)`: Vehicle's registration number.\n- `fleet_no (string|null)`: Vehicle's fleet number.\n- `vehicle_make (string|null)`: Vehicle's make.\n- `vehicle_model (string|null)`: Vehicle's model.\n- `client_name (string)`: Client/customer name.\n- `driver_name (string|null)`: Active or assigned Driver name.\n- `vehicle_group_name (string|null)`: Vehicle's group name.\n- `unit_assigned_as (string)`: Can be `primary`, `backup_1, backup_2.`\n- `local_time (ISO 8601 date and time string|null)`: The local time of the GPS recording, local meaning the timezone where the GPS device finds itself in. It can be null if no GPS data has been captured by the device yet.\n- `timezone (string)`: The configured/active timezone of the GPS device.\n- `latitude (float)`: The decimal latitude in degrees.\n- `longitude (float)`: The decimal longitude in degrees.\n- `speed (int|float)`: The current GPS speed in km/h.\n- `heading (int|float)`: The current GPS heading in degrees where 0 = North.\n- `gps_fix (array of strings)`: Can be an empty array or have a combination of the following values: `\"fixed\", \"predicted\", \"diff_corrected\", \"last_known\", \"2d\", \"logged\", \"invalid_time\", \"on_no_fix\", \"sleep\"`. In most cases the array will be empty or only contain `\"on_no_fix\"` if there is no GPS fix.\n- `odometer (int)`: Odometer in meters. This is currently only availble if the GPS device is configured to supply the odometer, returns 0 if no odometer is available.\n- `address (int|null)`: Current address of the vehicle if available.\n- `hours_behind (float)`: Can be used to determine how long ago the device transmitted a GPS location, the device's timezone is taken into account.\n- `comms_status_code (string)`: Current communication status. Can be `\"online\", \"inactive\", \"offline\", \"never\"`.\n- day_trip_no (int): The trip number of the day if a trip is active.\n- active_trip (Object|null): The active trip data object if a trip is active, null if no trip is active.\n \n\nThe `active_trip` object contains the following fields and sub-fields:\n\n- `avg_speed (float)`: The average speed of the active trip in km/h.\n- `max_speed (float|int)`: The maximum speed in km/h reached during the active trip.\n- `started_at (ISO 8601 date and time string|null)`: The local time when the GPS trip started.\n- `distance_km (float)`: The distance travelled in the active trip.\n- `start_address (string|null)`: The starting address of the active trip.\n- `durations (Object)`: The various durations in \"HH:MM:SS\" recorded during the active trip." } }, "/vehicles/history": { "get": { "tags": [ "Vehicles" ], "summary": "Get Vehicle History", "operationId": "get-vehicle-history", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "user_full_name": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "changes": { "type": "array", "items": {} } } } } } }, "example": { "data": [ { "type": "vehicle.created", "user_full_name": "Piet Pompies", "user_id": 12, "created_at": "2020-02-27T10:56:12+02:00", "changes": [] }, { "type": "vehicle.updated", "user_full_name": "Jan Pierawiet", "user_id": 4, "created_at": "2021-04-21T13:20:49+02:00", "changes": { "vehicle_group_id": { "from": null, "to": 2, "label": "Vehicle Group ID" }, "vehicle_group.id": { "from": null, "to": 2, "label": null }, "vehicle_group.name": { "from": null, "to": "Internal Fleet", "label": null } } } ] } } } } } } }, "/vehicles/groups/listing/by-client/1": { "get": { "tags": [ "Vehicle Groups" ], "summary": "Vehicle Groups Listing By Client", "operationId": "vehicle-groups-listing-by-client", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 1, "name": "Vehicle Group" } ] } } } } } } }, "/vehicles/groups/by-client/1": { "get": { "tags": [ "Vehicle Groups" ], "summary": "Get Vehicle Groups by Client", "operationId": "get-vehicle-groups-by-client", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "name": "Vehicle Group", "partner": { "id": 1, "name": "Partner Name" }, "agency": null, "client": { "id": 1, "name": "Client Name" }, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-21T15:39:01+02:00", "updated_at": null } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 1 } } } } } } } }, "/vehicles/groups/listing": { "get": { "tags": [ "Vehicle Groups" ], "summary": "List Vehicle Groups", "operationId": "list-vehicle-groups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 1, "name": "Vehicle Group" } ] } } } } } } }, "/vehicles/groups/create": { "get": { "tags": [ "Vehicle Groups" ], "summary": "Get Vehicle Groups Create Form Data", "operationId": "get-vehicle-groups-create-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "name": "Vehicle Group", "partner": { "id": 1, "name": "Partner Name" }, "agency": null, "client": { "id": 1, "name": "Client Name" }, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-21T15:39:01+02:00", "updated_at": null } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 1 } } } } } } } }, "/vehicles/groups/1/edit": { "get": { "tags": [ "Vehicle Groups" ], "summary": "Get Vehicle Groups Edit Form Data", "operationId": "get-vehicle-groups-edit-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } } }, "example": { "data": { "id": 1, "name": "Vehicle Group", "partner": { "id": 1, "name": "Partner Name" }, "agency": null, "client": { "id": 1, "name": "Client Name" }, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-21T15:39:01+02:00", "updated_at": null } } } } } } } }, "/vehicles/groups/1": { "get": { "tags": [ "Vehicle Groups" ], "summary": "Get Vehicle Group", "operationId": "get-vehicle-group", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } } }, "example": { "data": { "id": 1, "name": "Vehicle Group", "partner": { "id": 1, "name": "Partner Name" }, "agency": null, "client": { "id": 1, "name": "Client Name" }, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-21T15:39:01+02:00", "updated_at": null } } } } } } } }, "/vehicles/groups": { "get": { "tags": [ "Vehicle Groups" ], "summary": "Find Vehicle Groups", "operationId": "find-vehicle-groups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "name": "Vehicle Group", "partner": { "id": 1, "name": "Partner Name" }, "agency": null, "client": { "id": 1, "name": "Client Name" }, "user_id": 6, "user_full_name": "User Name", "created_at": "2021-04-21T15:39:01+02:00", "updated_at": null } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 1 } } } } } } } }, "/vehicles/expenses/by-client": { "get": { "tags": [ "Vehicle Expenses" ], "summary": "Find Vehicles Expenses", "operationId": "find-vehicles-expenses", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "vehicle_id": { "type": "integer", "format": "int64" }, "vehicle_reg_no": { "type": "string" }, "vehicle_fleet_no": { "type": "string", "nullable": true }, "vehicle_group_id": { "type": "integer", "format": "int64" }, "vehicle_group_name": { "type": "string" }, "expense_type_id": { "type": "integer", "format": "int64" }, "expense_type": { "type": "string" }, "invoice_ref_no": { "type": "string" }, "note": { "type": "string", "nullable": true }, "invoice_date": { "type": "string" }, "unit_count": { "type": "integer", "format": "int64" }, "invoice_total": { "type": "number" }, "tax_deductible": { "type": "boolean" }, "expense_category": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "updated_by_user_id": { "type": "string", "nullable": true }, "updated_by_user_full_name": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "vehicle_id": 1, "vehicle_reg_no": "ABC 123 GP", "vehicle_fleet_no": null, "vehicle_group_id": 2, "vehicle_group_name": "Internal Fleet", "expense_type_id": 1, "expense_type": "Vehicle Repairs Updated", "invoice_ref_no": "abc 000123", "note": null, "invoice_date": "2023-03-30", "unit_count": 2, "invoice_total": 356.34, "tax_deductible": false, "expense_category": "general", "user_id": 1, "user_full_name": "demo.user", "updated_by_user_id": null, "updated_by_user_full_name": null, "created_at": "2023-03-30T18:36:45+02:00", "updated_at": null }, { "id": 3, "vehicle_id": 1, "vehicle_reg_no": "ABC 123 GP", "vehicle_fleet_no": null, "vehicle_group_id": 2, "vehicle_group_name": "Internal Fleet", "expense_type_id": 1, "expense_type": "Vehicle Repairs Updated", "invoice_ref_no": "ABC 000125", "invoice_date": "2023-03-30", "unit_count": 1, "invoice_total": 1044, "tax_deductible": false, "expense_category": "general", "user_id": 1, "user_full_name": "demo.user", "updated_by_user_id": 11, "updated_by_user_full_name": "demo.user", "created_at": "2023-03-30T20:45:03+02:00", "updated_at": "2023-03-30T21:02:25+02:00" } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 2 } } } } } } } }, "/vehicles/expenses/create/client": { "get": { "tags": [ "Vehicle Expenses" ], "summary": "Get Vehicle Expense Create Form Data", "operationId": "get-vehicle-expense-create-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "vehicles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "string" } } } }, "expense_types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } } } }, "example": { "data": { "vehicles": [ { "id": 1, "reg_no": "ABC 123 GP", "fleet_no": "37D05A" }, { "id": 2, "reg_no": "DEF 456 GP", "fleet_no": "37A9F0" }, { "id": 3, "reg_no": "GHI 789 GP", "fleet_no": null } ], "expense_types": [ { "id": 1, "name": "Vehicle Repairs Updated" }, { "id": 2, "name": "Fuel" } ] } } } } } } } }, "/vehicles/expenses/1/edit": { "get": { "tags": [ "Vehicle Expenses" ], "summary": "Get Vehicle Expense Edit Form Data", "operationId": "get-vehicle-expense-edit-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "client_id": { "type": "integer", "format": "int64" }, "vehicle_id": { "type": "integer", "format": "int64" }, "vehicle_reg_no": { "type": "string" }, "vehicle_fleet_no": { "type": "string", "nullable": true }, "vehicle_group_id": { "type": "integer", "format": "int64" }, "vehicle_group_name": { "type": "string" }, "expense_type_id": { "type": "integer", "format": "int64" }, "expense_type": { "type": "string" }, "invoice_ref_no": { "type": "string" }, "note": { "type": "string", "nullable": true }, "invoice_date": { "type": "string" }, "unit_count": { "type": "integer", "format": "int64" }, "invoice_total": { "type": "number" }, "tax_deductible": { "type": "boolean" }, "expense_category": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "updated_by_user_id": { "type": "string", "nullable": true }, "updated_by_user_full_name": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "vehicles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reg_no": { "type": "string" }, "fleet_no": { "type": "string" } } } }, "expense_types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } } } }, "example": { "data": { "id": 1, "client_id": 1, "vehicle_id": 1, "vehicle_reg_no": "ABC 123 GP", "vehicle_fleet_no": null, "vehicle_group_id": 2, "vehicle_group_name": "Internal Fleet", "expense_type_id": 1, "expense_type": "Vehicle Repairs Updated", "invoice_ref_no": "abc 000123", "note": null, "invoice_date": "2023-03-30", "unit_count": 2, "invoice_total": 356.34, "tax_deductible": false, "expense_category": "general", "user_id": 1, "user_full_name": "demo.user", "updated_by_user_id": null, "updated_by_user_full_name": null, "created_at": "2023-03-30T18:36:45+02:00", "updated_at": null, "vehicles": [ { "id": 1, "reg_no": "ABC 123 GP", "fleet_no": "37D05A" }, { "id": 2, "reg_no": "DEF 456 GP", "fleet_no": "37A9F0" }, { "id": 3, "reg_no": "GHI 789 GP", "fleet_no": null } ], "expense_types": [ { "id": 1, "name": "Vehicle Repairs Updated" }, { "id": 2, "name": "Fuel" } ] } } } } } } } }, "/vehicles/expenses/1": { "get": { "tags": [ "Vehicle Expenses" ], "summary": "Get a Vehicle Expense", "operationId": "get-a-vehicle-expense", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "client_id": { "type": "integer", "format": "int64" }, "vehicle_id": { "type": "integer", "format": "int64" }, "vehicle_reg_no": { "type": "string" }, "vehicle_fleet_no": { "type": "string", "nullable": true }, "vehicle_group_id": { "type": "integer", "format": "int64" }, "vehicle_group_name": { "type": "string" }, "expense_type_id": { "type": "integer", "format": "int64" }, "expense_type": { "type": "string" }, "invoice_ref_no": { "type": "string" }, "note": { "type": "string" }, "invoice_date": { "type": "string" }, "unit_count": { "type": "integer", "format": "int64" }, "invoice_total": { "type": "number" }, "tax_deductible": { "type": "boolean" }, "expense_category": { "type": "string" }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "updated_by_user_id": { "type": "string", "nullable": true }, "updated_by_user_full_name": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } } }, "example": { "data": { "id": 1, "client_id": 1, "vehicle_id": 1, "vehicle_reg_no": "ABC 123 GP", "vehicle_fleet_no": null, "vehicle_group_id": 2, "vehicle_group_name": "Internal Fleet", "expense_type_id": 1, "expense_type": "Vehicle Repairs Updated", "invoice_ref_no": "abc 000123", "note": "", "invoice_date": "2023-03-30", "unit_count": 2, "invoice_total": 356.34, "tax_deductible": false, "expense_category": "general", "user_id": 1, "user_full_name": "demo.user", "updated_by_user_id": null, "updated_by_user_full_name": null, "created_at": "2023-03-30T18:36:45+02:00", "updated_at": null } } } } } } } }, "/vehicles/expense/types/by-client": { "get": { "tags": [ "Vehicle Expense Types" ], "summary": "Find Vehicles Expense Types Copy", "operationId": "find-vehicles-expense-types-copy", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "name": "Vehicle Repairs" }, { "id": 2, "name": "Fuel" } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 2 } } } } } } } }, "/vehicles/expense/types/by-client/listing": { "get": { "tags": [ "Vehicle Expense Types" ], "summary": "Vehicle Expense Types Listing", "operationId": "vehicle-expense-types-listing", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 2, "name": "Fuel" }, { "id": 1, "name": "Vehicle Repairs" } ] } } } } } } }, "/vehicles/expense/types/create": { "get": { "tags": [ "Vehicle Expense Types" ], "summary": "Get Vehicle Expense Type Create Form Data", "operationId": "get-vehicle-expense-type-create-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": {} } } }, "example": { "data": [] } } } } } } }, "/vehicles/expense/types/1/edit": { "get": { "tags": [ "Vehicle Expense Types" ], "summary": "Get Vehicle Expense Type Edit Form Data", "operationId": "get-vehicle-expense-type-edit-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } }, "example": { "data": { "id": 1, "name": "Vehicle Repairs" } } } } } } } }, "/vehicles/expense/types/1": { "get": { "tags": [ "Vehicle Expense Types" ], "summary": "Get a Vehicle Expense Type", "operationId": "get-a-vehicle-expense-type", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } }, "example": { "data": { "id": 1, "name": "Vehicle Repairs" } } } } } } } }, "/monitoring/vehicle/primary": { "get": { "tags": [ "Monitoring" ], "summary": "Monitor Vehicle", "operationId": "monitor-vehicle", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "uid": { "type": "integer", "format": "int64" }, "unit_id": { "type": "integer", "format": "int64" }, "unit_name": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "vehicle_reg_no": { "type": "string" }, "vehicle_fleet_no": { "type": "integer", "format": "int64" }, "vehicle_icon_name": { "type": "string", "nullable": true }, "vehicle_group_name": { "type": "string", "nullable": true }, "driver_id": { "type": "string", "nullable": true }, "token": { "type": "string" }, "telemetry": { "type": "string", "nullable": true } } } } }, "example": { "data": { "uid": "5551234567890", "unit_id": 16, "unit_name": null, "vehicle_id": 1, "vehicle_reg_no": "ABC 123 GP", "vehicle_fleet_no": "5551234", "vehicle_icon_name": null, "vehicle_group_name": null, "driver_id": null, "token": "token", "telemetry": null } } } } } } } }, "/monitoring/driver/1": { "get": { "tags": [ "Monitoring" ], "summary": "Monitor Driver", "operationId": "monitor-driver", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "uid": { "type": "integer", "format": "int64" }, "unit_id": { "type": "integer", "format": "int64" }, "unit_name": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "vehicle_reg_no": { "type": "string" }, "vehicle_fleet_no": { "type": "string", "nullable": true }, "vehicle_icon_name": { "type": "string", "nullable": true }, "vehicle_group_name": { "type": "string", "nullable": true }, "driver_id": { "type": "integer", "format": "int64" }, "token": { "type": "string" }, "telemetry": { "type": "string", "nullable": true } } } } }, "example": { "data": { "uid": "5551234567890", "unit_id": 16, "unit_name": null, "vehicle_id": 1, "vehicle_reg_no": "ABC 123 GP", "vehicle_fleet_no": null, "vehicle_icon_name": null, "vehicle_group_name": null, "driver_id": 1, "token": "token", "telemetry": null } } } } } } } }, "/monitoring/unit": { "get": { "tags": [ "Monitoring" ], "summary": "Monitor Unit", "operationId": "monitor-unit", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "uid": { "type": "integer", "format": "int64" }, "unit_id": { "type": "integer", "format": "int64" }, "unit_name": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "vehicle_reg_no": { "type": "string" }, "vehicle_fleet_no": { "type": "string", "nullable": true }, "vehicle_icon_name": { "type": "string", "nullable": true }, "vehicle_group_name": { "type": "string", "nullable": true }, "driver_id": { "type": "string", "nullable": true }, "token": { "type": "string" }, "telemetry": { "type": "string", "nullable": true } } } } }, "example": { "data": { "uid": "5551234567890", "unit_id": 1, "unit_name": null, "vehicle_id": 1, "vehicle_reg_no": "ABC 123 GP", "vehicle_fleet_no": null, "vehicle_icon_name": null, "vehicle_group_name": null, "driver_id": null, "token": "token", "telemetry": null } } } } } } } }, "/monitoring/unit/by-imei": { "get": { "tags": [ "Monitoring" ], "summary": "Monitor Unit By IMEI", "operationId": "monitor-unit-by-imei", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "uid": { "type": "integer", "format": "int64" }, "unit_id": { "type": "integer", "format": "int64" }, "unit_name": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "vehicle_reg_no": { "type": "string" }, "vehicle_fleet_no": { "type": "string", "nullable": true }, "vehicle_icon_name": { "type": "string", "nullable": true }, "vehicle_group_name": { "type": "string", "nullable": true }, "driver_id": { "type": "string", "nullable": true }, "token": { "type": "string" }, "telemetry": { "type": "string", "nullable": true } } } } }, "example": { "data": { "uid": "5551234567890", "unit_id": 1, "unit_name": null, "vehicle_id": 1, "vehicle_reg_no": "ABC 123 GP", "vehicle_fleet_no": null, "vehicle_icon_name": null, "vehicle_group_name": null, "driver_id": null, "token": "token", "telemetry": null } } } } } } } }, "/monitoring/unit/by-serial-no": { "get": { "tags": [ "Monitoring" ], "summary": "Monitor Unit By Serial No", "operationId": "monitor-unit-by-serial-no", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "uid": { "type": "integer", "format": "int64" }, "unit_id": { "type": "integer", "format": "int64" }, "unit_name": { "type": "string", "nullable": true }, "vehicle_id": { "type": "integer", "format": "int64" }, "vehicle_reg_no": { "type": "string" }, "vehicle_fleet_no": { "type": "string", "nullable": true }, "vehicle_icon_name": { "type": "string", "nullable": true }, "vehicle_group_name": { "type": "string", "nullable": true }, "driver_id": { "type": "string", "nullable": true }, "token": { "type": "string" }, "telemetry": { "type": "string", "nullable": true } } } } }, "example": { "data": { "uid": "5551234567890", "unit_id": 1, "unit_name": null, "vehicle_id": 1, "vehicle_reg_no": "ABC 123 GP", "vehicle_fleet_no": null, "vehicle_icon_name": null, "vehicle_group_name": null, "driver_id": null, "token": "token", "telemetry": null } } } } } } } }, "/drivers/listing": { "get": { "tags": [ "Drivers" ], "summary": "Drivers Listing", "operationId": "drivers-listing", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 1, "name": "Driver" } ] } } } } } } }, "/drivers/listing/by-client/1": { "get": { "tags": [ "Drivers" ], "summary": "Drivers Listing By Client", "operationId": "drivers-listing-by-client", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } }, "example": { "data": [ { "id": 1, "name": "Driver" } ] } } } } } } }, "/drivers/create": { "get": { "tags": [ "Drivers" ], "summary": "Get Drivers Create Form Data", "operationId": "get-drivers-create-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "partners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } } } }, "example": { "data": { "partners": [ { "id": 1, "name": "Partner Name" }, { "id": 2, "name": "Next Partner Name" } ] } } } } } } } }, "/drivers/1/edit": { "get": { "tags": [ "Drivers" ], "summary": "Get Drivers Edit Form Data", "operationId": "get-drivers-edit-form-data", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "contact_no": { "type": "string", "nullable": true }, "alt_contact_no": { "type": "string", "nullable": true }, "national_id": { "type": "string", "nullable": true }, "tag_no": { "type": "string", "nullable": true }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "drv_license_prev_date": { "type": "string", "nullable": true }, "drv_license_exp_date": { "type": "string", "nullable": true }, "pdp_license_prev_date": { "type": "string", "nullable": true }, "pdp_license_exp_date": { "type": "string", "nullable": true }, "spc_license_prev_date": { "type": "string", "nullable": true }, "spc_license_exp_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "note": { "type": "string" } } } }, "attachments": { "type": "array", "items": {} }, "photos": { "type": "array", "items": {} }, "partners": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } } } } } } }, "example": { "data": { "id": 1, "name": "Driver", "contact_no": null, "alt_contact_no": null, "national_id": null, "tag_no": null, "partner": { "id": 1, "name": "Partner Name" }, "agency": null, "client": { "id": 1, "name": "Client Name" }, "drv_license_prev_date": null, "drv_license_exp_date": null, "pdp_license_prev_date": null, "pdp_license_exp_date": null, "spc_license_prev_date": null, "spc_license_exp_date": null, "created_at": "2021-04-26T17:35:14+02:00", "updated_at": null, "notes": [ { "id": 1, "user_id": 6, "user_full_name": "User", "created_at": "2021-04-28T12:42:34+02:00", "note": "This is an additional note." } ], "attachments": [], "photos": [], "partners": [ { "id": 3, "name": "Next Partner Name" }, { "id": 1, "name": "Partner Name" } ] } } } } } } } }, "/drivers/1": { "get": { "tags": [ "Drivers" ], "summary": "Get A Driver", "operationId": "get-a-driver", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "contact_no": { "type": "string", "nullable": true }, "alt_contact_no": { "type": "string", "nullable": true }, "national_id": { "type": "string", "nullable": true }, "tag_no": { "type": "string", "nullable": true }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "drv_license_prev_date": { "type": "string", "nullable": true }, "drv_license_exp_date": { "type": "string", "nullable": true }, "pdp_license_prev_date": { "type": "string", "nullable": true }, "pdp_license_exp_date": { "type": "string", "nullable": true }, "spc_license_prev_date": { "type": "string", "nullable": true }, "spc_license_exp_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "user_id": { "type": "integer", "format": "int64" }, "user_full_name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "note": { "type": "string" } } } }, "attachments": { "type": "array", "items": {} }, "photos": { "type": "array", "items": {} } } } } }, "example": { "data": { "id": 1, "name": "Driver", "contact_no": null, "alt_contact_no": null, "national_id": null, "tag_no": null, "partner": { "id": 1, "name": "Partner Name" }, "agency": null, "client": { "id": 1, "name": "Client Name" }, "drv_license_prev_date": null, "drv_license_exp_date": null, "pdp_license_prev_date": null, "pdp_license_exp_date": null, "spc_license_prev_date": null, "spc_license_exp_date": null, "created_at": "2021-04-26T17:35:14+02:00", "updated_at": null, "notes": [ { "id": 1, "user_id": 6, "user_full_name": "User", "created_at": "2021-04-28T12:42:34+02:00", "note": "This is an additional note." } ], "attachments": [], "photos": [] } } } } } } } }, "/drivers": { "get": { "tags": [ "Drivers" ], "summary": "Find Drivers", "operationId": "find-drivers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "contact_no": { "type": "string", "nullable": true }, "alt_contact_no": { "type": "string", "nullable": true }, "national_id": { "type": "string", "nullable": true }, "tag_no": { "type": "string", "nullable": true }, "partner": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "agency": { "type": "string", "nullable": true }, "client": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "drv_license_prev_date": { "type": "string", "nullable": true }, "drv_license_exp_date": { "type": "string", "nullable": true }, "pdp_license_prev_date": { "type": "string", "nullable": true }, "pdp_license_exp_date": { "type": "string", "nullable": true }, "spc_license_prev_date": { "type": "string", "nullable": true }, "spc_license_exp_date": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "nullable": true } } } }, "pagination": { "type": "object", "properties": { "current_page": { "type": "integer", "format": "int64" }, "per_page": { "type": "integer", "format": "int64" }, "prev_page_url": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "first_item": { "type": "integer", "format": "int64" }, "last_item": { "type": "integer", "format": "int64" } } } } }, "example": { "data": [ { "id": 1, "name": "Driver", "contact_no": null, "alt_contact_no": null, "national_id": null, "tag_no": null, "partner": { "id": 1, "name": "Partner Name" }, "agency": null, "client": { "id": 1, "name": "Client Name" }, "drv_license_prev_date": null, "drv_license_exp_date": null, "pdp_license_prev_date": null, "pdp_license_exp_date": null, "spc_license_prev_date": null, "spc_license_exp_date": null, "created_at": "2021-04-26T17:35:14+02:00", "updated_at": null } ], "pagination": { "current_page": 1, "per_page": 30, "prev_page_url": null, "next_page_url": null, "first_item": 1, "last_item": 1 } } } } } } } } } }