Scheduled Diagnosis API Developer Guide

Service Overview

Scheduled Diagnosis Service is a telematics-based vehicle diagnosis service that periodically checks vehicle status according to predefined schedules.

Service Features

Periodic automatic vehicle status checks
Prevention-focused vehicle management
Automatic execution without user intervention
Alert-focused result delivery
Batch system-based operation

Legal Requirements

Compliance with personal information protection laws
Mandatory vehicle diagnosis data collection consent
Periodic inspection consent required
Compliance with data retention period policies

Key Scenarios

Scenario 1: Monthly Scheduled Diagnosis Automatic Execution and Result Alert

API Flow by Entity:

🏢 Call Center:

Schedule Trigger: Monthly scheduled diagnosis trigger -
Report Generation: Automatically generate and store monthly reports
Alert Transmission: Notify users via push notifications

📱 User App:

Latest Report: Query latest scheduled diagnosis report -
Consumable Status: Query current consumable status -
Maintenance Booking: Book maintenance for identified issues -
Schedule Config: Set user custom diagnosis schedule -

🚗 Vehicle (TCU):

Diagnosis Request Reception: Receive diagnosis request from server
Data Collection: Collect data such as mileage, oil life, tire pressure
Result Transmission: Transmit diagnosis results to server
Power Saving Mode: Switch to power saving mode after diagnosis completion

Scenario 2: Scheduled Diagnosis Schedule Management and Settings

API Flow by Entity:

🏢 Call Center:

Schedule Query: Query current schedule settings
Schedule Settings: Change schedule settings -
Statistics Query: Query 24-month statistics -
Data Analysis: Comprehensive analysis of diagnosis data
Report Management: Manage all monthly reports

📱 User App:

Latest Report: Query latest scheduled diagnosis report -
Consumable Status: Detailed consumable analysis -
Maintenance Booking: Execute maintenance booking -
Statistics Check: Check maintenance statistics -

🚗 Vehicle (TCU):

Schedule Reception: Receive changed schedule information
Schedule Application: Automatically apply new schedule
Scheduled Diagnosis: Execute scheduled diagnosis according to set schedule
Status Reporting: Periodic reporting of diagnosis execution status

Scenario 3: Consumable Status Analysis and Maintenance Guidance

API Flow by Entity:

🏢 Call Center:

Consumable Query: Query consumable status -
Lifespan Calculation: Calculate consumable lifespan based on usage
Maintenance Need Determination: Determine if replacement time reached
Alert Generation: Automatically generate maintenance needed alerts
Cost Prediction: Provide maintenance cost prediction and statistics

📱 User App:

Consumable Status: Check consumable status -
Maintenance Booking: Execute maintenance booking -

🚗 Vehicle (TCU):

Consumable Data: Collect data such as oil life, tire pressure
Status Calculation: Calculate current consumable status
Data Transmission: Transmit consumable status information
Warning Signal: Transmit warning signal when consumable replacement needed

Key Features

📱 Features to Implement in App

🏢 Features to Implement in Call Center

1. Scheduled Diagnosis Scheduling System

Schedule Trigger: Monthly scheduled diagnosis trigger -
Schedule Settings: Change global or vehicle-specific schedule settings -

2. Automatic Diagnosis Execution System

Diagnosis Request: Request vehicle diagnosis with CMD_GET_CONSUMABLES command
Data Collection: Collect data such as mileage, oil life, tire pressure
Result Processing: Automatically process and store diagnosis results
Report Generation: Automatically generate monthly reports
Alert Transmission: Automatically transmit results via push notifications

3. Report Management System

Latest Report: Provide latest report -
Report List: Provide past report list (12 months) -
Report Generation: Automatically generate and store monthly reports
Data Analysis: Comprehensive analysis of diagnosis data
Report Storage: Permanent storage of all reports

4. Consumable Analysis System

Consumable Status: Query consumable status -
Statistics Query: Query vehicle-specific maintenance statistics -

5. Statistics and Analysis System

Statistics Query: Query 24-month statistics -
Cost Analysis: Analyze maintenance costs and estimated costs
Pattern Analysis: Analyze vehicle status change patterns
Performance Report: Generate scheduled diagnosis service performance reports
Improvement Suggestions: Generate data-based service improvement suggestions

