Open Intercharge Protocol for Charge Point Operators
Total Page:16
File Type:pdf, Size:1020Kb
Open intercharge Protocol for Charge Point Operators VERSION 2.2 / MARCH 2018 ©HUBJECT GMBH OICP Version 2.2 for Charge Point Operators_v002 Table of Contents Table of Contents Table of Contents ..................................................................................................................................... 2 1 Introduction .................................................................................................................................. 6 1.1 The Hubject Platform ................................................................................................................. 6 1.2 The Charge Point Operator (CPO) ............................................................................................ 7 1.3 Scope ......................................................................................................................................... 7 1.4 Conventions ............................................................................................................................... 8 1.5 Overview .................................................................................................................................... 8 1.6 Release management .............................................................................................................. 10 1.7 Further documents ................................................................................................................... 11 1.8 OICP protocol version and service versions ............................................................................ 11 1.9 Overview of Document Reviews .............................................................................................. 12 2 Communication paradigms ....................................................................................................... 13 2.1 SOAP and REST ..................................................................................................................... 13 2.2 Security .................................................................................................................................... 13 2.3 Availability ................................................................................................................................ 13 2.4 Error handling........................................................................................................................... 13 2.5 Status codes ............................................................................................................................ 14 2.6 Session handling ...................................................................................................................... 14 2.7 ProviderIDs and OperatorIDs................................................................................................... 15 2.8 Hub Provider and Hub Operator .............................................................................................. 17 2.9 Data push operations ............................................................................................................... 18 2.10 Time zones............................................................................................................................... 19 3 Services and Operations ........................................................................................................... 20 3.1 eRoamingAuthorization_V2.1 .................................................................................................. 20 3.1.1 eRoamingAuthorizeStart .............................................................................................. 20 3.1.2 eRoamingAuthorizeStop............................................................................................... 23 3.1.3 eRoamingAuthorizeRemoteStart .................................................................................. 23 3.1.4 eRoamingAuthorizeRemoteStop .................................................................................. 24 3.1.5 eRoamingChargeDetailRecord .................................................................................... 25 3.2 eRoamingReservation_V1.1 .................................................................................................... 26 3.2.1 eRoamingAuthorizeRemoteReservationStart .............................................................. 26 3.2.2 eRoamingAuthorizeRemoteReservationStop............................................................... 27 3.3 eRoamingEvseData_V2.2 ........................................................................................................ 28 3.3.1 eRoamingPushEvseData ............................................................................................. 28 3.4 eRoamingEvseStatus_V2.1 ..................................................................................................... 29 © Hubject GmbH 2 OICP Version 2.2 for Charge Point Operators_v002 Table of Contents 3.4.1 eRoamingPushEvseStatus ........................................................................................... 29 3.5 eRoamingDynamicPricing_V1.0 .............................................................................................. 30 3.5.1 eRoamingPushPricingProductData .............................................................................. 31 3.5.1 eRoamingPushEVSEPricing ........................................................................................ 31 4 Messages .................................................................................................................................... 33 4.1 Mandatory messages to be sent by CPOs .............................................................................. 33 4.1.1 eRoamingPushEvseData ............................................................................................. 33 4.1.2 eRoamingPushEvseStatus ........................................................................................... 34 4.1.3 eRoamingAuthorizeStart .............................................................................................. 35 4.1.4 eRoamingChargeDetailRecord .................................................................................... 36 4.1.5 eRoamingAcknowledgement ........................................................................................ 38 4.2 Mandatory messages to be received by CPOs ....................................................................... 39 4.2.1 eRoamingAuthorizeRemoteStart .................................................................................. 39 4.2.2 eRoamingAuthorizeRemoteStop .................................................................................. 41 4.2.3 eRoamingAuthorizationStart ........................................................................................ 42 4.2.4 eRoamingAcknowledgement ........................................................................................ 44 4.3 Optional messages to be sent by CPOs .................................................................................. 45 4.3.1 eRoamingAuthorizeStop............................................................................................... 45 4.3.2 eRoamingPushPricingProductData .............................................................................. 46 4.3.3 eRoamingPushEVSEPricing ........................................................................................ 47 4.4 Optional messages to be received by CPOs ........................................................................... 48 4.4.1 eRoamingAuthorizeRemoteReservationStart .............................................................. 48 4.4.2 eRoamingAuthorizeRemoteReservationStop............................................................... 50 4.4.3 eRoamingAuthorizationStop ......................................................................................... 51 5 Data Types .................................................................................................................................. 52 5.1 Complex Data Types ............................................................................................................... 52 5.1.1 StatusCodeType ........................................................................................................... 52 5.1.2 IdentificationType ......................................................................................................... 52 5.1.3 EvseMatchType ............................................................................................................ 53 5.1.4 GeoCoordinatesType ................................................................................................... 53 5.1.5 GeoCoordinatesGoogleType ........................................................................................ 54 5.1.6 GeoCoordinatesDecimalDegreeType .......................................................................... 55 5.1.7 GeoCoordinatesDegreeMinuteSecondsType .............................................................. 55 5.1.8 ProviderAuthenticationDataType .................................................................................. 55 5.1.9 AuthenticationDataRecordType ................................................................................... 55 5.1.10 RFIDmifarefamilyIdentificationType ............................................................................. 56 5.1.11 QRCodeIdentificationType ..........................................................................................