ocpp-standard-schema

Version:

Contains OCPP JSON schemas for validation purposes

35 lines (34 loc) • 990 B

TypeScript

/**
 * Returns whether the Charging Station has been able to remove the message.
 *
 */
export declare type ClearMessageStatusEnumType = 'Accepted' | 'Unknown';
export default interface ClearDisplayMessageResponse {
    customData?: CustomDataType;
    status: ClearMessageStatusEnumType;
    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;
}