Chargers
GET /api/chargers/:id
Retrieve detailed information about a specific charger by its internal ID, including its ports, connection status, and any ongoing charging sessions.
Parameters
id(path parameter): The internal ID of the charger
Response
The JSON response will contain a data field with the charger information.
{
data: {
id: number;
name: string;
manufacturer: string | null;
model: string | null;
serialNumber: string | null;
firmwareVersion: string | null;
latitude: number | null;
longitude: number | null;
externalId: string | null;
ocppId: string | null;
type: string; // One of: "DCFC", "Level 2"
powerSharing: boolean; // true if the charger has more than one port (power-sharing enabled)
// null if the charger has never connected to Flipturn
connectionStatus: {
status: string; // e.g. "Connected", "Disconnected"
timestamp: string; // ISO 8601 format
} | null;
numberOfPorts: number;
ports: {
id: number;
name: string;
portNumber: number;
maximumPowerKw: number | null;
// CCS1, J1772, or NACS
connectorType: string;
// null if the port has never sent an OCPP status
ocppStatus: {
status: string; // e.g. "Available", "Charging", "Faulted"
timestamp: string; // ISO 8601 format
errorCode: string; // OCPP error code, e.g. "NoError", "ConnectorLockFailure"
vendorErrorCode: string | null; // Vendor-specific error code
info: string | null; // Additional error information
} | null;
// Information about any ongoing charging session -- will be null if no charging session is
// currently happening on this port
currentChargingSession: {
id: number;
startTime: string; // ISO 8601 format
socStartPercent: number | null;
energyDeliveredKwh: number;
ocppIdTag: string | null;
ocppTransactionId: number | null;
// Latest meter readings from the charging session
latestReadings: {
powerKw: {
value: number;
timestamp: string; // ISO 8601 format
} | null;
currentA: {
value: number;
timestamp: string; // ISO 8601 format
} | null;
socPercent: {
value: number;
timestamp: string; // ISO 8601 format
} | null;
voltage: {
value: number;
timestamp: string; // ISO 8601 format
} | null;
};
vehicle: {
id: number;
make: string | null;
model: string | null;
name: string | null;
vin: string | null;
} | null;
rfid: {
id: number;
name: string;
} | null;
customer: {
name: string;
} | null;
} | null;
}[];
site: {
id: number;
name: string;
address: string | null;
timezone: string; // IANA format
};
};
}Example request and response
Request by internal ID:
Response:
GET /api/chargers/by-external-id/:id
Retrieve detailed information about a specific charger by its external ID (network station ID), including its ports, connection status, and any ongoing charging sessions.
Parameters
id(path parameter): The external ID (network station ID) of the charger
Response
The JSON response will contain a data field with the charger information. The response structure is identical to the GET /api/chargers/:id endpoint.
Example request
The response will be the same as for the GET /api/chargers/:id endpoint.
GET /api/chargers/by-ocpp-id/:id
Retrieve detailed information about a specific charger by its OCPP identifier, including its ports, connection status, and any ongoing charging sessions.
Parameters
id(path parameter): The OCPP identifier of the charger
Response
The JSON response will contain a data field with the charger information. The response structure is identical to the GET /api/chargers/:id endpoint.
Example request
The response will be the same as for the GET /api/chargers/:id endpoint.
Last updated