Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.arqq.in/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Locations represent properties where you manage parking access. Each location can have its own settings, capacity, and vehicle whitelists.

​
Adding Locations

Create a new location in your company portfolio: 
curl -X POST "https://apistg.arqq.in/api/locations" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sunset Towers",
    "slug": "sunset-towers",
    "address": "456 Sunset Boulevard, Dubai Marina",
    "city": "Dubai",
    "country": "UAE",
    "coordinates": {
      "lat": 25.0772,
      "lng": 55.1409
    }
  }'

​
Listing Locations

​
Get All Accessible Locations

Retrieve all locations you have access to: 
curl -X GET "https://apistg.arqq.in/api/locations" \
  -H "X-API-Key: YOUR_API_KEY"

​
Filter Locations by Company

Filter locations to show only those belonging to a specific company: 
curl -X GET "https://apistg.arqq.in/api/locations?companyId=k17abc123def456ghi789jkl012mno345" \
  -H "X-API-Key: YOUR_API_KEY"
Response: 
{
  "success": true,
  "data": [
    {
      "id": "k17xyz789abc123def456ghi012jkl345",
      "name": "Downtown Residences",
      "address": "123 Main Street, Dubai",
      "city": "Dubai",
      "country": "UAE",
      "parkingCapacity": 150,
      "gateCount": 3,
      "isActive": true,
      "createdAt": "2024-01-15T10:00:00Z"
    }
  ]
}

​
Updating Locations

Update an existing location’s information using the API key: 
curl -X PUT "https://apistg.arqq.in/api/locations/location_123" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sunset Towers Updated",
    "address": "456 Sunset Boulevard (Renovated), Dubai Marina",
    "city": "Dubai",
    "country": "UAE",
    "coordinates": {
      "lat": 25.0773,
      "lng": 55.1410
    }
  }'

​
Location Status

​
Single Location Status

Get status for a specific location: 
curl -X GET "https://apistg.arqq.in/api/locations/location_123/status" \
  -H "X-API-Key: YOUR_API_KEY"

​
Bulk Location Status

Get status across all accessible companies, or filter by a specific company using an optional companyId query parameter. 
# All accessible companies (aggregated)
curl -X GET "https://apistg.arqq.in/api/locations/status" \
  -H "X-API-Key: YOUR_API_KEY"

# Specific company
curl -X GET "https://apistg.arqq.in/api/locations/status?companyId=cmp_123" \
  -H "X-API-Key: YOUR_API_KEY"
  • If companyId is provided, your API key must have access to that company; otherwise a 403 is returned.
  • If companyId is omitted, results are aggregated across all companies your API key can access.
Aggregated Response (no companyId): 
{
  "success": true,
  "data": {
    "companies": [
      { "companyId": "cmp_123", "totalLocations": 3, "lastUpdated": "2025-09-24T12:34:56.000Z" },
      { "companyId": "cmp_456", "totalLocations": 2, "lastUpdated": "2025-09-24T12:34:56.000Z" }
    ],
    "totalLocations": 5,
    "locations": [
      {
        "companyId": "cmp_123",
        "locationId": "loc_abc",
        "locationName": "Downtown Residences",
        "totalCapacity": 150,
        "currentOccupancy": 89,
        "availableSpaces": 61
      }
      
    ],
    "lastUpdated": "2025-09-24T12:34:56.000Z"
  }
}
Filtered Response (with companyId): 
{
  "success": true,
  "data": {
    "companies": [
      { "companyId": "cmp_123", "totalLocations": 3, "lastUpdated": "2025-09-24T12:34:56.000Z" }
    ],
    "totalLocations": 3,
    "locations": [
      {
        "companyId": "cmp_123",
        "locationId": "loc_abc",
        "locationName": "Downtown Residences",
        "totalCapacity": 150,
        "currentOccupancy": 89,
        "availableSpaces": 61
      }
      
    ],
    "lastUpdated": "2025-09-24T12:34:56.000Z"
  }
}

​
Location Fields

​
name
string
required
Location display name
​
slug
string
required
URL-friendly identifier (lowercase letters, numbers, hyphens only)
​
address
string
required
Physical address
​
city
string
City name
​
country
string
Country name
​
coordinates
object
GPS coordinates with lat and lng properties