OICP Version 2.2 for Emobility Service Providers V002
Total Page:16
File Type:pdf, Size:1020Kb
Open intercharge Protocol for Emobility Service Providers VERSION 2.2 / MARCH 2018 ©HUBJECT GMBH OICP Version 2.2 for Emobility Service Providers_v002 Table of Contents Table of Contents Table of Contents ..................................................................................................................................... 2 1 Introduction .................................................................................................................................. 7 1.1 The Hubject Platform ................................................................................................................. 7 1.2 The Emobility Service Provider (EMP) ...................................................................................... 8 1.3 Scope ......................................................................................................................................... 8 1.4 Conventions ............................................................................................................................... 9 1.5 Overview .................................................................................................................................... 9 1.6 Release management .............................................................................................................. 11 1.7 Further documents ................................................................................................................... 12 1.8 OICP protocol version and service versions ............................................................................ 12 1.9 Overview of Document Reviews .............................................................................................. 13 2 Communication paradigms ....................................................................................................... 14 2.1 SOAP and REST ..................................................................................................................... 14 2.2 Security .................................................................................................................................... 14 2.3 Availability ................................................................................................................................ 14 2.4 Error handling........................................................................................................................... 14 2.5 Status codes ............................................................................................................................ 15 2.6 Session handling ...................................................................................................................... 15 2.7 ProviderIDs and OperatorIDs................................................................................................... 16 2.8 Hub Provider and Hub Operator .............................................................................................. 18 2.9 Data push operations ............................................................................................................... 19 2.10 Time zones............................................................................................................................... 20 3 Services and Operations ........................................................................................................... 21 3.1 eRoamingAuthorization_V2.1 .................................................................................................. 21 3.1.1 eRoamingAuthorizeStart .............................................................................................. 21 3.1.2 eRoamingAuthorizeStop............................................................................................... 24 3.1.3 eRoamingAuthorizeRemoteStart .................................................................................. 24 3.1.4 eRoamingAuthorizeRemoteStop .................................................................................. 25 3.1.5 eRoamingChargeDetailRecord .................................................................................... 26 3.1.6 eRoamingGetChargeDetailRecords ............................................................................. 27 3.2 eRoamingReservation_V1.1 .................................................................................................... 28 3.2.1 eRoamingAuthorizeRemoteReservationStart .............................................................. 28 3.2.2 eRoamingAuthorizeRemoteReservationStop............................................................... 29 3.3 eRoamingAuthenticationData_V2.1 ......................................................................................... 30 3.3.1 eRoamingPushAuthenticationData .............................................................................. 30 © Hubject GmbH 2 OICP Version 2.2 for Emobility Service Providers_v002 Table of Contents 3.4 eRoamingEVSEData_V2.2 ...................................................................................................... 32 3.4.1 eRoamingPullEVSEData .............................................................................................. 32 3.5 eRoamingEVSEStatus_V2.1 ................................................................................................... 33 3.5.1 eRoamingPullEVSEStatus ........................................................................................... 33 3.5.2 eRoamingPullEVSEStatusById .................................................................................... 34 3.5.3 eRoamingPullEVSEStatusByOperatorID ..................................................................... 34 3.6 eRoamingDynamicPricing_V1.0 .............................................................................................. 35 3.6.1 eRoamingPullPricingProductData ................................................................................ 36 3.6.2 eRoamingPullEVSEPricing .......................................................................................... 36 4 Messages .................................................................................................................................... 37 4.1 Mandatory messages to be sent by EMPs .............................................................................. 37 4.1.1 eRoamingPushAuthenticationData .............................................................................. 37 4.1.2 eRoamingPullEVSEData .............................................................................................. 38 4.1.3 eRoamingPullEVSEStatus ........................................................................................... 39 4.1.4 eRoamingAuthorizeRemoteStart .................................................................................. 40 4.1.5 eRoamingAuthorizeRemoteStop .................................................................................. 41 4.1.6 eRoamingGetChargeDetailRecords ............................................................................. 42 4.1.7 eRoamingAuthorizationStart ........................................................................................ 43 4.1.8 eRoamingAuthorizationStop ......................................................................................... 44 4.2 Mandatory messages to be received by EMPs ....................................................................... 46 4.2.1 eRoamingChargeDetailRecord .................................................................................... 46 4.2.2 eRoamingAuthorizeStart .............................................................................................. 48 4.2.3 eRoamingAuthorizeStop............................................................................................... 50 4.2.4 eRoamingEVSEData .................................................................................................... 51 4.2.5 eRoamingEVSEStatus ................................................................................................. 51 4.2.6 eRoamingAcknowledgement ........................................................................................ 52 4.3 Optional messages to be sent by EMPs .................................................................................. 53 4.3.1 eRoamingPullEVSEStatusByID ................................................................................... 53 4.3.2 eRoamingAuthorizeRemoteReservationStart .............................................................. 53 4.3.3 eRoamingAuthorizeRemoteReservationStop............................................................... 55 4.3.4 eRoamingPullEVSEStatusByOperatorID ..................................................................... 56 4.3.5 eRoamingPullPricingProductData ................................................................................ 56 4.3.6 eRoamingPullEVSEPricing .......................................................................................... 57 4.4 Optional messages to be received by EMPs ........................................................................... 58 4.4.1 eRoamingEVSEStatusByID ......................................................................................... 58 4.4.2 eRoamingEVSEStatusByOperatorID ........................................................................... 59 4.4.3 eRoamingPricingProductData ...................................................................................... 60 4.4.4 eRoamingEVSEPricing................................................................................................