6. Maintenance Service Linkage System

Maintenance Booking: Accept maintenance bookings -
Booking Management: Manage maintenance booking status and history
Service Providers: Manage repair shop and service provider information
Satisfaction Analysis: Analyze maintenance service satisfaction
Cost Management: Manage maintenance costs and estimated costs

Sequence Diagram

Scheduled Diagnosis System Flow

Scheduled Diagnosis

API Endpoints

Refer to the Common API Specifications for headers, response codes, and error formats.

Scheduled Diagnosis Report Query

Latest Scheduled Diagnosis Report Query

bash

curl -X GET "https://api.ecarus.run/api/v1/diagnosis/vehicles/KMHSH81C7LU123456/scheduled/report/latest" \
     -H "Authorization: Bearer sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d"

Consumable Parts Status Query

bash

curl -X GET "https://api.ecarus.run/api/v1/diagnosis/vehicles/KMHSH81C7LU123456/scheduled/consumables" \
     -H "Authorization: Bearer sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d"

Scheduled Diagnosis Service

Scheduled Diagnosis Booking

bash

curl -X POST "https://api.ecarus.run/api/v1/diagnosis/vehicles/KMHSH81C7LU123456/scheduled/maintenance/schedule" \
     -H "Authorization: Bearer sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d" \
     -H "Content-Type: application/json" \
     -d '{"serviceType": "OIL_CHANGE", "preferredDate": "2026-01-20", "preferredTime": "10:00"}'

Monthly Diagnosis Trigger

bash

curl -X POST "https://api.ecarus.run/api/v1/diagnosis/scheduled/monthly-trigger" \
     -H "Authorization: Bearer sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d"

Schedule Configuration

bash

curl -X POST "https://api.ecarus.run/api/v1/diagnosis/vehicles/KMHSH81C7LU123456/scheduled/config" \
     -H "Authorization: Bearer sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d" \
     -H "Content-Type: application/json" \
     -d '{"scheduleType": "MONTHLY", "dayOfMonth": 15, "time": "03:00", "enabled": true}'

Diagnosis Statistics Query

bash

curl -X GET "https://api.ecarus.run/api/v1/diagnosis/vehicles/KMHSH81C7LU123456/scheduled/statistics?period=24m" \
     -H "Authorization: Bearer sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d"

Data Models

Scheduled Diagnosis Report

json

{
  "reportId": "report-12345",
  "vin": "KMHSH81C7LU123456",
  "reportDate": "2026-01-15",
  "summary": {
    "overallStatus": "NORMAL",
    "healthScore": 92,
    "consumablesChecked": 8,
    "issuesFound": 0,
    "maintenanceNeeded": false
  },
  "consumables": [
    {
      "item": "ENGINE_OIL",
      "status": "NORMAL",
      "remainingLife": 75,
      "nextService": "2026-04-15",
      "currentMileage": 45230
    },
    {
      "item": "BRAKE_PADS",
      "status": "WARNING",
      "remainingLife": 25,
      "nextService": "2026-02-20",
      "currentMileage": 45230
    }
  ],
  "recommendations": [
    {
      "priority": "MEDIUM",
      "item": "BRAKE_PADS",
      "action": "SCHEDULE_INSPECTION",
      "description": "Brake pads approaching replacement time"
    }
  ],
  "generatedAt": "2026-01-15T03:30:00Z"
}

Consumable Status

json

{
  "vin": "KMHSH81C7LU123456",
  "timestamp": "2026-01-13T14:30:00Z",
  "consumables": [
    {
      "item": "ENGINE_OIL",
      "status": "NORMAL",
      "remainingLife": 75,
      "unit": "percentage",
      "currentMileage": 45230,
      "lastService": "2025-10-15",
      "nextService": "2026-04-15",
      "estimatedCost": "80-120"
    },
    {
      "item": "BRAKE_PADS",
      "status": "WARNING",
      "remainingLife": 25,
      "unit": "percentage",
      "currentMileage": 45230,
      "lastService": "2024-08-20",
      "nextService": "2026-02-20",
      "estimatedCost": "200-350"
    },
    {
      "item": "AIR_FILTER",
      "status": "NORMAL",
      "remainingLife": 60,
      "unit": "percentage",
      "currentMileage": 45230,
      "lastService": "2025-07-10",
      "nextService": "2026-03-10",
      "estimatedCost": "40-80"
    }
  ],
  "summary": {
    "totalItems": 8,
    "normalItems": 6,
    "warningItems": 2,
    "criticalItems": 0,
    "nextMaintenance": "2026-02-20"
  }
}

