@vepler/safety-types/routes/neighborhood-watch/get-by-area.d.ts

TypeScript type definitions for Vepler Safety Service API

/**
 * Types for /api/neighborhood-watch/get-by-area endpoint
 */
import { NeighborhoodWatchSchemeResponse } from './get-scheme-details';
/**
 * Query parameters for neighborhood watch schemes by area
 */
export interface GetByAreaQueryParams {
    /** Area ID in format LSOA21::ID */
    areaId: string;
}
/**
 * Response for area-based queries
 */
export interface GetByAreaResponse {
    /** Area ID */
    areaId: string;
    /** Number of schemes found */
    count: number;
    /** List of schemes */
    schemes: NeighborhoodWatchSchemeResponse[];
}