ChargePointServiceSoap12 overview

tslint:disable:max-line-length no-empty-interface

Table of contents

utils

ICancelReservationInput (interface)

Signature

export interface ICancelReservationInput {
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  reservationId: number
}

ICancelReservationOutput (interface)

Signature

export interface ICancelReservationOutput {
  /** urn://Ocpp/Cp/2012/06/#CancelReservationStatus(Accepted,Rejected) */
  status: 'Accepted' | 'Rejected'
}

IChangeAvailabilityInput (interface)

Signature

export interface IChangeAvailabilityInput {
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  connectorId: number
  /** urn://Ocpp/Cp/2012/06/#AvailabilityType(Inoperative,Operative) */
  type: 'Inoperative' | 'Operative'
}

IChangeAvailabilityOutput (interface)

Signature

export interface IChangeAvailabilityOutput {
  /** urn://Ocpp/Cp/2012/06/#AvailabilityStatus(Accepted,Rejected,Scheduled) */
  status: 'Accepted' | 'Rejected' | 'Scheduled'
}

IChangeConfigurationInput (interface)

Signature

export interface IChangeConfigurationInput {
  /** urn://Ocpp/Cp/2012/06/#s:string(undefined) */
  key: string
  /** urn://Ocpp/Cp/2012/06/#s:string(undefined) */
  value: string
}

IChangeConfigurationOutput (interface)

Signature

export interface IChangeConfigurationOutput {
  /** urn://Ocpp/Cp/2012/06/#ConfigurationStatus(Accepted,Rejected,NotSupported) */
  status: 'Accepted' | 'Rejected' | 'NotSupported'
}

IChargePointServiceSoap12Soap (interface)

Signature

