@drfrost/bods-js/dist/types/disruptions.d.ts

JavaScript client for the UK's Bus Open Data Service (BODS) API

/**
 * SIRI-SX disruption data structure
 * Note: Disruption data is returned as XML and will need parsing
 */
export interface DisruptionData {
    /** Raw XML data from SIRI-SX feed */
    xmlData: string;
}
/**
 * Parsed disruption information (after XML parsing)
 */
export interface ParsedDisruption {
    /** Unique situation identifier */
    situationNumber: string;
    /** Participant reference (e.g., transport authority) */
    participantRef: string;
    /** Creation timestamp */
    creationTime: string;
    /** Source information */
    source: {
        sourceType: string;
        timeOfCommunication: string;
    };
    /** Disruption progress status */
    progress: string;
    /** Validity period */
    validityPeriod: {
        startTime: string;
        endTime: string;
    };
    /** Publication window */
    publicationWindow: {
        startTime: string;
        endTime: string;
    };
    /** Equipment reason for disruption */
    equipmentReason?: string;
    /** Whether the disruption is planned */
    planned: boolean;
    /** Brief summary */
    summary: string;
    /** Detailed description */
    description: string;
    /** Consequences of the disruption */
    consequences: {
        condition: string;
        severity: string;
        affects: {
            networks?: any[];
            stopPoints?: any[];
            vehicleJourneys?: any[];
        };
    };
}
//# sourceMappingURL=disruptions.d.ts.map