ocpp-standard-schema
Version:
Contains OCPP JSON schemas for validation purposes
70 lines (69 loc) • 2.28 kB
TypeScript
/**
* This field specifies the connector type.
*
*/
export declare type ConnectorEnumType = 'cCCS1' | 'cCCS2' | 'cG105' | 'cTesla' | 'cType1' | 'cType2' | 's309-1P-16A' | 's309-1P-32A' | 's309-3P-16A' | 's309-3P-32A' | 'sBS1361' | 'sCEE-7-7' | 'sType2' | 'sType3' | 'Other1PhMax16A' | 'Other1PhOver16A' | 'Other3Ph' | 'Pan' | 'wInductive' | 'wResonant' | 'Undetermined' | 'Unknown';
/**
* Enumeration of possible idToken types.
*
*/
export declare type IdTokenEnumType = 'Central' | 'eMAID' | 'ISO14443' | 'ISO15693' | 'KeyCode' | 'Local' | 'MacAddress' | 'NoAuthorization';
export default interface ReserveNowRequest {
customData?: CustomDataType;
/**
* Id of reservation.
*
*/
id: number;
/**
* Date and time at which the reservation expires.
*
*/
expiryDateTime: string;
connectorType?: ConnectorEnumType;
idToken: IdTokenType;
/**
* This contains ID of the evse to be reserved.
*
*/
evseId?: number;
groupIdToken?: IdTokenType;
}
/**
* 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;
}
/**
* Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.
*
*/
export interface IdTokenType {
customData?: CustomDataType;
additionalInfo?: [AdditionalInfoType, ...AdditionalInfoType[]];
/**
* IdToken is case insensitive. Might hold the hidden id of an RFID tag, but can for example also contain a UUID.
*
*/
idToken: string;
type: IdTokenEnumType;
}
/**
* Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.
*
*/
export interface AdditionalInfoType {
customData?: CustomDataType;
/**
* This field specifies the additional IdToken.
*
*/
additionalIdToken: string;
/**
* This defines the type of the additionalIdToken. This is a custom type, so the implementation needs to be agreed upon by all involved parties.
*
*/
type: string;
}