Skip to main content

Equipment Management API

This document covers equipment management functionality within the AttuneLogic API, supporting both fleet management for trucking and equipment tracking for service industries.

🎯 Overview​

The Equipment Management API provides comprehensive functionality to track, maintain, and manage equipment across different industry contexts with automated maintenance scheduling and performance monitoring.

🏭 Industry Applications​

Trucking Industry​

  • Fleet Vehicles: Trucks, trailers, semi-tractors
  • Support Equipment: Loading equipment, GPS devices
  • Maintenance Tracking: DOT compliance, inspection schedules

Service Industries​

  • Customer Equipment: HVAC units, water heaters, electrical panels
  • Company Assets: Service vehicles, tools, diagnostic equipment
  • Maintenance Programs: Preventive maintenance, warranty tracking

📋 Core Endpoints​

Equipment Registration​

POST /api/v1/equipment
Content-Type: application/json
Authorization: Bearer <token>

{
  "name": "Unit 2024-HVAC-001",
  "type": "hvac_unit", // 'truck', 'trailer', 'hvac_unit', 'water_heater', 'tool'
  "category": "customer_equipment", // 'fleet', 'customer_equipment', 'company_asset'
  "manufacturer": "Carrier",
  "model": "24ACC636A003",
  "serialNumber": "HV2024001",
  "purchaseDate": "2024-01-15",
  "warrantyExpiration": "2026-01-15",
  "location": {
    "customer": "64a7b8c9d1e2f3g4h5i6j7k8", // For customer equipment
    "address": "123 Main St, Dallas, TX 75201",
    "coordinates": [-96.8352, 32.6839]
  },
  "specifications": {
    "capacity": "3 Ton",
    "efficiency": "16 SEER",
    "fuel": "Electric",
    "voltage": "240V"
  },
  "assignedTo": "64a7b8c9d1e2f3g4h5i6j7k9" // Technician or driver
}

Equipment Retrieval​

GET /api/v1/equipment
GET /api/v1/equipment/:id
GET /api/v1/equipment/search?q=<query>&type=<type>&status=<status>
GET /api/v1/equipment/by-customer/:customerId
GET /api/v1/equipment/by-assignee/:userId

Equipment Updates​

PUT /api/v1/equipment/:id
PATCH /api/v1/equipment/:id/status
PATCH /api/v1/equipment/:id/location

🔧 Maintenance Management​

Maintenance Schedules​

GET /api/v1/equipment/:id/maintenance-schedule
POST /api/v1/equipment/:id/maintenance-schedule

{
  "type": "preventive", // 'preventive', 'corrective', 'emergency'
  "category": "hvac_maintenance", // 'oil_change', 'inspection', 'hvac_maintenance'
  "frequency": "quarterly", // 'daily', 'weekly', 'monthly', 'quarterly', 'annually'
  "description": "Filter replacement and system check",
  "estimatedDuration": 120, // minutes
  "partsRequired": [{
    "partNumber": "FILTER-16x25x1",
    "quantity": 1,
    "description": "Air Filter"
  }],
  "skillsRequired": ["hvac_certified"],
  "priority": "medium", // 'low', 'medium', 'high', 'critical'
  "nextDue": "2024-04-01T10:00:00Z"
}

Maintenance Records​

GET /api/v1/equipment/:id/maintenance-history
POST /api/v1/equipment/:id/maintenance-records

{
  "scheduledMaintenanceId": "64a7b8c9d1e2f3g4h5i6j7k8",
  "performedBy": "64a7b8c9d1e2f3g4h5i6j7k9",
  "performedDate": "2024-01-15T10:00:00Z",
  "actualDuration": 105,
  "partsUsed": [{
    "partNumber": "FILTER-16x25x1",
    "quantity": 1,
    "cost": 25.00
  }],
  "workPerformed": "Replaced air filter, checked refrigerant levels, cleaned coils",
  "issuesFound": [],
  "recommendations": ["Schedule duct cleaning in 6 months"],
  "nextMaintenanceDue": "2024-04-15T10:00:00Z",
  "photos": ["maintenance_photo_1.jpg", "maintenance_photo_2.jpg"]
}

🚛 Fleet Management Features​

Vehicle Tracking​

GET /api/v1/equipment/fleet/tracking
POST /api/v1/equipment/:id/location

{
  "coordinates": [-96.8352, 32.6839],
  "heading": 45, // degrees
  "speed": 65, // mph
  "odometer": 125430, // miles
  "fuelLevel": 75, // percentage
  "engineHours": 8240,
  "timestamp": "2024-01-15T14:30:00Z"
}

DOT Compliance​

GET /api/v1/equipment/:id/compliance
POST /api/v1/equipment/:id/inspections

{
  "inspectionType": "DOT_annual", // 'DOT_annual', 'DOT_90day', 'state_inspection'
  "inspector": "Certified Inspector LLC",
  "inspectionDate": "2024-01-15",
  "certificateNumber": "DOT2024001",
  "expirationDate": "2025-01-15",
  "violations": [],
  "notes": "All systems passed inspection"
}

🔧 Service Equipment Management​

Customer Equipment Monitoring​

GET /api/v1/equipment/customer/:customerId/status
POST /api/v1/equipment/:id/readings

{
  "readingDate": "2024-01-15T10:00:00Z",
  "readings": {
    "temperature": 72,
    "pressure": 150, // psi
    "efficiency": 95, // percentage
    "runtime": 8.5 // hours today
  },
  "alerts": [],
  "performanceMetrics": {
    "energyUsage": 45.2, // kWh
    "operatingCost": 12.35 // daily cost
  }
}

Warranty Management​

GET /api/v1/equipment/:id/warranty
POST /api/v1/equipment/:id/warranty-claims

{
  "claimNumber": "WC2024001",
  "issueDescription": "Compressor failure",
  "claimDate": "2024-01-15",
  "manufacturer": "Carrier",
  "warrantyType": "parts_and_labor",
  "estimatedCost": 1250.00,
  "status": "submitted" // 'submitted', 'approved', 'denied', 'completed'
}

📊 Analytics & Reporting​

Equipment Performance​

GET /api/v1/equipment/:id/analytics
GET /api/v1/equipment/fleet/analytics

Returns:

  • Uptime/downtime statistics
  • Maintenance cost analysis
  • Performance trends
  • Predictive maintenance recommendations

Cost Management​

GET /api/v1/equipment/:id/costs
GET /api/v1/equipment/costs/summary

Returns:

  • Maintenance costs
  • Operating costs
  • ROI analysis
  • Replacement recommendations

🔐 Security & Permissions​

  • Equipment data isolated by company/tenant
  • Role-based access to sensitive information
  • Audit trails for all equipment changes
  • Encrypted storage of performance data

🚨 Automated Alerts​

Maintenance Alerts​

  • Overdue maintenance notifications
  • Upcoming service reminders
  • Parts ordering alerts

Performance Alerts​

  • Equipment failure predictions
  • Efficiency degradation warnings
  • Warranty expiration notices

🔗 Related Documentation​