### Devices Management: Get Device Details Source: https://gegechkori.ru/hetuvcc/llms-full.txt Retrieves detailed information for a specific device using its ID. ```APIDOC ## Devices Management: Get Device Details ### Description Retrieves detailed information for a specific device using its ID. ### Method GET ### Endpoint `/vehicle-openapi/device/{id}` ### Parameters #### Path Parameters - **id** (Long) - Yes - The ID of the device to retrieve. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. ``` -------------------------------- ### Devices Management: Get Device List Source: https://gegechkori.ru/hetuvcc/llms-full.txt Retrieves a list of devices, optionally filtered by company IDs and online status. ```APIDOC ## Devices Management: Get Device List ### Description Retrieves a list of devices, optionally filtered by company IDs and online status. ### Method POST ### Endpoint `/vehicle-openapi/device/list` ### Parameters #### Request Body - **companyIds** (array) - No - List of company IDs to filter by. - **onlineStatus** (Integer) - No - Filter by online status. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. ``` -------------------------------- ### Devices Management: Get Online Status of Device Source: https://gegechkori.ru/hetuvcc/llms-full.txt Retrieves the online status of a specific device. ```APIDOC ## Devices Management: Get Online Status of Device ### Description Retrieves the online status of a specific device. ### Method GET ### Endpoint `/vehicle-openapi/device/onlineStatus` ### Parameters #### Query Parameters - **deviceNum** (String) - Yes - The device number. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. ``` -------------------------------- ### Warning Message: Get Real-time Vehicle Alarm Source: https://gegechkori.ru/hetuvcc/llms-full.txt Retrieves real-time vehicle alarms. ```APIDOC ## Warning Message: Get Real-time Vehicle Alarm ### Description Retrieves real-time vehicle alarms. ### Method GET ### Endpoint `/vehicle-openapi/alarm/realtime/list` ### Parameters #### Query Parameters - **licenseNum** (String) - Yes - License number of the vehicle. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. ``` -------------------------------- ### Get Latest Vehicle Position Source: https://gegechkori.ru/hetuvcc/llms-full.txt GET request to retrieve the real-time latest position of a vehicle. Requires licenseNum. Optional parameters include geoAddress and toMap. ```http GET /vehicle-openapi/position/realtime/latestPosition?licenseNum=string required&geoAddress=string no&toMap=integer no HTTP/1.1 ``` -------------------------------- ### Get Vehicle Mileage Report Source: https://gegechkori.ru/hetuvcc/llms-full.txt GET request to retrieve a vehicle's mileage report within a specified time range. Requires licenseNum, startTime, and endTime. ```http GET /vehicle-openapi/position/vehicle/report?licenseNum=string required&startTime=string required&endTime=string required HTTP/1.1 ``` -------------------------------- ### Active Safety: Get Vehicle Alarm Attachments Source: https://gegechkori.ru/hetuvcc/llms-full.txt Retrieves attachments for vehicle alarms. ```APIDOC ## Active Safety: Get Vehicle Alarm Attachments ### Description Retrieves attachments for vehicle alarms. ### Method GET ### Endpoint `/vehicle-openapi/alarm/file/list` ### Parameters #### Query Parameters - **licenseNum** (String) - Yes - License number of the vehicle. - **startTime** (String) - Yes - Start time for the query. - **endTime** (String) - Yes - End time for the query. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. ``` -------------------------------- ### Acquire Vehicle Historical Track Source: https://gegechkori.ru/hetuvcc/llms-full.txt GET request to retrieve a vehicle's historical track data. Requires licenseNum, startTime, and endTime. Optional parameters for filtering by drivingState, positioningStatus, and reportingType. ```http GET /vehicle-openapi/position/locus/list?licenseNum=string required&startTime=string required&endTime=string required&drivingState=boolean no&positioningStatus=boolean no&reportingType=boolean no HTTP/1.1 ``` -------------------------------- ### Authenticate and Login with cURL Source: https://gegechkori.ru/hetuvcc/llms-full.txt Use this pattern to authenticate with the API by sending your application credentials. ```bash curl -X POST "https://api.hetuv2x.com/vehicle-openapi/sys/login" -H "Content-Type: application/json" -d "{\"appCid\":\"APP_CID\",\"appSecret\":\"APP_SECRET\"}" ``` -------------------------------- ### Get Vehicle GPS Status Source: https://gegechkori.ru/hetuvcc/llms-full.txt GET request to obtain the current GPS status of a vehicle. Requires licenseNum. ```http GET /vehicle-openapi/position/realtime/vehicleGps?licenseNum=string required HTTP/1.1 ``` -------------------------------- ### Active Safety: Get Vehicle Safety Alarm Source: https://gegechkori.ru/hetuvcc/llms-full.txt Retrieves a list of vehicle safety alarms. Supports both GET and POST methods. ```APIDOC ## Active Safety: Get Vehicle Safety Alarm ### Description Retrieves a list of vehicle safety alarms. ### Method GET, POST ### Endpoint `/vehicle-openapi/alarm/asAlarm/list` ### Parameters #### Query Parameters - **licenseNum** (String) - Yes - License number of the vehicle. - **startTime** (String) - Yes - Start time for the query. - **endTime** (String) - Yes - End time for the query. - **solveStatus** (Integer) - No - Filter by solve status. - **alarmType** (Integer) - No - Filter by alarm type. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. ``` -------------------------------- ### Devices Management: Add New Device Source: https://gegechkori.ru/hetuvcc/llms-full.txt Adds a new device to the system. ```APIDOC ## Devices Management: Add New Device ### Description Adds a new device to the system. ### Method POST ### Endpoint `/vehicle-openapi/device/create` ### Parameters #### Request Body - **deviceNum** (String) - Yes - Device number. - **companyId** (Long) - Yes - Company ID. - **deviceType** (Integer) - Yes - Device type. - **deviceFactory** (String) - No - Device factory. - **deviceSerial** (String) - No - Device serial number. - **deviceBrand** (String) - No - Device brand. - **remark** (String) - No - Remarks for the device. - **moveStatus** (Integer) - No - Move status. - **physicalChannel** (Integer) - No - Physical channel. - **terminalModel** (String) - No - Terminal model. - **terminalType** (Integer) - No - Terminal type. - **useStatus** (Integer) - No - Usage status. ``` -------------------------------- ### Historical Replay - FTP File Upload Source: https://gegechkori.ru/hetuvcc/llms-full.txt Initiates an FTP upload for video files. ```APIDOC ## POST /vehicle-openapi/historyreplay/video/upload ### Description Uploads video files via FTP. ### Method POST ### Endpoint /vehicle-openapi/historyreplay/video/upload ### Headers - Content-Type: application/json ### Request Body - **simNum** (String) - Required - SIM card number. - **channelNum** (Integer) - Required - Channel number. - **startTime** (String) - Required - Start time of the video (e.g., YYYY-MM-DD HH:MM:SS). - **endTime** (String) - Required - End time of the video (e.g., YYYY-MM-DD HH:MM:SS). - **resourceType** (Integer) - Required - Type of resource. - **storageType** (Integer) - Required - Type of storage. - **streamType** (Integer) - Required - Type of stream. - **videoDuration** (Long) - Required - Duration of the video in seconds. - **videoSize** (Long) - Required - Size of the video file in bytes. - **alarmType** (String) - Optional - Type of alarm. ``` -------------------------------- ### Historical Replay - Play Video Files Source: https://gegechkori.ru/hetuvcc/llms-full.txt Initiates playback for historical video files. ```APIDOC ## POST /vehicle-openapi/historyreplay/playback/video/play ### Description Starts playback of historical video files. ### Method POST ### Endpoint /vehicle-openapi/historyreplay/playback/video/play ### Headers - Content-Type: application/json ### Request Body - **channelNum** (Integer) - Required - Channel number. - **licenseNum** (String) - Optional - License plate number. - **deviceNum** (String) - Optional - Device number. - **startTime** (String) - Required - Start time for playback (e.g., YYYY-MM-DD HH:MM:SS). - **endTime** (String) - Required - End time for playback (e.g., YYYY-MM-DD HH:MM:SS). - **resourceType** (Integer) - Required - Type of resource. - **streamType** (Integer) - Required - Type of stream. - **storageType** (Integer) - Required - Type of storage. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data, details specified in a separate table. ``` -------------------------------- ### Historical Replay - Media File Query Source: https://gegechkori.ru/hetuvcc/llms-full.txt Queries for media files based on various criteria. ```APIDOC ## POST /vehicle-openapi/historyreplay/media/file ### Description Queries for media files, allowing filtering by license plate, device, time range, and file type. ### Method POST ### Endpoint /vehicle-openapi/historyreplay/media/file ### Headers - Content-Type: application/json ### Request Body - **licenseNum** (String) - Optional - License plate number. - **deviceNum** (String) - Optional - Device number. - **startTime** (String) - Required - Start time for the query (e.g., YYYY-MM-DD HH:MM:SS). - **endTime** (String) - Required - End time for the query (e.g., YYYY-MM-DD HH:MM:SS). - **alarmType** (String) - Optional - Type of alarm. - **fileType** (Integer) - Required - Type of file. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data, details specified in a separate table. ``` -------------------------------- ### Historical Replay - Download Video Files Source: https://gegechkori.ru/hetuvcc/llms-full.txt Downloads a specific historical video file. ```APIDOC ## GET /vehicle-openapi/historyreplay/download ### Description Downloads a historical video file using its file path. ### Method GET ### Endpoint /vehicle-openapi/historyreplay/download ### Query Parameters - **filePath** (String) - Required - The path to the video file to download. ``` -------------------------------- ### WebSocket Push API Source: https://gegechkori.ru/hetuvcc/llms-full.txt Establishes a WebSocket connection for real-time data pushes. ```APIDOC ## WEBSOCKET /vehicleWs/{username}/{token}/{language} ### Description Establishes a WebSocket connection for receiving real-time vehicle data and alerts. ### Method websocket ### Endpoint `/vehicleWs/{username}/{token}/{language}` ### Parameters #### Path Parameters - **username** (String) - Yes - The username for authentication. - **token** (String) - Yes - The authentication token. - **language** (String) - Yes - The language code for the connection. #### Request Body (for subscription/heartbeat messages) - **messageType** (String) - Yes - Type of message. Options: `subscribe`, `heartBeat`. - **dataTypes** (Array) - Yes - Array of data types to subscribe to. Options: `vehicleCommonAlarm`, `vehicleActiveSafeAlarm`, `vehicleBaseInfo`, `vehicleAlarmFile`, `driverEntryExitRegistration`, `vehicleOnlineList` (only when `messageType` is `subscribe`). - **vehicleOnlineInterval** (Integer) - No - Push online vehicle time interval (sent when `messageType` is `subscribe`). - **timestamp** (Long) - Yes - Client timestamp (sent when `messageType` is `heartBeat`). ``` -------------------------------- ### Historical Replay - FTP Upload List Query Source: https://gegechkori.ru/hetuvcc/llms-full.txt Queries a list of FTP uploaded files. ```APIDOC ## POST /vehicle-openapi/historyreplay/list ### Description Retrieves a list of files that have been uploaded via FTP. ### Method POST ### Endpoint /vehicle-openapi/historyreplay/list ### Headers - Content-Type: application/json ### Request Body - **deviceNum** (String) - Required - Device number. - **startTime** (String) - Required - Start time for the query (e.g., YYYY-MM-DD HH:MM:SS). - **endTime** (String) - Required - End time for the query (e.g., YYYY-MM-DD HH:MM:SS). - **pageNum** (Integer) - Required - Page number for pagination. - **pageSize** (Integer) - Required - Number of items per page. - **alarmType** (String) - Optional - Type of alarm. - **fileType** (Integer) - Optional - Type of file. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data, details specified in a separate table. ``` -------------------------------- ### Historical Replay - Record File Query Source: https://gegechkori.ru/hetuvcc/llms-full.txt Queries a list of historical record files. ```APIDOC ## POST /vehicle-openapi/historyreplay/video/fileList ### Description Queries a list of historical record files, similar to querying video files. ### Method POST ### Endpoint /vehicle-openapi/historyreplay/video/fileList ### Headers - Content-Type: application/json ### Request Body - **location** (Integer) - Required - Location identifier. - **licenseNum** (String) - Required - License plate number. - **startTime** (String) - Required - Start time for the query (e.g., YYYY-MM-DD HH:MM:SS). - **endTime** (String) - Required - End time for the query (e.g., YYYY-MM-DD HH:MM:SS). - **resourceType** (Integer) - Required - Type of resource. - **streamType** (Integer) - Required - Type of stream. - **storageType** (Integer) - Required - Type of storage. - **alarmType** (String) - Optional - Type of alarm. - **channelNum** (Integer) - Optional - Channel number. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data, details specified in a separate table. ``` -------------------------------- ### Historical Replay - Query Video File Source: https://gegechkori.ru/hetuvcc/llms-full.txt Queries a list of historical video files based on specified criteria. ```APIDOC ## POST /vehicle-openapi/historyreplay/playback/video/list ### Description Queries historical video files based on location, time range, and resource type. ### Method POST ### Endpoint /vehicle-openapi/historyreplay/playback/video/list ### Headers - Content-Type: application/json ### Request Body - **location** (Integer) - Required - Location identifier. - **licenseNum** (String) - Required - License plate number. - **startTime** (String) - Required - Start time for the query (e.g., YYYY-MM-DD HH:MM:SS). - **endTime** (String) - Required - End time for the query (e.g., YYYY-MM-DD HH:MM:SS). - **resourceType** (Integer) - Required - Type of resource. - **streamType** (Integer) - Required - Type of stream. - **storageType** (Integer) - Required - Type of storage. - **alarmType** (String) - Optional - Type of alarm. - **channelNum** (Integer) - Optional - Channel number. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data, details specified in a separate table. ``` -------------------------------- ### Historical Replay - Upload Status Query of FTP Source: https://gegechkori.ru/hetuvcc/llms-full.txt Queries the upload status of FTP files. ```APIDOC ## POST /vehicle-openapi/historyreplay/upload/status ### Description Checks the status of previously initiated FTP uploads. ### Method POST ### Endpoint /vehicle-openapi/historyreplay/upload/status ### Headers - Content-Type: application/json ### Request Body - **fileIds** (array) - Required - A list of file IDs for which to query the status. ``` -------------------------------- ### Video Monitoring - Real Time Video Source: https://gegechkori.ru/hetuvcc/llms-full.txt Obtain a real-time video stream URL for a vehicle. This URL needs to be requested before each video playback session. ```APIDOC ## GET /vehicle-openapi/video/monitor/realtimeUrl ### Description Retrieves the URL for real-time video streaming from a vehicle. ### Method GET ### Endpoint /vehicle-openapi/video/monitor/realtimeUrl ### Query Parameters - **licenseNum** (String) - Optional - License plate number of the vehicle. - **deviceNum** (String) - Optional - Device number of the vehicle. - **mediaType** (Integer) - Required - Type of media. - **channelNum** (Integer) - Required - Channel number. - **streamType** (Integer) - Required - Type of stream. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (String) - Return data, video URL path. ``` -------------------------------- ### Geofence - Zone Management API Source: https://gegechkori.ru/hetuvcc/llms-full.txt APIs for managing geofence zones, including creating, updating, deleting, and querying zones and their associated records. ```APIDOC ## POST /vehicle-openapi/electronicFence/fence/batch/order/record ### Description Repushes geofence zone records. This endpoint is deprecated. ### Method POST ### Endpoint /vehicle-openapi/electronicFence/fence/batch/order/record ### Parameters #### Query Parameters - **recordIds** (String) - Required - IDs of the records to repush. #### Request Body - **timeLimit** (Integer) - Required - Time limit for the record. - **effectTime** (Integer) - Required - Effect time for the record. - **maxSpeed** (Integer) - Required - Maximum speed allowed. - **duration** (Integer) - Required - Duration of the record. - **nightMaxSpeed** (Integer) - Required - Maximum speed allowed at night. - **speedLimit** (Integer) - Required - Speed limit. - **enterReceive** (Integer) - Required - Notification setting for entering the zone. - **outReceive** (Integer) - Required - Notification setting for exiting the zone. - **openDoor** (Integer) - Required - Setting for door opening notification. - **communication** (Integer) - Required - Communication setting. - **collectCnss** (Integer) - Required - Setting for collecting CNSS data. - **orderType** (Integer) - Required - Type of order. ### Response #### Success Response (200) - **message** (String) - Success message. #### Response Example { "message": "Operation successful" } ``` ```APIDOC ## POST /vehicle-openapi/electronicFence/fence/list/record ### Description Queries geofence records with pagination and filtering options. ### Method POST ### Endpoint /vehicle-openapi/electronicFence/fence/list/record ### Parameters #### Query Parameters - **pageNum** (Integer) - Optional - Page number for pagination. - **pageSize** (Integer) - Optional - Number of records per page. #### Request Body - **fenceType** (Integer) - Optional - Type of fence. - **orderStatus** (Integer) - Optional - Status of the order. - **orderType** (String) - Optional - Type of order. - **vehicleIds** (Array) - Optional - List of vehicle IDs to filter by. ### Response #### Success Response (200) - **list** (Array) - List of geofence records. - **total** (Integer) - Total number of records. #### Response Example { "list": [ { "id": 1, "fenceType": 1, "orderStatus": 0, "orderType": "string", "vehicleIds": [101, 102] } ], "total": 100 } ``` ```APIDOC ## POST /vehicle-openapi/electronicFence/fence/batch/delete ### Description Deletes multiple geofence zones by their IDs. ### Method POST ### Endpoint /vehicle-openapi/electronicFence/fence/batch/delete ### Parameters #### Request Body - **ids** (Long) - Required - Comma-separated string of zone IDs to delete. ### Response #### Success Response (200) - **message** (String) - Success message. #### Response Example { "message": "Zones deleted successfully" } ``` ```APIDOC ## POST /vehicle-openapi/electronicFence/fence/list ### Description Queries geofence zones with pagination and various filtering criteria. ### Method POST ### Endpoint /vehicle-openapi/electronicFence/fence/list ### Parameters #### Query Parameters - **pageNum** (Integer) - Optional - Page number for pagination. - **pageSize** (Integer) - Optional - Number of records per page. #### Request Body - **typeId** (Long) - Optional - Type ID of the zone. - **regionType** (Integer) - Optional - Type of the region. - **companyId** (Long) - Optional - Company ID. - **entryType** (Integer) - Optional - Type of entry. - **type** (Integer) - Required - Type of the fence. ### Response #### Success Response (200) - **list** (Array) - List of geofence zones. - **total** (Integer) - Total number of zones. #### Response Example { "list": [ { "id": 1, "typeId": 10, "regionType": 1, "companyId": 100, "entryType": 1, "type": 1 } ], "total": 50 } ``` ```APIDOC ## POST /vehicle-openapi/electronicFence/region/create ### Description Creates a new geofence zone. ### Method POST ### Endpoint /vehicle-openapi/electronicFence/region/create ### Parameters #### Request Body - **companyId** (Long) - Required - ID of the company. - **typeId** (Long) - Required - Type ID of the zone. - **entryType** (Integer) - Required - Type of entry. - **fenceType** (Integer) - Required - Type of fence. - **viewAngle** (Integer) - Required - Viewing angle. - **mapType** (String) - Required - Type of map. - **radiusRange** (Integer) - Optional - Radius range for circular zones. - **longitude** (String) - Optional - Longitude for the zone center. - **latitude** (String) - Optional - Latitude for the zone center. - **upperLeft** (String) - Optional - Coordinates for the upper-left corner of a rectangular zone. - **lowerRight** (String) - Optional - Coordinates for the lower-right corner of a rectangular zone. - **longAndLats** (Array) - Optional - Array of longitude and latitude pairs for polygon zones. ### Response #### Success Response (200) - **id** (Long) - The ID of the newly created zone. #### Response Example { "id": 123 } ``` ```APIDOC ## POST /vehicle-openapi/electronicFence/region/update/{id} ### Description Updates an existing geofence zone. ### Method POST ### Endpoint /vehicle-openapi/electronicFence/region/update/{id} ### Parameters #### Path Parameters - **id** (String) - Required - The ID of the zone to update. #### Request Body - **companyId** (Long) - Required - ID of the company. - **typeId** (Long) - Required - Type ID of the zone. - **entryType** (Integer) - Required - Type of entry. - **viewAngle** (Integer) - Required - Viewing angle. - **mapType** (String) - Required - Type of map. - **fenceType** (Integer) - Required - Type of fence. - **radiusRange** (Integer) - Optional - Radius range for circular zones. - **longitude** (String) - Optional - Longitude for the zone center. - **latitude** (String) - Optional - Latitude for the zone center. - **upperLeft** (String) - Optional - Coordinates for the upper-left corner of a rectangular zone. - **lowerRight** (String) - Optional - Coordinates for the lower-right corner of a rectangular zone. ### Response #### Success Response (200) - **message** (String) - Success message. #### Response Example { "message": "Zone updated successfully" } ``` ```APIDOC ## POST /vehicle-openapi/electronicFence/fence/region/order ### Description Applies rules or orders to a geofence region. ### Method POST ### Endpoint /vehicle-openapi/electronicFence/fence/region/order ### Parameters #### Request Body - **timeLimit** (Integer) - Required - Time limit for the order. - **effectTime** (Integer) - Required - Effect time for the order. - **startTime** (String) - Required - Start time for the order. - **endTime** (String) - Required - End time for the order. - **enterReceive** (Integer) - Required - Notification setting for entering the zone. - **outReceive** (Integer) - Required - Notification setting for exiting the zone. - **speedLimit** (Integer) - Required - Speed limit. - **maxSpeed** (Integer) - Required - Maximum speed allowed. - **nightMaxSpeed** (Integer) - Required - Maximum speed allowed at night. - **duration** (Integer) - Required - Duration of the order. - **communication** (Integer) - Required - Communication setting. - **collectCnss** (Integer) - Required - Setting for collecting CNSS data. ### Response #### Success Response (200) - **message** (String) - Success message. #### Response Example { "message": "Order applied successfully" } ``` ```APIDOC ## POST /vehicle-openapi/electronicFence/fence/batch/delete ### Description Deletes multiple geofence zone routes by their IDs. Note: This endpoint appears to have the same path as deleting zones, ensure correct usage. ### Method POST ### Endpoint /vehicle-openapi/electronicFence/fence/batch/delete ### Parameters #### Request Body - **ids** (Long) - Required - Comma-separated string of zone route IDs to delete. ### Response #### Success Response (200) - **message** (String) - Success message. #### Response Example { "message": "Zone routes deleted successfully" } ``` ```APIDOC ## GET /vehicle-openapi/electronicFence/fence ### Description Retrieves the details of a specific geofence zone. ### Method GET ### Endpoint /vehicle-openapi/electronicFence/fence ### Parameters #### Query Parameters - **id** (Long) - Required - The ID of the zone to retrieve. ### Response #### Success Response (200) - **zoneDetails** (Object) - An object containing the details of the geofence zone. #### Response Example { "zoneDetails": { "id": 123, "companyId": 100, "typeId": 10, "entryType": 1, "fenceType": 1, "viewAngle": 90, "mapType": "google", "radiusRange": 50, "longitude": "120.1234", "latitude": "30.5678" } } ``` ```APIDOC ## POST /vehicle-openapi/electronicFence/fence/batch/delete/order ### Description Unbinds or deletes geofence records in batch. ### Method POST ### Endpoint /vehicle-openapi/electronicFence/fence/batch/delete/order ### Parameters #### Query Parameters - **recordIds** (Integer) - Required - IDs of the records to unbind. ### Response #### Success Response (200) - **message** (String) - Success message. #### Response Example { "message": "Records unbound successfully" } ``` -------------------------------- ### Role Management API Source: https://gegechkori.ru/hetuvcc/llms-full.txt Endpoints for managing roles within the system. ```APIDOC ## GET /vehicle-openapi/role/listAll/{companyId} ### Description Retrieves a list of all roles for a specific company. ### Method GET ### Endpoint `/vehicle-openapi/role/listAll/{companyId}` ### Parameters #### Path Parameters - **companyId** (Long) - Required - The ID of the company for which to retrieve roles. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. ``` -------------------------------- ### User Management API Source: https://gegechkori.ru/hetuvcc/llms-full.txt Endpoints for managing users within the system. ```APIDOC ## POST /vehicle-openapi/user/create ### Description Adds a new user to the system. ### Method POST ### Endpoint `/vehicle-openapi/user/create` ### Parameters #### Request Body - **level** (Integer) - Required - User level. - **password** (String) - Required - User's password. - **roleId** (Long) - Required - The ID of the role assigned to the user. - **companyId** (Long) - Required - The ID of the company the user belongs to. - **email** (String) - Optional - User's email address. - **isSingle** (Integer) - Optional - Flag indicating if the user is single. - **phone** (String) - Optional - User's phone number. - **resetPassword** (Integer) - Optional - Flag to indicate if password reset is required. - **timeoutAt** (Date) - Optional - Timeout date for the user. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data. ``` ```APIDOC ## POST /vehicle-openapi/user/update ### Description Modifies an existing user's information. ### Method POST ### Endpoint `/vehicle-openapi/user/update` ### Parameters #### Request Body - **id** (Long) - Required - The ID of the user to update. - **roleId** (Long) - Required - The updated role ID for the user. - **level** (Integer) - Required - The updated user level. - **email** (String) - Optional - The updated email address. - **isSingle** (Integer) - Optional - The updated single user flag. - **phone** (String) - Optional - The updated phone number. - **resetPassword** (Integer) - Optional - Flag to indicate if password reset is required. - **timeoutAt** (Date) - Optional - The updated timeout date. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data. ``` ```APIDOC ## POST /vehicle-openapi/user/delete ### Description Deletes users by their IDs. ### Method POST ### Endpoint `/vehicle-openapi/user/delete` ### Parameters #### Request Body - **ids** (String) - Required - Comma-separated IDs of the users to delete. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data. ``` ```APIDOC ## GET /vehicle-openapi/user/{id} ### Description Retrieves information for a specific user. ### Method GET ### Endpoint `/vehicle-openapi/user/{id}` ### Parameters #### Path Parameters - **id** (String) - Required - The ID of the user to retrieve. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data. ``` ```APIDOC ## POST /vehicle-openapi/user/list ### Description Retrieves a list of users, optionally filtered by company. ### Method POST ### Endpoint `/vehicle-openapi/user/list` ### Parameters #### Request Body - **companyId** (Long) - Optional - The ID of the company to filter users by. If not provided, lists all users. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. ``` -------------------------------- ### Fleet Management API Source: https://gegechkori.ru/hetuvcc/llms-full.txt APIs for managing fleets, including adding, updating, deleting, and listing fleets. ```APIDOC ## POST /vehicle-openapi/motorcade/create ### Description Add a new fleet to the system. ### Method POST ### Endpoint /vehicle-openapi/motorcade/create ### Parameters #### Request Body - **parentId** (Long) - Required - The ID of the parent fleet. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data. ``` ```APIDOC ## POST /vehicle-openapi/motorcade/update ### Description Modify an existing fleet. ### Method POST ### Endpoint /vehicle-openapi/motorcade/update ### Parameters #### Request Body - **id** (Long) - Required - The ID of the fleet to update. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data. ``` ```APIDOC ## GET /vehicle-openapi/motorcade/delete ### Description Delete a fleet from the system. ### Method GET ### Endpoint /vehicle-openapi/motorcade/delete ### Parameters #### Query Parameters - **ids** (String) - Required - A comma-separated string of fleet IDs to delete. ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data. ``` ```APIDOC ## GET /vehicle-openapi/motorcade/list ### Description Retrieve a list of all fleets. ### Method GET ### Endpoint /vehicle-openapi/motorcade/list ### Response #### Success Response (200) - **code** (Integer) - Return code, 200 means success. - **message** (String) - Return information. - **data** (Struct) - Return data containing the list of fleets. ``` -------------------------------- ### Recording Plan API Source: https://gegechkori.ru/hetuvcc/llms-full.txt Endpoints for managing vehicle recording plans, including creation, deletion, assignment, and status updates. ```APIDOC ## DELETE /vehicle-openapi/recording/plans ### Description Deletes a recording plan. ### Method DELETE ### Endpoint `/vehicle-openapi/recording/plans` ### Parameters #### Query Parameters - **[]** (Long) - Yes - Description not provided ``` ```APIDOC ## DELETE /vehicle-openapi/recording/plans ### Description Deletes a recording plan assigned to a vehicle. ### Method DELETE ### Endpoint `/vehicle-openapi/recording/plans` ### Parameters #### Query Parameters - **[]** (Long) - Yes - Description not provided ``` ```APIDOC ## POST /vehicle-openapi/recording/plans/vehicles ### Description Assigns a vehicle to a recording plan. ### Method POST ### Endpoint `/vehicle-openapi/recording/plans/vehicles` ### Parameters #### Request Body - **vehicleId** (Long) - Yes - The ID of the vehicle. - **channelIds** (String) - Yes - The IDs of the channels. - **recordingPlanId** (Long) - Yes - The ID of the recording plan. ``` ```APIDOC ## GET /vehicle-openapi/recording/plans/page/list ### Description Queries a paginated list of recording plans. ### Method GET ### Endpoint `/vehicle-openapi/recording/plans/page/list` ### Parameters #### Query Parameters - **pageNum** (Integer) - Yes - The page number. - **pageSize** (Integer) - Yes - The number of items per page. ``` ```APIDOC ## PUT /vehicle-openapi/recording/plans ### Description Edits an existing recording plan. ### Method PUT ### Endpoint `/vehicle-openapi/recording/plans` ### Parameters #### Request Body - **id** (Long) - Yes - The ID of the recording plan to edit. ``` ```APIDOC ## PUT /vehicle-openapi/recording/plans/{planId}/status? ### Description Enables or disables a recording plan. ### Method PUT ### Endpoint `/vehicle-openapi/recording/plans/{planId}/status?` ### Parameters #### Path Parameters - **planId** (String) - Yes - The ID of the recording plan. #### Query Parameters - **status** (String) - Yes - The new status of the recording plan (e.g., 'enabled', 'disabled'). ``` ```APIDOC ## POST /vehicle-openapi/recording/plans ### Description Adds a new recording plan. ### Method POST ### Endpoint `/vehicle-openapi/recording/plans` ### Parameters #### Request Body - Content-Type: application/json ``` ```APIDOC ## GET /vehicle-openapi/recording/plans/video ### Description Queries video recording files for a specific vehicle within a time range. ### Method GET ### Endpoint `/vehicle-openapi/recording/plans/video` ### Parameters #### Query Parameters - **vehicleId** (Long) - Yes - The ID of the vehicle. - **startTime** (String) - Yes - The start time for the query. - **endTime** (String) - Yes - The end time for the query. ``` ```APIDOC ## GET /vehicle-openapi/recording/plans/pageListPlanVehicles ### Description Queries a paginated list of vehicles assigned to recording plans. ### Method GET ### Endpoint `/vehicle-openapi/recording/plans/pageListPlanVehicles` ### Parameters #### Query Parameters - **pageNum** (Integer) - Yes - The page number. - **pageSize** (Integer) - Yes - The number of items per page. ``` -------------------------------- ### Login Endpoint Request Body Source: https://gegechkori.ru/hetuvcc/llms-full.txt JSON body required for the /vehicle-openapi/sys/login endpoint to obtain an authorization token. Both appCid and appSecret are mandatory. ```json { "appCid": "string required", "appSecret": "string required" } ```