REST API Reference

{
  "data": [ /* array of record objects */ ],
  "total": 42,          // total matching records
  "page": 1,           // current page
  "limit": 10,          // records per page
  "table": "properties", // table name
  "schema": { /* field definitions */ }
}

# First 10 properties
GET tables/properties?page=1&limit=10

# Search for Mumbai properties
GET tables/properties?search=Mumbai

# Sort by health score descending
GET tables/properties?sort=-health_pct

# Combine: search + paginate
GET tables/properties?search=online&page=2&limit=20

{
  "error": "CONFLICT",
  "message": "Entity with the specified id already exists in the system.",
  "status": 409,
  "request_id": "req_a8f2c1d9e3b7"
}

/**
 * HospitalityNet API Client
 * Provides typed CRUD access to all 15 platform tables.
 */
class HNetAPI {
  constructor(baseUrl = '') {
    this.base = baseUrl;
  }

  async #req(method, path, body) {
    const opts = {
      method,
      headers: { 'Content-Type': 'application/json' }
    };
    if (body) opts.body = JSON.stringify(body);
    const res = await fetch(`${this.base}${path}`, opts);
    if (!res.ok) {
      const err = await res.json().catch(() => ({}));
      throw new Error(err.message || `HTTP ${res.status}`);
    }
    return res.status === 204 ? null : res.json();
  }

  // List records with optional search/sort/page
  list(table, params = {}) {
    const q = new URLSearchParams(params).toString();
    return this.#req('GET', `tables/${table}${q ? '?' + q : ''}`);
  }

  // Get single record by ID
  get(table, id)           { return this.#req('GET',    `tables/${table}/${id}`); }
  create(table, data)      { return this.#req('POST',   `tables/${table}`, data); }
  update(table, id, data)  { return this.#req('PUT',    `tables/${table}/${id}`, data); }
  patch(table, id, data)   { return this.#req('PATCH',  `tables/${table}/${id}`, data); }
  delete(table, id)        { return this.#req('DELETE', `tables/${table}/${id}`); }
}

// Usage
const api = new HNetAPI();

// Get all online properties
const { data: props } = await api.list('properties', { search: 'online', sort: '-health_pct' });

// Create a support ticket
const ticket = await api.create('support_tickets', {
  id: `tkt-${Date.now()}`,
  property_id: 'prop-001',
  subject: 'AP offline in Room 704 corridor',
  priority: 'high', status: 'open',
  category: 'AP-Offline'
});

// Resolve it later
await api.patch('support_tickets', ticket.id, {
  status: 'resolved',
  resolved_at: new Date().toISOString()
});

import requests
from datetime import datetime, timezone
import time

class HNetAPIClient:
    def __init__(self, base_url: str, max_retries: int = 3):
        self.base = base_url.rstrip('/')
        self.session = requests.Session()
        self.session.headers.update({'Content-Type': 'application/json'})
        self.max_retries = max_retries

    def _request(self, method, path, **kwargs):
        url = f"{self.base}/{path}"
        for attempt in range(self.max_retries):
            r = self.session.request(method, url, **kwargs)
            if r.status_code == 429:
                time.sleep(2 ** attempt * 0.1)
                continue
            r.raise_for_status()
            return r.json() if r.content else None

    def list(self, table, **params):
        return self._request('GET', f'tables/{table}', params=params)

    def get(self, table, record_id):
        return self._request('GET', f'tables/{table}/{record_id}')

    def create(self, table, data: dict):
        return self._request('POST', f'tables/{table}', json=data)

    def patch(self, table, record_id, data: dict):
        return self._request('PATCH', f'tables/{table}/{record_id}', json=data)

    def delete(self, table, record_id):
        return self._request('DELETE', f'tables/{table}/{record_id}')


# Usage
api = HNetAPIClient('https://your-platform-url')

# Post bandwidth snapshot
api.create('bandwidth_snapshots', {
    'id': f"bw-{int(time.time())}",
    'property_id': 'prop-001',
    'timestamp': datetime.now(timezone.utc).isoformat(),
    'total_download_mbps': 648,
    'total_upload_mbps': 142,
    'active_clients': 412,
    'interval_min': 5
})

# List all properties
curl -s "tables/properties?limit=10&sort=-health_pct" | python3 -m json.tool

# Get single property
curl -s "tables/properties/prop-001"

# Create a new property
curl -X POST "tables/properties" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "prop-007",
    "name": "The Leela Palace Delhi",
    "type": "5-Star Hotel",
    "status": "online",
    "city": "New Delhi",
    "state": "Delhi",
    "health_pct": 98
  }'

# Update AP status to offline
curl -X PATCH "tables/access_points/ap-005" \
  -H "Content-Type: application/json" \
  -d '{"status": "offline", "clients": 0}'

# Resolve a support ticket
curl -X PATCH "tables/support_tickets/tkt-001" \
  -H "Content-Type: application/json" \
  -d '{"status": "resolved", "resolved_at": "2025-05-19T12:00:00Z"}'

# Delete a record
curl -X DELETE "tables/vouchers/vch-006" -i
# Expect: HTTP/1.1 204 No Content