export interface IChargePointServiceSoap12Soap {
  UnlockConnector: (
    input: IUnlockConnectorInput,
    cb: (err: any | null, result: IUnlockConnectorOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  Reset: (
    input: IResetInput,
    cb: (err: any | null, result: IResetOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  ChangeAvailability: (
    input: IChangeAvailabilityInput,
    cb: (err: any | null, result: IChangeAvailabilityOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  GetDiagnostics: (
    input: IGetDiagnosticsInput,
    cb: (err: any | null, result: IGetDiagnosticsOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  ClearCache: (
    input: IClearCacheInput,
    cb: (err: any | null, result: IClearCacheOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  UpdateFirmware: (
    input: IUpdateFirmwareInput,
    cb: (err: any | null, result: IUpdateFirmwareOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  ChangeConfiguration: (
    input: IChangeConfigurationInput,
    cb: (err: any | null, result: IChangeConfigurationOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  RemoteStartTransaction: (
    input: IRemoteStartTransactionInput,
    cb: (err: any | null, result: IRemoteStartTransactionOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  RemoteStopTransaction: (
    input: IRemoteStopTransactionInput,
    cb: (err: any | null, result: IRemoteStopTransactionOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  CancelReservation: (
    input: ICancelReservationInput,
    cb: (err: any | null, result: ICancelReservationOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  DataTransfer: (
    input: IDataTransferInput,
    cb: (err: any | null, result: IDataTransferOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  GetConfiguration: (
    input: IGetConfigurationInput,
    cb: (err: any | null, result: IGetConfigurationOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  GetLocalListVersion: (
    input: IGetLocalListVersionInput,
    cb: (err: any | null, result: IGetLocalListVersionOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  ReserveNow: (
    input: IReserveNowInput,
    cb: (err: any | null, result: IReserveNowOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
  SendLocalList: (
    input: ISendLocalListInput,
    cb: (err: any | null, result: ISendLocalListOutput, raw: string, soapHeader: { [k: string]: any }) => any,
    options?: any,
    extraHeaders?: any
  ) => void
}

IClearCacheInput (interface)

Signature

export interface IClearCacheInput {}

IClearCacheOutput (interface)

Signature

export interface IClearCacheOutput {
  /** urn://Ocpp/Cp/2012/06/#ClearCacheStatus(Accepted,Rejected) */
  status: 'Accepted' | 'Rejected'
}

IDataTransferInput (interface)

Signature

export interface IDataTransferInput {
  /** urn://Ocpp/Cp/2012/06/#s:string(undefined) */
  vendorId: string
  /** urn://Ocpp/Cp/2012/06/#s:string(undefined) */
  messageId: string
  /** urn://Ocpp/Cp/2012/06/#s:string(undefined) */
  data: string
}

IDataTransferOutput (interface)

Signature

export interface IDataTransferOutput {
  /** urn://Ocpp/Cp/2012/06/#DataTransferStatus(Accepted,Rejected,UnknownMessageId,UnknownVendorId) */
  status: 'Accepted' | 'Rejected' | 'UnknownMessageId' | 'UnknownVendorId'
  /** urn://Ocpp/Cp/2012/06/#s:string(undefined) */
  data: string
}

IGetConfigurationInput (interface)

Signature

export interface IGetConfigurationInput {
  /** urn://Ocpp/Cp/2012/06/#s:string(undefined) */
  key: string
}

IGetConfigurationOutput (interface)

Signature

export interface IGetConfigurationOutput {
  configurationKey: ChargePointServiceSoap12Types.IconfigurationKey[]
  /** urn://Ocpp/Cp/2012/06/#s:string(undefined) */
  unknownKey: string
}

IGetDiagnosticsInput (interface)

Signature

export interface IGetDiagnosticsInput {
  /** urn://Ocpp/Cp/2012/06/#s:anyURI(undefined) */
  location: string
  /** urn://Ocpp/Cp/2012/06/#s:dateTime(undefined) */
  startTime: Date
  /** urn://Ocpp/Cp/2012/06/#s:dateTime(undefined) */
  stopTime: Date
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  retries: number
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  retryInterval: number
}

IGetDiagnosticsOutput (interface)

Signature

export interface IGetDiagnosticsOutput {
  /** urn://Ocpp/Cp/2012/06/#s:string(undefined) */
  fileName: string
}

IGetLocalListVersionInput (interface)

Signature

export interface IGetLocalListVersionInput {}

IGetLocalListVersionOutput (interface)

Signature

export interface IGetLocalListVersionOutput {
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  listVersion: number
}

IRemoteStartTransactionInput (interface)

Signature

export interface IRemoteStartTransactionInput {
  /** urn://Ocpp/Cp/2012/06/#IdToken(maxLength) */
  idTag: string
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  connectorId: number
}

IRemoteStartTransactionOutput (interface)

Signature

export interface IRemoteStartTransactionOutput {
  /** urn://Ocpp/Cp/2012/06/#RemoteStartStopStatus(Accepted,Rejected) */
  status: 'Accepted' | 'Rejected'
}

IRemoteStopTransactionInput (interface)

Signature

export interface IRemoteStopTransactionInput {
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  transactionId: number
}

IRemoteStopTransactionOutput (interface)

Signature

export interface IRemoteStopTransactionOutput {
  /** urn://Ocpp/Cp/2012/06/#RemoteStartStopStatus(Accepted,Rejected) */
  status: 'Accepted' | 'Rejected'
}

IReserveNowInput (interface)

Signature

export interface IReserveNowInput {
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  connectorId: number
  /** urn://Ocpp/Cp/2012/06/#s:dateTime(undefined) */
  expiryDate: Date
  /** urn://Ocpp/Cp/2012/06/#IdToken(maxLength) */
  idTag: string
  /** urn://Ocpp/Cp/2012/06/#IdToken(maxLength) */
  parentIdTag: string
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  reservationId: number
}

IReserveNowOutput (interface)

Signature

export interface IReserveNowOutput {
  /** urn://Ocpp/Cp/2012/06/#ReservationStatus(Accepted,Faulted,Occupied,Rejected,Unavailable) */
  status: 'Accepted' | 'Faulted' | 'Occupied' | 'Rejected' | 'Unavailable'
}

IResetInput (interface)

Signature

export interface IResetInput {
  /** urn://Ocpp/Cp/2012/06/#ResetType(Hard,Soft) */
  type: 'Hard' | 'Soft'
}

IResetOutput (interface)

Signature

export interface IResetOutput {
  /** urn://Ocpp/Cp/2012/06/#ResetStatus(Accepted,Rejected) */
  status: 'Accepted' | 'Rejected'
}

ISendLocalListInput (interface)

Signature

export interface ISendLocalListInput {
  /** urn://Ocpp/Cp/2012/06/#UpdateType(Differential,Full) */
  updateType: 'Differential' | 'Full'
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  listVersion: number
  localAuthorizationList: ChargePointServiceSoap12Types.IlocalAuthorizationList[]
}

ISendLocalListOutput (interface)

Signature

export interface ISendLocalListOutput {
  /** urn://Ocpp/Cp/2012/06/#UpdateStatus(Accepted,Failed,HashError,NotSupported,VersionMismatch) */
  status: 'Accepted' | 'Failed' | 'HashError' | 'NotSupported' | 'VersionMismatch'
}

ISetChargingProfileInput (interface)

Signature

export interface ISetChargingProfileInput {
  connectorId: number
  csChargingProfiles: {
    chargingProfileId: number
    transactionId?: number
    stackLevel: number
    chargingProfilePurpose: 'ChargePointMaxProfile' | 'TxDefaultProfile' | 'TxProfile'
    chargingProfileKind: 'Absolute' | 'Recurring' | 'Relative'
    recurrencyKind?: 'Daily' | 'Weekly'
    validFrom?: string
    validTo?: string
    chargingSchedule?: {
      duration?: number
      startSchedule?: string
      chargingRateUnit: 'A' | 'W'
      chargingSchedulePeriod: {
        startPeriod: number
        limit: number
        numberPhases?: number
        [k: string]: unknown
      }[]
      minChargingRate?: number
      [k: string]: unknown
    }
    [k: string]: unknown
  }
}

ISetChargingProfileOutput (interface)

Signature

export interface ISetChargingProfileOutput {}

IUnlockConnectorInput (interface)

Signature

export interface IUnlockConnectorInput {
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  connectorId: number
}

IUnlockConnectorOutput (interface)

Signature

export interface IUnlockConnectorOutput {
  /** urn://Ocpp/Cp/2012/06/#UnlockStatus(Accepted,Rejected) */
  status: 'Accepted' | 'Rejected'
}

IUpdateFirmwareInput (interface)

Signature

export interface IUpdateFirmwareInput {
  /** urn://Ocpp/Cp/2012/06/#s:dateTime(undefined) */
  retrieveDate: Date
  /** urn://Ocpp/Cp/2012/06/#s:anyURI(undefined) */
  location: string
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  retries: number
  /** urn://Ocpp/Cp/2012/06/#s:int(undefined) */
  retryInterval: number
}

IUpdateFirmwareOutput (interface)

Signature

export interface IUpdateFirmwareOutput {}