@vepler/area-reference-types/routes/areas/get-areas.d.ts

TypeScript type definitions for Vepler Area Reference API

/**
 * Get Areas API Types
 *
 * /api/areas/{field}/{ids} endpoint
 */
import { GeographicEntityResponse } from './common';
/**
 * Get areas endpoint path parameters
 */
export interface GetAreasPathParams {
    /**
     * Field to search by (code, id, etc.)
     */
    field: string;
    /**
     * Comma-separated list of values
     */
    ids: string;
}
/**
 * Get areas endpoint query parameters
 */
export interface GetAreasQueryParams {
    /**
     * Comma-separated list of attributes to include
     */
    attributes?: string;
    /**
     * Field to group results by
     */
    groupBy?: string;
    /**
     * Include relationship information
     */
    includeRelationships?: boolean;
    /**
     * Include hierarchy information
     */
    includeHierarchy?: boolean;
    /**
     * Include full geometry in response
     */
    includeGeometry?: boolean;
    /**
     * Maximum number of results
     */
    limit?: number;
    /**
     * Result offset for pagination
     */
    offset?: number;
    /**
     * Entity status filter
     */
    status?: string;
}
/**
 * Get areas endpoint response
 */
export interface GetAreasResponse {
    /**
     * Array of found geographic entities
     */
    result: GeographicEntityResponse[];
    /**
     * Success flag
     */
    success: boolean;
}