Skip to main content
Version 1.4.0

New Features: Company registration and location management endpoints.

New Features

  • Added company registration endpoint
  • Added location creation and update endpoints
  • Added bulk location status endpoint
  • Enhanced API documentation and examples

API Additions

  • POST /register/company - Register new companies
  • POST /locations - Add new locations
  • PUT /locations/ - Update location details
  • GET /locations/status - Get status for all locations
Version 1.3.0

Major Update: Replaced resident-specific endpoints with generic whitelist vehicle management system.

New Features

  • Introduced referenceId system for flexible vehicle grouping
  • Added comprehensive vehicle plate validation
  • Enhanced filtering capabilities for whitelist queries
  • Improved error handling with detailed validation messages

Breaking Changes

  • Removed resident-specific endpoints
  • Updated vehicle data structure with new validation rules
  • Changed authentication requirements for certain endpoints

Improvements

  • Enhanced API response consistency
  • Improved documentation and examples
  • Better error messages for debugging
Version 1.2.0

Initial API Release: Core parking management functionality with location and vehicle management.

Features Added

  • Location management endpoints
  • Resident and vehicle management
  • Parking activity tracking
  • Real-time status monitoring

Authentication

  • API key-based authentication
  • Location-scoped access control
Version 1.1.0

Enhancement Release: Improved performance and additional features.

New Features

  • Bulk vehicle import capabilities
  • Enhanced filtering options
  • Webhook support for real-time events

Performance Improvements

  • Reduced API response times by 40%
  • Optimized database queries
  • Improved caching mechanisms
Version 1.0.0

Initial Release: First version of the Arqqin Parking Management API.

Core Features

  • Basic location management
  • Simple vehicle whitelist management
  • API key authentication
  • Health check endpoint

Migration Guides

Migrating from Version 1.2.0 to 1.3.0

Version 1.3.0 introduces breaking changes that require code updates.
1

Update Vehicle Data Structure

Replace resident-specific fields with the new referenceId system:
// Old format (v1.2.0)
const vehicleData = {
  residentId: "RES_001",
  plateType: "DXB",
  plateCode: "White",
  plateNumber: "12345"
};

// New format (v1.3.0)
const vehicleData = {
  referenceId: "RESIDENT_001",  // Use your own reference system
  plateType: "DXB",
  plateCode: "White",
  plateNumber: "12345"
};
2

Update Endpoint URLs

Replace resident-specific endpoints with generic whitelist endpoints:
# Old endpoints (v1.2.0)
GET /locations/{locationId}/residents/{residentId}/vehicles
POST /locations/{locationId}/residents/{residentId}/vehicles

# New endpoints (v1.3.0)
GET /locations/{locationId}/whitelist?referenceId={referenceId}
POST /locations/{locationId}/whitelist
3

Update Validation Logic

Implement new plate validation rules:
// New validation requirements
const validationRules = {
  plateType: /^[A-Z]{2,4}$/,           // 2-4 uppercase letters
  plateCode: /^(White|[A-Za-z0-9]{1,3})$/, // "White" or 1-3 alphanumeric
  plateNumber: /^\d+$/                 // Digits only
};

Deprecation Notices

Deprecated Endpoints

The following endpoints are deprecated and will be removed in version 2.0.0:

  • GET /locations//residents - Use GET /locations//whitelist with filtering
  • POST /locations//residents - Use POST /locations//whitelist
  • GET /locations//residents//vehicles - Use GET /locations//whitelist?referenceId=

Planned Features

  • Company Management: Multi-tenant support with optional externalCompanyId for client-managed company references
  • Combined Location Status: New endpoint GET /locations/status for aggregated status across all accessible locations
  • Location Registration: Dynamic location creation and management with POST /locations and PUT /locations/{locationId}
  • Enhanced Multi-tenancy: Company-scoped API access with support for both internal and external company identifiers
  • Bulk operations for vehicle management
  • Advanced filtering and search capabilities
  • Webhook support for parking events
  • Enhanced analytics and reporting endpoints
  • Complete API redesign with improved consistency
  • Enhanced security features
  • GraphQL support
  • Advanced rate limiting and usage analytics

Support and Feedback