ocpp-standard-schema/build/src/ocpp-20-types/BootNotificationResponse.d.ts

Contains OCPP JSON schemas for validation purposes

/**
 * This contains whether the Charging Station has been registered
 * within the CSMS.
 *
 */
export declare type RegistrationStatusEnumType = 'Accepted' | 'Pending' | 'Rejected';
export default interface BootNotificationResponse {
    customData?: CustomDataType;
    /**
     * This contains the CSMS’s current time.
     *
     */
    currentTime: string;
    /**
     * When <<cmn_registrationstatusenumtype,Status>> is Accepted, this contains the heartbeat interval in seconds. If the CSMS returns something other than Accepted, the value of the interval field indicates the minimum wait time before sending a next BootNotification request.
     *
     */
    interval: number;
    status: RegistrationStatusEnumType;
    statusInfo?: StatusInfoType;
}
/**
 * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
 */
export interface CustomDataType {
    vendorId: string;
    [k: string]: unknown;
}
/**
 * Element providing more information about the status.
 *
 */
export interface StatusInfoType {
    customData?: CustomDataType;
    /**
     * A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
     *
     */
    reasonCode: string;
    /**
     * Additional text to provide detailed information.
     *
     */
    additionalInfo?: string;
}