Maintenance Schedule

json

{
  "bookingId": "booking-12345",
  "vin": "KMHSH81C7LU123456",
  "serviceType": "OIL_CHANGE",
  "preferredDate": "2026-01-20",
  "preferredTime": "10:00",
  "status": "CONFIRMED",
  "serviceCenter": {
    "id": "center-001",
    "name": "DaddyHouse Service Center",
    "address": "123 Service Road, Seoul",
    "phone": "02-1234-5678"
  },
  "estimatedCost": "100-150",
  "estimatedDuration": "45 minutes",
  "createdAt": "2026-01-13T14:30:00Z",
  "confirmedAt": "2026-01-13T15:00:00Z"
}

Diagnosis Statistics

json

{
  "vin": "KMHSH81C7LU123456",
  "period": "24m",
  "statistics": {
    "totalDiagnoses": 24,
    "normalReports": 18,
    "warningReports": 6,
    "criticalReports": 0,
    "maintenanceEvents": 8,
    "totalMaintenanceCost": 1250.50,
    "averageMonthlyCost": 52.10,
    "healthScoreTrend": {
      "current": 92,
      "average": 88.5,
      "best": 95,
      "worst": 75
    },
    "consumableReplacements": [
      {
        "item": "ENGINE_OIL",
        "count": 3,
        "totalCost": 360.00,
        "averageInterval": "6 months"
      },
      {
        "item": "BRAKE_PADS",
        "count": 1,
        "totalCost": 280.00,
        "averageInterval": "24 months"
      }
    ]
  },
  "generatedAt": "2026-01-13T14:30:00Z"
}

Schedule Configuration

json

{
  "vin": "KMHSH81C7LU123456",
  "scheduleType": "MONTHLY",
  "enabled": true,
  "schedule": {
    "dayOfMonth": 15,
    "time": "03:00",
    "timezone": "Asia/Seoul"
  },
  "nextExecution": "2026-02-15T03:00:00Z",
  "lastExecution": "2026-01-15T03:00:00Z",
  "executionHistory": [
    {
      "date": "2026-01-15",
      "status": "COMPLETED",
      "reportId": "report-12345"
    },
    {
      "date": "2025-12-15",
      "status": "COMPLETED",
      "reportId": "report-12344"
    }
  ],
  "updatedAt": "2026-01-13T14:30:00Z"
}

Security and Privacy

Authentication and Authorization

User authentication token required (JWT/OAuth2)
Vehicle access permission verification
Scheduled diagnosis consent verification
Maintenance booking permission verification

Data Security

All API communication encrypted with HTTPS/TLS
Scheduled diagnosis data transmission security
Personal maintenance information protection

Privacy Protection

Explicit consent for scheduled diagnosis
Diagnosis purpose specification
Data retention period policy compliance
User right to data deletion guarantee

Access Control

VIN-based vehicle access permission verification
User-specific schedule access management
Maintenance booking access control
Abnormal schedule pattern detection

Exception Handling

Schedule Failure: Automatic retry and error notification
Schedule Conflict: Prevent duplicate schedule execution
Schedule Timeout: Automatic rescheduling

Vehicle OFF: Schedule execution postponement
Low Battery: Schedule execution cancellation
Diagnosis Failure: Error notification and retry

Data Loss: Data recovery and re-execution
Data Corruption: Data integrity verification
Analysis Failure: Default report generation

Alert Failure: Alternative notification method
Alert Duplication: Prevent duplicate alerts
Alert Ignored: User preference reflection

Test Setup

Base URL: https://api.ecarus.run/api/v1/diagnosis
Authentication Token: sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d
Sample VIN: KMHSH81C7LU123456

