Get transactions
GET {{baseUrl}}/transactions?chargerId=<string>&connectorId=<integer>&page=1&limit=100&orderBy=<string>&order=<string>&from=<dateTime>&to=<dateTime>&vehicleId=<string>&filterBy=InsertedAt
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
chargerId | string | Selects a specific charger for which all the transactions should be retrieved | |
connectorId | string | Selects a specific connector for which all the transactions should be retrieved | |
page | number | Specifies the requested page index. Default is 1 | |
limit | number | Specifies the number of elements in a page. Default is 100 | |
orderBy | string | The type of ordering that we need. Exists 3 possibilities, TransactionID, StartAt and EndAt. Defaults to TransactionID | |
order | string | The pretended order, desc or asc. Defaults to desc. | |
from | string | Start point in time from where transactions should be retrieved and from value should be urlencoded | |
to | string | End point in time till where transactions should be retrieved and to value should be urlencoded | |
vehicleId | string | Selects a vehicle id for which all the transactions should be retrieved | |
filterBy | string | This parameter is used to set the type of filter for the <b><i>from</i></b> and <b><i>to</b></i> timerange. There are four options available as follows:<br> *StartAt - transactions will be retrieved based on the Transaction StartTime<br> *EndAt - transactions will be retrieved based on the Transaction EndTime<br> *InsertedAt - transactions will be retrieved based on when the Transaction record was inserted in the database<br> *Overlapping - transactions will be retrieved based on the both Transaction StartTime and EndTime<br> |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"TransactionID":123456,"ChargerID":"XYZ","ConnectorID":1,"StartAt":"2019-12-20T10:44:30.390Z","EndAt":"2019-12-20T11:44:30.390Z","InitialSoC":10,"EndSoC":95,"EnergyDelivered":1500,"EndResult":"Local","Initiator":"ABC123","VehicleID":"ABC123","ExtraInfo":{"Initiator":null,"ReservationID":"sed ut velit"},"SessionStartTime":"2019-12-20T10:44:30.390Z","SessionEndTime":"2019-12-20T10:44:30.390Z","InsertedAt":"2022-12-01T11:44:30.390Z"},{"TransactionID":123456,"ChargerID":"XYZ","ConnectorID":1,"StartAt":"2019-12-20T10:44:30.390Z","EndAt":"2019-12-20T11:44:30.390Z","InitialSoC":10,"EndSoC":95,"EnergyDelivered":1500,"EndResult":"Local","Initiator":"ABC123","VehicleID":"ABC123","ExtraInfo":{"Initiator":null,"ReservationID":"sint Lorem"},"SessionStartTime":"2019-12-20T10:44:30.390Z","SessionEndTime":"2019-12-20T10:44:30.390Z","InsertedAt":"2022-12-01T11:44:30.390Z"}]