diff --git a/docs/example-implementations/ev-charging.md b/docs/example-implementations/1_EV_charging.md similarity index 87% rename from docs/example-implementations/ev-charging.md rename to docs/example-implementations/1_EV_charging.md index 9309f5d2..97928d07 100644 --- a/docs/example-implementations/ev-charging.md +++ b/docs/example-implementations/1_EV_charging.md @@ -138,15 +138,16 @@ In beckn protocol, the search intent generated by the EV User Platform (BAP) is ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "search", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -156,29 +157,39 @@ In beckn protocol, the search intent generated by the EV User Platform (BAP) is }, "message": { "intent": { + "category": { + "descriptor": { + "code": "green-tariff" + } + }, "item": { "descriptor": { "code": "energy" }, "quantity": { - "required": { - "value": "4.0", - "unit": "kWH" - } - }, - "category": { - "descriptor": { - "code": "green-tariff" + "available": { + "measure": { + "unit": "kWH", + "value": "4.0" + } } } }, - "location": { - "gps": "12.423423,77.325647", - "radius": { - "type": "CONSTANT", - "value": "5", - "unit": "km" - } + "fulfillment": { + "stops": [ + { + "location": { + "circle": { + "gps": "12.423423,77.325647", + "radius": { + "type": "CONSTANT", + "value": "5", + "unit": "km" + } + } + } + } + ] } } } @@ -190,15 +201,16 @@ In beckn protocol, the search intent generated by the EV User Platform (BAP) is ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_search", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -222,15 +234,6 @@ In beckn protocol, the search intent generated by the EV User Platform (BAP) is } ] }, - "categories": [ - { - "id": "1", - "descriptor": { - "code": "green-tariff", - "name": "green tariff" - } - } - ], "locations": [ { "id": "1", @@ -241,39 +244,13 @@ In beckn protocol, the search intent generated by the EV User Platform (BAP) is "gps": "12.247934,77.876987" } ], - "items": [ + "categories": [ { - "id": "pe-charging-01", + "id": "1", "descriptor": { - "code": "energy" - }, - "price": { - "value": "8", - "currency": "INR / kWH" - }, - "quantity": { - "available": { - "measure": { - "value": "100", - "unit": "kWH" - } - } - }, - "category_ids": ["1"], - "location_ids": ["1", "2"], - "fulfillment_ids": ["1", "2"], - "add_ons": [ - { - "id": "pe-charging-01-addon-1", - "descriptor": { - "name": "Free car wash" - }, - "price": { - "value": "0", - "currency": "INR" - } - } - ] + "code": "green-tariff", + "name": "green tariff" + } } ], "fulfillments": [ @@ -284,13 +261,13 @@ In beckn protocol, the search intent generated by the EV User Platform (BAP) is { "type": "start", "time": { - "timestamp": "01-06-2023 10:00:00" + "timestamp": "2023-06-01T10:00:00Z" } }, { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00" + "timestamp": "2023-06-01T10:00:00Z" } } ], @@ -338,13 +315,13 @@ In beckn protocol, the search intent generated by the EV User Platform (BAP) is { "type": "start", "time": { - "timestamp": "01-06-2023 10:00:00" + "timestamp": "2023-06-01T10:00:00Z" } }, { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00" + "timestamp": "2023-06-01T10:00:00Z" } } ], @@ -383,21 +360,6 @@ In beckn protocol, the search intent generated by the EV User Platform (BAP) is } ] } - ] - }, - { - "id": "log9.in", - "descriptor": { - "name": "Log9 Inc" - }, - "categories": [ - { - "id": "1", - "descriptor": { - "code": "green-tariff", - "name": "green tariff" - } - } ], "items": [ { @@ -406,19 +368,33 @@ In beckn protocol, the search intent generated by the EV User Platform (BAP) is "code": "energy" }, "price": { - "value": "10", - "currency": "INR / kWH" + "value": "8", + "currency": "INR/kWH" }, "quantity": { - "available": "1000" + "available": { + "measure": { + "unit": "kWH", + "value": "100" + } + } }, - "category_ids": ["1"], - "fulfillment_ids": ["3", "4"], + "category_ids": [ + "1" + ], + "location_ids": [ + "1", + "2" + ], + "fulfillment_ids": [ + "1", + "2" + ], "add_ons": [ { "id": "pe-charging-01-addon-1", "descriptor": { - "name": "Free tyre pressure check" + "name": "Free car wash" }, "price": { "value": "0", @@ -427,6 +403,21 @@ In beckn protocol, the search intent generated by the EV User Platform (BAP) is } ] } + ] + }, + { + "id": "log9.in", + "descriptor": { + "name": "Log9 Inc" + }, + "categories": [ + { + "id": "1", + "descriptor": { + "code": "green-tariff", + "name": "green tariff" + } + } ], "fulfillments": [ { @@ -446,12 +437,51 @@ In beckn protocol, the search intent generated by the EV User Platform (BAP) is "stops": [ { "location": { - "url": "https://log9.in/track/bswap/3234242" + "map_url": "https://log9.in/track/bswap/3234242" } } ] } - ] + ], + "items": [ + { + "id": "pe-charging-01", + "descriptor": { + "code": "energy" + }, + "price": { + "value": "10", + "currency": "INR / kWH" + }, + "quantity": { + "available": { + "measure": { + "unit": "kWH", + "value": "1000" + } + } + }, + "category_ids": [ + "1" + ], + "fulfillment_ids": [ + "3", + "4" + ], + "add_ons": [ + { + "id": "pe-charging-01-addon-1", + "descriptor": { + "name": "Free tyre pressure check" + }, + "price": { + "value": "0", + "currency": "INR" + } + } + ] + } + ] } ] } @@ -515,15 +545,16 @@ The below diagram illustrates the logical interactions between a EV user and Pro ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "select", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -548,7 +579,17 @@ The below diagram illustrates the logical interactions between a EV user and Pro "unit": "kWh" } } - } + }, + "add_ons": [ + { + "id": "pe-charging-01-addon-1" + } + ] + } + ], + "fulfillments": [ + { + "id": "1" } ] } @@ -561,15 +602,16 @@ The below diagram illustrates the logical interactions between a EV user and Pro ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_select", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -581,7 +623,7 @@ The below diagram illustrates the logical interactions between a EV user and Pro }, "message": { "order": { - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -638,13 +680,13 @@ The below diagram illustrates the logical interactions between a EV user and Pro { "type": "start", "time": { - "timestamp": "01-06-2023 10:00:00" + "timestamp": "2023-06-01T10:00:00" } }, { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00" + "timestamp": "2023-06-01T10:00:00" } } ], @@ -694,6 +736,7 @@ The below diagram illustrates the logical interactions between a EV user and Pro "breakup": [ { "item": { + "id": "pe-charging-01", "descriptor": { "name": "Estimated units consumed" }, @@ -713,6 +756,11 @@ The below diagram illustrates the logical interactions between a EV user and Pro }, { "item": { + "add_ons": [ + { + "id": "pe-charging-01-addon-1" + } + ], "descriptor": { "name": "Free car wash" } @@ -765,15 +813,16 @@ In this stage, the User provides the required information and initiates the orde ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "init", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -790,7 +839,20 @@ In this stage, the User provides the required information and initiates the orde }, "items": [ { - "id": "pe-charging-01" + "id": "pe-charging-01", + "quantity": { + "selected": { + "measure": { + "value": "4", + "unit": "kWh" + } + } + }, + "add_ons": [ + { + "id": "pe-charging-01-addon-1" + } + ] } ], "billing": { @@ -821,15 +883,16 @@ In this stage, the User provides the required information and initiates the orde ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_init", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -841,7 +904,7 @@ In this stage, the User provides the required information and initiates the orde }, "message": { "order": { - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -877,7 +940,19 @@ In this stage, the User provides the required information and initiates the orde } } }, - "fulfillments": ["1"] + "add_ons": [ + { + "id": "pe-charging-01-addon-1", + "descriptor": { + "code": "add-on-item", + "name": "Free car wash" + }, + "price": { + "value": "0", + "currency": "INR" + } + } + ] } ], "fulfillments": [ @@ -901,13 +976,13 @@ In this stage, the User provides the required information and initiates the orde { "type": "start", "time": { - "timestamp": "01-06-2023 10:00:00" + "timestamp": "2023-06-01T10:00:00" } }, { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00" + "timestamp": "2023-06-01T10:00:00" } } ], @@ -949,7 +1024,7 @@ In this stage, the User provides the required information and initiates the orde ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { @@ -1069,109 +1144,16 @@ Post payment user will activates the confirmed order ```json { "context": { - "domain": "dent:0.1.0", - "action": "confirm", - "location": { - "country": { - "name": "India", - "code": "IND" - } - }, - "city": "std:080", - "version": "1.1.0", - "bap_id": "example-bap.com", - "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", - "bpp_id": "chargezone-energy-bpp.com", - "bpp_uri": "https://api.example-bpp.com/pilot/bpp/", - "transaction_id": "6743e9e2-4fb5-487c-92b7-13ba8018f176", - "message_id": "6743e9e2-4fb5-487c-92b7-13ba8018f176", - "timestamp": "2023-07-16T04:41:16Z" - }, - "message": { - "order": { - "providers": { - "id": "chargezone.in" - }, - "items": [ - { - "id": "pe-charging-01" - } - ], - "billing": { - "name": "John Doe", - "email": "abc@example.com", - "number": "+91-9876522222" - }, - "fulfillments": [ - { - "id": "1", - "customer": { - "person": { - "name": "John Doe" - }, - "contact": { - "phone": "+91-9887766554" - } - } - } - ], - "payments": [ - { - "collected_by": "BPP", - "params": { - "amount": "40", - "currency": "INR" - }, - "status": "PAID", - "type": "PRE-ORDER" - } - ], - "quote": { - "price": { - "value": "40", - "currency": "INR" - }, - "breakup": [ - { - "item": { - "descriptor": { - "name": "Estimated units consumed" - }, - "quantity": { - "selected": { - "measure": { - "value": "4", - "unit": "kWh" - } - } - } - }, - "price": { - "value": "32", - "currency": "INR" - } - } - ] - } - } - } -} -``` - -#### Example `on_confirm` api json: - -```json -{ - "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_confirm", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -1184,7 +1166,7 @@ Post payment user will activates the confirmed order "message": { "order": { "id": "6743e9e2-4fb5-487c-92b7", - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -1220,7 +1202,19 @@ Post payment user will activates the confirmed order } } }, - "fulfillments": ["1"] + "add_ons": [ + { + "id": "pe-charging-01-addon-1", + "descriptor": { + "code": "add-on-item", + "name": "Free car wash" + }, + "price": { + "value": "0", + "currency": "INR" + } + } + ] } ], "fulfillments": [ @@ -1247,10 +1241,10 @@ Post payment user will activates the confirmed order "gps": "12.423423,77.325647" }, "time": { - "timestamp": "01-06-2023 10:00:00", + "timestamp": "2023-06-01T10:00:00", "range": { - "start": "01-06-2023 10:00:00", - "end": "01-06-2023 10:10:00" + "start": "2023-06-01T10:00:00", + "end": "2023-06-01T10:10:00" } }, "instructions": { @@ -1261,10 +1255,10 @@ Post payment user will activates the confirmed order { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00", + "timestamp": "2023-06-01T10:30:00", "range": { - "start": "01-06-2023 10:30:00", - "end": "01-06-2023 10:40:00" + "start": "2023-06-01T10:30:00", + "end": "2023-06-01T10:40:00" } } } @@ -1307,7 +1301,7 @@ Post payment user will activates the confirmed order ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { @@ -1338,75 +1332,34 @@ Post payment user will activates the confirmed order }, "payments": [ { - "type": "PRE-ORDER", - "status": "PAID", - "params": { - "amount": "40", - "currency": "INR" - }, - "time": { - "range": { - "start": "2023-08-10T10:00:00Z", - "end": "2023-08-10T10:30:00Z" - } - } - } - ], - "cancellation_terms": [ - { - "fulfillment_state": { - "descriptor": { - "code": "charging-start" - } - }, - "cancellation_fee": { - "percentage": "30%" - }, - "external_ref": { - "mimetype": "text/html", - "url": "https://chargezone.in/charge/tnc.html" - } - } - ] - } - } -} -``` - -#### Example `update` api json to start charging: - -```json -{ - "context": { - "domain": "dent:0.1.0", - "action": "update", - "location": { - "country": { - "name": "India", - "code": "IND" - } - }, - "city": "std:080", - "version": "1.1.0", - "bap_id": "example-bap.com", - "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", - "bpp_id": "chargezone-energy-bpp.com", - "bpp_uri": "https://api.example-bpp.com/pilot/bpp/", - "transaction_id": "6743e9e2-4fb5-487c-92b7-13ba8018f176", - "message_id": "6743e9e2-4fb5-487c-92b7-13ba8018f176", - "timestamp": "2023-07-16T04:41:16Z" - }, - "message": { - "update_target": "order.fulfillments[0].state", - "order": { - "fulfillments": [ - { - "id": "1", - "type": "CHARGING", - "state": { + "type": "PRE-ORDER", + "status": "PAID", + "params": { + "amount": "40", + "currency": "INR", + "transaction_id": "asjdhw8e238e3" + }, + "time": { + "range": { + "start": "2023-08-10T10:00:00Z", + "end": "2023-08-10T10:30:00Z" + } + } + } + ], + "cancellation_terms": [ + { + "fulfillment_state": { "descriptor": { - "code": "start-charging" + "code": "charging-start" } + }, + "cancellation_fee": { + "percentage": "30%" + }, + "external_ref": { + "mimetype": "text/html", + "url": "https://chargezone.in/charge/tnc.html" } } ] @@ -1415,20 +1368,21 @@ Post payment user will activates the confirmed order } ``` -#### Example `on_update` api json: +#### Example `on_confirm` api json: ```json { "context": { - "domain": "dent:0.1.0", - "action": "on_update", + "domain": "uei:ev-charging", + "action": "on_confirm", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -1441,7 +1395,7 @@ Post payment user will activates the confirmed order "message": { "order": { "id": "6743e9e2-4fb5-487c-92b7", - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -1477,7 +1431,19 @@ Post payment user will activates the confirmed order } } }, - "fulfillments": ["1"] + "add_ons": [ + { + "id": "pe-charging-01-addon-1", + "descriptor": { + "code": "add-on-item", + "name": "Free car wash" + }, + "price": { + "value": "0", + "currency": "INR" + } + } + ] } ], "fulfillments": [ @@ -1494,7 +1460,7 @@ Post payment user will activates the confirmed order "type": "CHARGING", "state": { "descriptor": { - "code": "charging-started" + "code": "payment-completed" } }, "stops": [ @@ -1504,20 +1470,24 @@ Post payment user will activates the confirmed order "gps": "12.423423,77.325647" }, "time": { - "timestamp": "01-06-2023 10:00:00", + "timestamp": "2023-06-01T10:00:00", "range": { - "start": "01-06-2023 10:00:00", - "end": "01-06-2023 10:10:00" + "start": "2023-06-01T10:00:00", + "end": "2023-06-01T10:10:00" } + }, + "instructions": { + "name": "Charging instructions", + "short_desc": "To start your charging, go to charger number 987, and click on 'start' on your app" } }, { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00", + "timestamp": "2023-06-01T10:30:00", "range": { - "start": "01-06-2023 10:30:00", - "end": "01-06-2023 10:40:00" + "start": "2023-06-01T10:30:00", + "end": "2023-06-01T10:40:00" } } } @@ -1560,7 +1530,7 @@ Post payment user will activates the confirmed order ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { @@ -1595,7 +1565,8 @@ Post payment user will activates the confirmed order "status": "PAID", "params": { "amount": "40", - "currency": "INR" + "currency": "INR", + "transaction_id": "asjdhw8e238e3" }, "time": { "range": { @@ -1626,20 +1597,21 @@ Post payment user will activates the confirmed order } ``` -#### Example `update` api json to stop charging: +#### Example `update` api json to start charging: ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "update", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -1655,9 +1627,10 @@ Post payment user will activates the confirmed order "fulfillments": [ { "id": "1", + "type": "CHARGING", "state": { "descriptor": { - "code": "end-charging" + "code": "start-charging" } } } @@ -1672,15 +1645,16 @@ Post payment user will activates the confirmed order ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_update", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -1693,7 +1667,7 @@ Post payment user will activates the confirmed order "message": { "order": { "id": "6743e9e2-4fb5-487c-92b7", - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -1729,7 +1703,19 @@ Post payment user will activates the confirmed order } } }, - "fulfillments": ["1"] + "add_ons": [ + { + "id": "pe-charging-01-addon-1", + "descriptor": { + "code": "add-on-item", + "name": "Free car wash" + }, + "price": { + "value": "0", + "currency": "INR" + } + } + ] } ], "fulfillments": [ @@ -1746,7 +1732,7 @@ Post payment user will activates the confirmed order "type": "CHARGING", "state": { "descriptor": { - "code": "charging-ended" + "code": "charging-started" } }, "stops": [ @@ -1756,20 +1742,20 @@ Post payment user will activates the confirmed order "gps": "12.423423,77.325647" }, "time": { - "timestamp": "01-06-2023 10:00:00", + "timestamp": "2023-06-01T10:00:00", "range": { - "start": "01-06-2023 10:00:00", - "end": "01-06-2023 10:10:00" + "start": "2023-06-01T10:00:00", + "end": "2023-06-01T10:10:00" } } }, { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00", + "timestamp": "2023-06-01T10:30:00", "range": { - "start": "01-06-2023 10:30:00", - "end": "01-06-2023 10:40:00" + "start": "2023-06-01T10:30:00", + "end": "2023-06-01T10:40:00" } } } @@ -1812,7 +1798,7 @@ Post payment user will activates the confirmed order ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { @@ -1847,7 +1833,8 @@ Post payment user will activates the confirmed order "status": "PAID", "params": { "amount": "40", - "currency": "INR" + "currency": "INR", + "transaction_id": "asjdhw8e238e3" }, "time": { "range": { @@ -1878,20 +1865,21 @@ Post payment user will activates the confirmed order } ``` -#### Example `status` api json: +#### Example `update` api json to stop charging: ```json { "context": { - "domain": "dent:0.1.0", - "action": "status", + "domain": "uei:ev-charging", + "action": "update", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -1902,25 +1890,38 @@ Post payment user will activates the confirmed order "timestamp": "2023-07-16T04:41:16Z" }, "message": { - "order_id": "6743e9e2-4fb5-487c-92b7" + "update_target": "order.fulfillments[0].state", + "order": { + "fulfillments": [ + { + "id": "1", + "state": { + "descriptor": { + "code": "end-charging" + } + } + } + ] + } } } ``` -#### Example `on_status` api json: +#### Example `on_update` api json: ```json { "context": { - "domain": "dent:0.1.0", - "action": "on_status", + "domain": "uei:ev-charging", + "action": "on_update", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -1933,7 +1934,7 @@ Post payment user will activates the confirmed order "message": { "order": { "id": "6743e9e2-4fb5-487c-92b7", - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -1969,7 +1970,19 @@ Post payment user will activates the confirmed order } } }, - "fulfillments": ["1"] + "add_ons": [ + { + "id": "pe-charging-01-addon-1", + "descriptor": { + "code": "add-on-item", + "name": "Free car wash" + }, + "price": { + "value": "0", + "currency": "INR" + } + } + ] } ], "fulfillments": [ @@ -1986,7 +1999,7 @@ Post payment user will activates the confirmed order "type": "CHARGING", "state": { "descriptor": { - "name": "vehicle 65% charged" + "code": "charging-ended" } }, "stops": [ @@ -1996,20 +2009,20 @@ Post payment user will activates the confirmed order "gps": "12.423423,77.325647" }, "time": { - "timestamp": "01-06-2023 10:00:00", + "timestamp": "2023-06-01T10:00:00", "range": { - "start": "01-06-2023 10:00:00", - "end": "01-06-2023 10:10:00" + "start": "2023-06-01T10:00:00", + "end": "2023-06-01T10:10:00" } } }, { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00", + "timestamp": "2023-06-01T10:30:00", "range": { - "start": "01-06-2023 10:30:00", - "end": "01-06-2023 10:40:00" + "start": "2023-06-01T10:30:00", + "end": "2023-06-01T10:40:00" } } } @@ -2052,11 +2065,11 @@ Post payment user will activates the confirmed order ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { - "value": "32", + "value": "40", "currency": "INR" }, "breakup": [ @@ -2087,7 +2100,8 @@ Post payment user will activates the confirmed order "status": "PAID", "params": { "amount": "40", - "currency": "INR" + "currency": "INR", + "transaction_id": "asjdhw8e238e3" }, "time": { "range": { @@ -2118,20 +2132,21 @@ Post payment user will activates the confirmed order } ``` -#### Example `cancel` api json: +#### Example `status` api json: ```json { "context": { - "domain": "dent:0.1.0", - "action": "cancel", + "domain": "uei:ev-charging", + "action": "status", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -2142,31 +2157,26 @@ Post payment user will activates the confirmed order "timestamp": "2023-07-16T04:41:16Z" }, "message": { - "order": { - "cancellation_reason_id": "5", - "descriptor": { - "short_desc": "Can't make it on time" - }, - "order_id": "6743e9e2-4fb5-487c-92b7" - } + "order_id": "6743e9e2-4fb5-487c-92b7" } } ``` -#### Example `on_cancel` api json: +#### Example `on_status` api json: ```json { "context": { - "domain": "dent:0.1.0", - "action": "on_cancel", + "domain": "uei:ev-charging", + "action": "on_status", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -2179,8 +2189,7 @@ Post payment user will activates the confirmed order "message": { "order": { "id": "6743e9e2-4fb5-487c-92b7", - "status": "CANCELLED", - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -2216,7 +2225,19 @@ Post payment user will activates the confirmed order } } }, - "fulfillments": ["1"] + "add_ons": [ + { + "id": "pe-charging-01-addon-1", + "descriptor": { + "code": "add-on-item", + "name": "Free car wash" + }, + "price": { + "value": "0", + "currency": "INR" + } + } + ] } ], "fulfillments": [ @@ -2233,15 +2254,30 @@ Post payment user will activates the confirmed order "type": "CHARGING", "state": { "descriptor": { - "code": "order-cancelled" + "name": "vehicle 65% charged" } }, "stops": [ { + "type": "start", + "location": { + "gps": "12.423423,77.325647" + }, + "time": { + "timestamp": "2023-06-01T10:00:00", + "range": { + "start": "2023-06-01T10:00:00", + "end": "2023-06-01T10:10:00" + } + } + }, + { + "type": "end", "time": { + "timestamp": "2023-06-01T10:30:00", "range": { - "start": "10:00", - "end": "10:30" + "start": "2023-06-01T10:00:00", + "end": "2023-06-01T10:40:00" } } } @@ -2284,11 +2320,11 @@ Post payment user will activates the confirmed order ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { - "value": "40", + "value": "32", "currency": "INR" }, "breakup": [ @@ -2319,7 +2355,8 @@ Post payment user will activates the confirmed order "status": "PAID", "params": { "amount": "40", - "currency": "INR" + "currency": "INR", + "transaction_id": "asjdhw8e238e3" }, "time": { "range": { @@ -2328,79 +2365,28 @@ Post payment user will activates the confirmed order } } } + ], + "cancellation_terms": [ + { + "fulfillment_state": { + "descriptor": { + "code": "charging-start" + } + }, + "cancellation_fee": { + "percentage": "30%" + }, + "external_ref": { + "mimetype": "text/html", + "url": "https://chargezone.in/charge/tnc.html" + } + } ] } } } ``` -#### example for `support` call - -```json -{ - "context": { - "domain": "dent:0.1.0", - "action": "support", - "location": { - "country": { - "name": "India", - "code": "IND" - } - }, - "city": "std:080", - "version": "1.1.0", - "bap_id": "example-bap.com", - "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", - "bpp_id": "chargezone-energy-bpp.com", - "bpp_uri": "https://api.example-bpp.com/pilot/bpp/", - "transaction_id": "6743e9e2-4fb5-487c-92b7-13ba8018f176", - "message_id": "6743e9e2-4fb5-487c-92b7-13ba8018f176", - "timestamp": "2023-07-16T04:41:16Z" - }, - "message": { - "support": { - "order_id": "6743e9e2-4fb5-487c-92b7", - "phone": "+919876543210", - "email": "john.doe@gmail.com" - } - } -} -``` - -#### example for `on_support` call - -```json -{ - "context": { - "domain": "dent:0.1.0", - "action": "on_support", - "location": { - "country": { - "name": "India", - "code": "IND" - } - }, - "city": "std:080", - "version": "1.1.0", - "bap_id": "example-bap.com", - "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", - "bpp_id": "chargezone-energy-bpp.com", - "bpp_uri": "https://api.example-bpp.com/pilot/bpp/", - "transaction_id": "6743e9e2-4fb5-487c-92b7-13ba8018f176", - "message_id": "6743e9e2-4fb5-487c-92b7-13ba8018f176", - "timestamp": "2023-07-16T04:41:16Z" - }, - "message": { - "support": { - "order_id": "6743e9e2-4fb5-487c-92b7", - "phone": "1800 1080", - "email": "customer.care@chargezone.com", - "url": "https://www.chargezone.com/helpdesk" - } - } -} -``` - ## Order cancel ### User-side Actions @@ -2432,15 +2418,16 @@ Post payment user will activates the confirmed order ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "cancel", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -2451,13 +2438,11 @@ Post payment user will activates the confirmed order "timestamp": "2023-07-16T04:41:16Z" }, "message": { - "order": { "cancellation_reason_id": "5", "descriptor": { "short_desc": "can't attend booking" }, "order_id": "6743e9e2-4fb5-487c-92b7" - } } } ``` @@ -2467,15 +2452,16 @@ Post payment user will activates the confirmed order ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_cancel", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -2489,7 +2475,7 @@ Post payment user will activates the confirmed order "order": { "id": "6743e9e2-4fb5-487c-92b7", "status": "CANCELLED", - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -2525,7 +2511,19 @@ Post payment user will activates the confirmed order } } }, - "fulfillments": ["1"] + "add_ons": [ + { + "id": "pe-charging-01-addon-1", + "descriptor": { + "code": "add-on-item", + "name": "Free car wash" + }, + "price": { + "value": "0", + "currency": "INR" + } + } + ] } ], "fulfillments": [ @@ -2549,8 +2547,8 @@ Post payment user will activates the confirmed order { "time": { "range": { - "start": "10:00", - "end": "10:30" + "start": "2023-06-01T10:00:00", + "end": "2023-06-01T10:30:00" } } } @@ -2593,7 +2591,7 @@ Post payment user will activates the confirmed order ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { @@ -2628,7 +2626,8 @@ Post payment user will activates the confirmed order "status": "PAID", "params": { "amount": "40", - "currency": "INR" + "currency": "INR", + "transaction_id": "asjdhw8e238e3" }, "time": { "range": { @@ -2664,15 +2663,16 @@ Post payment user will activates the confirmed order ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_cancel", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -2686,7 +2686,7 @@ Post payment user will activates the confirmed order "order": { "id": "6743e9e2-4fb5-487c-92b7", "status": "CANCELLED", - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -2728,7 +2728,19 @@ Post payment user will activates the confirmed order } } }, - "fulfillments": ["1"] + "add_ons": [ + { + "id": "pe-charging-01-addon-1", + "descriptor": { + "code": "add-on-item", + "name": "Free car wash" + }, + "price": { + "value": "0", + "currency": "INR" + } + } + ] } ], "fulfillments": [ @@ -2752,8 +2764,8 @@ Post payment user will activates the confirmed order { "time": { "range": { - "start": "10:00", - "end": "10:30" + "start": "2023-06-10T10:00:00Z", + "end": "2023-06-10T10:30:00Z" } } } @@ -2796,7 +2808,7 @@ Post payment user will activates the confirmed order ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { @@ -2831,7 +2843,8 @@ Post payment user will activates the confirmed order "status": "PAID", "params": { "amount": "40", - "currency": "INR" + "currency": "INR", + "transaction_id": "asjdhw8e238e3" }, "time": { "range": { @@ -2893,15 +2906,16 @@ Post payment user will activates the confirmed order ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "rating", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -2928,15 +2942,16 @@ Post payment user will activates the confirmed order ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_rating", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -2948,12 +2963,10 @@ Post payment user will activates the confirmed order }, "message": { "feedback_form": { - "xinput": { "form": { "url": "https://api.example-bpp.com/pilot/bpp/feedback/portal" }, - "required": "false" - } + "required": false } } } @@ -2990,15 +3003,16 @@ Post payment user will activates the confirmed order ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "support", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -3010,7 +3024,7 @@ Post payment user will activates the confirmed order }, "message": { "support": { - "order_id": "6743e9e2-4fb5-487c-92b7", + "ref_id": "6743e9e2-4fb5-487c-92b7", "phone": "+919876543210", "email": "john.doe@gmail.com" } @@ -3023,15 +3037,16 @@ Post payment user will activates the confirmed order ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_support", "location": { "country": { - "name": "India", "code": "IND" + }, + "city": { + "code": "std:080" } }, - "city": "std:080", "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", @@ -3043,7 +3058,7 @@ Post payment user will activates the confirmed order }, "message": { "support": { - "order_id": "6743e9e2-4fb5-487c-92b7", + "ref_id": "6743e9e2-4fb5-487c-92b7", "phone": "1800 1080", "email": "customer.care@chargezone.com", "url": "https://www.chargezone.com/helpdesk" diff --git a/docs/implementation-guide/1_Unified-Energy-Interface.md b/docs/implementation-guide/1_EV_charging.md similarity index 90% rename from docs/implementation-guide/1_Unified-Energy-Interface.md rename to docs/implementation-guide/1_EV_charging.md index f0f4861d..cef2b06d 100644 --- a/docs/implementation-guide/1_Unified-Energy-Interface.md +++ b/docs/implementation-guide/1_EV_charging.md @@ -36,7 +36,7 @@ The search is broadcast to all providers on the network, there will be many prov ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "search", "location": { "country": { @@ -73,15 +73,21 @@ The search is broadcast to all providers on the network, there will be many prov } } }, - "location": { - "circle": { - "gps": "12.423423,77.325647", - "radius": { - "type": "CONSTANT", - "value": "5", - "unit": "km" + "fulfillment": { + "stops": [ + { + "location": { + "circle": { + "gps": "12.423423,77.325647", + "radius": { + "type": "CONSTANT", + "value": "5", + "unit": "km" + } + } + } } - } + ] } } } @@ -93,7 +99,7 @@ The on_search comes from all the providers, The providers have to be mapped to t ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_search", "location": { "country": { @@ -153,13 +159,13 @@ The on_search comes from all the providers, The providers have to be mapped to t { "type": "start", "time": { - "timestamp": "01-06-2023 10:00:00" + "timestamp": "2023-06-01T10:00:00Z" } }, { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00" + "timestamp": "2023-06-01T10:00:00Z" } } ], @@ -207,13 +213,13 @@ The on_search comes from all the providers, The providers have to be mapped to t { "type": "start", "time": { - "timestamp": "01-06-2023 10:00:00" + "timestamp": "2023-06-01T10:00:00Z" } }, { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00" + "timestamp": "2023-06-01T10:00:00Z" } } ], @@ -329,7 +335,7 @@ The on_search comes from all the providers, The providers have to be mapped to t "stops": [ { "location": { - "url": "https://log9.in/track/bswap/3234242" + "map_url": "https://log9.in/track/bswap/3234242" } } ] @@ -419,7 +425,7 @@ An example of `select` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "select", "location": { "country": { @@ -476,8 +482,8 @@ An example of `on_select` request ```json { "context": { - "domain": "dent:0.1.0", - "action": "on_select", + "domain": "uei:ev-charging", + "action": "select", "location": { "country": { "code": "IND" @@ -489,7 +495,7 @@ An example of `on_select` request "version": "1.1.0", "bap_id": "example-bap.com", "bap_uri": "https://api.example-bap.com/pilot/bap/energy/v1", - "bpp_id": "example-bpp.com", + "bpp_id": "chargezone-energy-bpp.com", "bpp_uri": "https://api.example-bpp.com/pilot/bpp/", "transaction_id": "6743e9e2-4fb5-487c-92b7-13ba8018f176", "message_id": "6743e9e2-4fb5-487c-92b7-13ba8018f176", @@ -497,155 +503,32 @@ An example of `on_select` request }, "message": { "order": { - "providers": { - "id": "chargezone.in", - "descriptor": { - "name": "Chargezone", - "short_desc": "Chargezone Technologies Pvt Ltd", - "images": [ - { - "url": "https://chargezone.in/images/logo.png" - } - ] - } + "provider": { + "id": "chargezone.in" }, "items": [ { "id": "pe-charging-01", - "descriptor": { - "code": "energy" - }, - "price": { - "value": "8", - "currency": "INR/kWH" - }, "quantity": { - "available": { - "measure": { - "value": "100", - "unit": "kWh" - } - }, "selected": { "measure": { "value": "4", "unit": "kWh" } } - } - }, - { - "id": "pe-charging-01-addon-1", - "descriptor": { - "code": "add-on-item", - "name": "Free car wash" }, - "price": { - "value": "0", - "currency": "INR" - } - } - ], - "fulfillments": [ - { - "id": "1", - "type": "CHARGING", - "stops": [ - { - "type": "start", - "time": { - "timestamp": "01-06-2023 10:00:00" - } - }, - { - "type": "end", - "time": { - "timestamp": "01-06-2023 10:30:00" - } - } - ], - "tags": [ + "add_ons": [ { - "descriptor": { - "name": "Charging Point Specifications" - }, - "list": [ - { - "descriptor": { - "name": "Charger type", - "code": "charger-type" - }, - "value": "AC" - }, - { - "descriptor": { - "name": "Connector type", - "code": "connector-type" - }, - "value": "CCS2" - }, - { - "descriptor": { - "name": "Power Rating" - }, - "value": "greater than 50kW" - }, - { - "descriptor": { - "name": "Availability" - }, - "value": "Available" - } - ], - "display": true + "id": "pe-charging-01-addon-1" } ] } ], - "quote": { - "price": { - "value": "32", - "currency": "INR" - }, - "breakup": [ - { - "item": { - "id": "pe-charging-01", - "descriptor": { - "name": "Estimated units consumed" - }, - "quantity": { - "selected": { - "measure": { - "value": "4", - "unit": "kWh" - } - } - } - }, - "price": { - "value": "32", - "currency": "INR" - } - }, - { - "item": { - "add-ons": [ - { - "id": "pe-charging-01-addon-1" - } - ], - "descriptor": { - "name": "Free car wash" - } - }, - "price": { - "value": "0", - "currency": "INR" - } - } - ] - } + "fulfillments": [ + { + "id": "1" + } + ] } } } @@ -656,7 +539,7 @@ An example of `init` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "init", "location": { "country": { @@ -726,7 +609,7 @@ An example of `on_init` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_init", "location": { "country": { @@ -747,7 +630,7 @@ An example of `on_init` request }, "message": { "order": { - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -819,13 +702,13 @@ An example of `on_init` request { "type": "start", "time": { - "timestamp": "01-06-2023 10:00:00" + "timestamp": "2023-06-01T10:00:00" } }, { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00" + "timestamp": "2023-06-01T10:00:00" } } ], @@ -867,7 +750,7 @@ An example of `on_init` request ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { @@ -939,7 +822,7 @@ An example of `confirm` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "confirm", "location": { "country": { @@ -960,7 +843,7 @@ An example of `confirm` request }, "message": { "order": { - "providers": { + "provider": { "id": "chargezone.in" }, "items": [ @@ -984,7 +867,7 @@ An example of `confirm` request "billing": { "name": "John Doe", "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "fulfillments": [ { @@ -1004,7 +887,8 @@ An example of `confirm` request "collected_by": "BPP", "params": { "amount": "40", - "currency": "INR" + "currency": "INR", + "transaction_id": "asjdhw8e238e3" }, "status": "PAID", "type": "PRE-ORDER" @@ -1047,7 +931,7 @@ An example of `on_confirm` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_confirm", "location": { "country": { @@ -1069,7 +953,7 @@ An example of `on_confirm` request "message": { "order": { "id": "6743e9e2-4fb5-487c-92b7", - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -1144,10 +1028,10 @@ An example of `on_confirm` request "gps": "12.423423,77.325647" }, "time": { - "timestamp": "01-06-2023 10:00:00", + "timestamp": "2023-06-01T10:00:00", "range": { - "start": "01-06-2023 10:00:00", - "end": "01-06-2023 10:10:00" + "start": "2023-06-01T10:00:00", + "end": "2023-06-01T10:10:00" } }, "instructions": { @@ -1158,10 +1042,10 @@ An example of `on_confirm` request { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00", + "timestamp": "2023-06-01T10:30:00", "range": { - "start": "01-06-2023 10:30:00", - "end": "01-06-2023 10:40:00" + "start": "2023-06-01T10:30:00", + "end": "2023-06-01T10:40:00" } } } @@ -1204,7 +1088,7 @@ An example of `on_confirm` request ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { @@ -1239,7 +1123,8 @@ An example of `on_confirm` request "status": "PAID", "params": { "amount": "40", - "currency": "INR" + "currency": "INR", + "transaction_id": "asjdhw8e238e3" }, "time": { "range": { @@ -1308,7 +1193,7 @@ An example of `status` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "status", "location": { "country": { @@ -1338,7 +1223,7 @@ An example of `on_status` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_status", "location": { "country": { @@ -1360,7 +1245,7 @@ An example of `on_status` request "message": { "order": { "id": "6743e9e2-4fb5-487c-92b7", - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -1435,20 +1320,20 @@ An example of `on_status` request "gps": "12.423423,77.325647" }, "time": { - "timestamp": "01-06-2023 10:00:00", + "timestamp": "2023-06-01T10:00:00", "range": { - "start": "01-06-2023 10:00:00", - "end": "01-06-2023 10:10:00" + "start": "2023-06-01T10:00:00", + "end": "2023-06-01T10:10:00" } } }, { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00", + "timestamp": "2023-06-01T10:30:00", "range": { - "start": "01-06-2023 10:30:00", - "end": "01-06-2023 10:40:00" + "start": "2023-06-01T10:00:00", + "end": "2023-06-01T10:40:00" } } } @@ -1491,7 +1376,7 @@ An example of `on_status` request ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { @@ -1526,7 +1411,8 @@ An example of `on_status` request "status": "PAID", "params": { "amount": "40", - "currency": "INR" + "currency": "INR", + "transaction_id": "asjdhw8e238e3" }, "time": { "range": { @@ -1562,7 +1448,7 @@ An example of `cancel` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "cancel", "location": { "country": { @@ -1582,13 +1468,11 @@ An example of `cancel` request "timestamp": "2023-07-16T04:41:16Z" }, "message": { - "order": { "cancellation_reason_id": "5", "descriptor": { "short_desc": "can't attend booking" }, "order_id": "6743e9e2-4fb5-487c-92b7" - } } } ``` @@ -1598,7 +1482,7 @@ An example of `on_cancel` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_cancel", "location": { "country": { @@ -1621,7 +1505,7 @@ An example of `on_cancel` request "order": { "id": "6743e9e2-4fb5-487c-92b7", "status": "CANCELLED", - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -1693,8 +1577,8 @@ An example of `on_cancel` request { "time": { "range": { - "start": "10:00", - "end": "10:30" + "start": "2023-06-01T10:00:00", + "end": "2023-06-01T10:30:00" } } } @@ -1737,7 +1621,7 @@ An example of `on_cancel` request ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { @@ -1772,7 +1656,8 @@ An example of `on_cancel` request "status": "PAID", "params": { "amount": "40", - "currency": "INR" + "currency": "INR", + "transaction_id": "asjdhw8e238e3" }, "time": { "range": { @@ -1808,7 +1693,7 @@ An example of `update` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "update", "location": { "country": { @@ -1851,7 +1736,7 @@ An example of `on_update` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_update", "location": { "country": { @@ -1873,7 +1758,7 @@ An example of `on_update` request "message": { "order": { "id": "6743e9e2-4fb5-487c-92b7", - "providers": { + "provider": { "id": "chargezone.in", "descriptor": { "name": "Chargezone", @@ -1948,20 +1833,20 @@ An example of `on_update` request "gps": "12.423423,77.325647" }, "time": { - "timestamp": "01-06-2023 10:00:00", + "timestamp": "2023-06-01T10:00:00", "range": { - "start": "01-06-2023 10:00:00", - "end": "01-06-2023 10:10:00" + "start": "2023-06-01T10:00:00", + "end": "2023-06-01T10:10:00" } } }, { "type": "end", "time": { - "timestamp": "01-06-2023 10:30:00", + "timestamp": "2023-06-01T10:30:00", "range": { - "start": "01-06-2023 10:30:00", - "end": "01-06-2023 10:40:00" + "start": "2023-06-01T10:30:00", + "end": "2023-06-01T10:40:00" } } } @@ -2004,7 +1889,7 @@ An example of `on_update` request ], "billing": { "email": "abc@example.com", - "number": "+91-9876522222" + "phone": "+91-9876522222" }, "quote": { "price": { @@ -2039,7 +1924,8 @@ An example of `on_update` request "status": "PAID", "params": { "amount": "40", - "currency": "INR" + "currency": "INR", + "transaction_id": "asjdhw8e238e3" }, "time": { "range": { @@ -2100,7 +1986,7 @@ An example of `rating` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "rating", "location": { "country": { @@ -2136,7 +2022,7 @@ An example of `on_rating` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_rating", "location": { "country": { @@ -2160,7 +2046,7 @@ An example of `on_rating` request "form": { "url": "https://api.example-bpp.com/pilot/bpp/feedback/portal" }, - "required": "false" + "required": false } } } @@ -2171,7 +2057,7 @@ An example of `support` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "support", "location": { "country": { @@ -2205,7 +2091,7 @@ An example of `on_support` request ```json { "context": { - "domain": "dent:0.1.0", + "domain": "uei:ev-charging", "action": "on_support", "location": { "country": { diff --git a/examples/ev-charging/cancel/cancel-request.json b/examples/ev-charging/cancel/cancel-request.json index 03070c34..5eb9257e 100644 --- a/examples/ev-charging/cancel/cancel-request.json +++ b/examples/ev-charging/cancel/cancel-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "cancel", "location": { "country": { diff --git a/examples/ev-charging/cancel/on_cancel-charger_breakdown-request.json b/examples/ev-charging/cancel/on_cancel-charger_breakdown-request.json index 08a33ab9..0d4c3e7f 100644 --- a/examples/ev-charging/cancel/on_cancel-charger_breakdown-request.json +++ b/examples/ev-charging/cancel/on_cancel-charger_breakdown-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "on_cancel", "location": { "country": { diff --git a/examples/ev-charging/cancel/on_cancel-request.json b/examples/ev-charging/cancel/on_cancel-request.json index 5dc08790..7afc8261 100644 --- a/examples/ev-charging/cancel/on_cancel-request.json +++ b/examples/ev-charging/cancel/on_cancel-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "on_cancel", "location": { "country": { diff --git a/examples/ev-charging/confirm/confirm-request.json b/examples/ev-charging/confirm/confirm-request.json index 0051cb98..950dabfb 100644 --- a/examples/ev-charging/confirm/confirm-request.json +++ b/examples/ev-charging/confirm/confirm-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "confirm", "location": { "country": { diff --git a/examples/ev-charging/confirm/on_confirm-request.json b/examples/ev-charging/confirm/on_confirm-request.json index 9bf5f7cf..79538c95 100644 --- a/examples/ev-charging/confirm/on_confirm-request.json +++ b/examples/ev-charging/confirm/on_confirm-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "on_confirm", "location": { "country": { diff --git a/examples/ev-charging/init/init-request.json b/examples/ev-charging/init/init-request.json index b3bca533..ba16d70d 100644 --- a/examples/ev-charging/init/init-request.json +++ b/examples/ev-charging/init/init-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "init", "location": { "country": { diff --git a/examples/ev-charging/init/on_init-request.json b/examples/ev-charging/init/on_init-request.json index 5b2b9a5f..4c9e0378 100644 --- a/examples/ev-charging/init/on_init-request.json +++ b/examples/ev-charging/init/on_init-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "on_init", "location": { "country": { diff --git a/examples/ev-charging/rating/on_rating-request.json b/examples/ev-charging/rating/on_rating-request.json index 9f329603..2225262f 100644 --- a/examples/ev-charging/rating/on_rating-request.json +++ b/examples/ev-charging/rating/on_rating-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "on_rating", "location": { "country": { diff --git a/examples/ev-charging/rating/rating-request.json b/examples/ev-charging/rating/rating-request.json index 03b3de52..0c77b11b 100644 --- a/examples/ev-charging/rating/rating-request.json +++ b/examples/ev-charging/rating/rating-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "rating", "location": { "country": { diff --git a/examples/ev-charging/search/on_search-request.json b/examples/ev-charging/search/on_search-request.json index 9867db63..98e714bf 100644 --- a/examples/ev-charging/search/on_search-request.json +++ b/examples/ev-charging/search/on_search-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "on_search", "location": { "country": { diff --git a/examples/ev-charging/search/search-request.json b/examples/ev-charging/search/search-request.json index 18fb89e3..f94cbecd 100644 --- a/examples/ev-charging/search/search-request.json +++ b/examples/ev-charging/search/search-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "search", "location": { "country": { diff --git a/examples/ev-charging/select/on_select-request.json b/examples/ev-charging/select/on_select-request.json index 4c0ba51e..bcd0baa4 100644 --- a/examples/ev-charging/select/on_select-request.json +++ b/examples/ev-charging/select/on_select-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "on_select", "location": { "country": { diff --git a/examples/ev-charging/select/select-request.json b/examples/ev-charging/select/select-request.json index d770b522..26dd8429 100644 --- a/examples/ev-charging/select/select-request.json +++ b/examples/ev-charging/select/select-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "select", "location": { "country": { diff --git a/examples/ev-charging/status/on_status-request.json b/examples/ev-charging/status/on_status-request.json index 91ed66fd..49188311 100644 --- a/examples/ev-charging/status/on_status-request.json +++ b/examples/ev-charging/status/on_status-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "on_status", "location": { "country": { diff --git a/examples/ev-charging/status/status-request.json b/examples/ev-charging/status/status-request.json index 4ac54e7e..510b0d97 100644 --- a/examples/ev-charging/status/status-request.json +++ b/examples/ev-charging/status/status-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "status", "location": { "country": { diff --git a/examples/ev-charging/support/on_support-request.json b/examples/ev-charging/support/on_support-request.json index ae7ee489..3f96c964 100644 --- a/examples/ev-charging/support/on_support-request.json +++ b/examples/ev-charging/support/on_support-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "on_support", "location": { "country": { diff --git a/examples/ev-charging/support/support-request.json b/examples/ev-charging/support/support-request.json index 2947fec1..22294293 100644 --- a/examples/ev-charging/support/support-request.json +++ b/examples/ev-charging/support/support-request.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "support", "location": { "country": { diff --git a/examples/ev-charging/update/on_update-request-charging-end.json b/examples/ev-charging/update/on_update-request-charging-end.json index 82e62433..354b8441 100644 --- a/examples/ev-charging/update/on_update-request-charging-end.json +++ b/examples/ev-charging/update/on_update-request-charging-end.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "on_update", "location": { "country": { diff --git a/examples/ev-charging/update/on_update-request-charging-start.json b/examples/ev-charging/update/on_update-request-charging-start.json index d0709b0d..99983ee8 100644 --- a/examples/ev-charging/update/on_update-request-charging-start.json +++ b/examples/ev-charging/update/on_update-request-charging-start.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "on_update", "location": { "country": { diff --git a/examples/ev-charging/update/update-request-charging-end.json b/examples/ev-charging/update/update-request-charging-end.json index f9337c88..8633b4d6 100644 --- a/examples/ev-charging/update/update-request-charging-end.json +++ b/examples/ev-charging/update/update-request-charging-end.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "update", "location": { "country": { diff --git a/examples/ev-charging/update/update-request-charging-start.json b/examples/ev-charging/update/update-request-charging-start.json index 2047ae03..ea032511 100644 --- a/examples/ev-charging/update/update-request-charging-start.json +++ b/examples/ev-charging/update/update-request-charging-start.json @@ -1,6 +1,6 @@ { "context": { - "domain": "dent:ev-charging:0.1.0", + "domain": "uei:ev-charging", "action": "update", "location": { "country": {