Use Swagger UI for interactive API testing.

Deployment Considerations

App Store Registration

Request scheduled diagnosis permissions
Request push notification permissions
Clear explanation of periodic diagnosis functionality

Legal Regulation Compliance

Compliance with personal information protection laws
Mandatory scheduled diagnosis consent
Compliance with periodic inspection consent requirements
Compliance with data retention period policies

Vehicle Compatibility

Support various vehicle models
Consider consumable sensor differences
Reflect OEM-specific diagnosis protocol differences
Consider battery capacity for scheduled execution

Batch System Operations

Batch job scheduling optimization
Large-scale vehicle processing capability
System resource management
Failure recovery and retry mechanisms

Scheduled Diagnosis API Developer Guide ​

Service Overview ​

Service Features ​

Legal Requirements ​

Key Scenarios ​

Scenario 1: Monthly Scheduled Diagnosis Automatic Execution and Result Alert ​

Scenario 2: Scheduled Diagnosis Schedule Management and Settings ​

Scenario 3: Consumable Status Analysis and Maintenance Guidance ​

Key Features ​

📱 Features to Implement in App ​

1. Scheduled Diagnosis Result Verification ​

2. Consumable Status Management ​

3. Schedule Management ​

4. Maintenance Service Linkage ​

🏢 Features to Implement in Call Center ​

1. Scheduled Diagnosis Scheduling System ​

2. Automatic Diagnosis Execution System ​

3. Report Management System ​

4. Consumable Analysis System ​

5. Statistics and Analysis System ​

6. Maintenance Service Linkage System ​

Sequence Diagram ​

Scheduled Diagnosis System Flow ​

API Endpoints ​

Scheduled Diagnosis Report Query ​

Latest Scheduled Diagnosis Report Query ​

Consumable Parts Status Query ​

Scheduled Diagnosis Service ​

Scheduled Diagnosis Booking ​

Monthly Diagnosis Trigger ​

Schedule Configuration ​

Diagnosis Statistics Query ​

Data Models ​

Scheduled Diagnosis Report ​

Consumable Status ​

Maintenance Schedule ​

Diagnosis Statistics ​

Schedule Configuration ​

Security and Privacy ​

Authentication and Authorization ​

Data Security ​

Privacy Protection ​

Access Control ​

Exception Handling ​

Schedule Related ​

Vehicle Related ​

Data Related ​

Notification Related ​

Test Setup ​

Deployment Considerations ​

App Store Registration ​

Legal Regulation Compliance ​

Vehicle Compatibility ​

Batch System Operations ​

Scheduled Diagnosis API Developer Guide

Service Overview

Service Features

Legal Requirements

Key Scenarios

Scenario 1: Monthly Scheduled Diagnosis Automatic Execution and Result Alert

Scenario 2: Scheduled Diagnosis Schedule Management and Settings

Scenario 3: Consumable Status Analysis and Maintenance Guidance

Key Features

📱 Features to Implement in App

1. Scheduled Diagnosis Result Verification

2. Consumable Status Management

3. Schedule Management

4. Maintenance Service Linkage

🏢 Features to Implement in Call Center

1. Scheduled Diagnosis Scheduling System

2. Automatic Diagnosis Execution System

3. Report Management System

4. Consumable Analysis System

5. Statistics and Analysis System

6. Maintenance Service Linkage System

Sequence Diagram

Scheduled Diagnosis System Flow

API Endpoints

Scheduled Diagnosis Report Query

Latest Scheduled Diagnosis Report Query

Consumable Parts Status Query

Scheduled Diagnosis Service

Scheduled Diagnosis Booking

Monthly Diagnosis Trigger

Schedule Configuration

Diagnosis Statistics Query

Data Models

Scheduled Diagnosis Report

Consumable Status

Maintenance Schedule

Diagnosis Statistics

Schedule Configuration

Security and Privacy

Authentication and Authorization

Data Security

Privacy Protection

Access Control

Exception Handling

Schedule Related

Vehicle Related

Data Related

Notification Related

Test Setup

Deployment Considerations

App Store Registration

Legal Regulation Compliance

Vehicle Compatibility

Batch System Operations