Start Charge

POST 
/v3/chargers/startcharge/:physicalPlug

Initiate the charging process at a specific charging station identified by the physical plug. Returns detailed information about the charging session, including status, amount, order ID, error details, user information, charged kwh, and more. The endpoint requires path parameters for the physical plug and provider.

Request

Path Parameters

physicalPlug stringrequired

application/json

Body

user_email string
plate string

Responses

200

Ok

application/json

Schema

Schema

_id string

Unique key in BD

createdAt date-time
updatedAt date-time
status number
provider string
amount number
orderId string
user string
chargedKwh number
physicalPlug object
_id string
logicPlug string
physicalPlugId string
conectorType number
status boolean
lastUpdate date-time
chargeMode number
maxPower number
provider string
price number
batteryLevel number
co2 number
sendedDisconnectMessage boolean
sendedChargingMessage boolean

Example (from schema)

{
  "_id": "6120d2793bb5fdbccc0b66df",
  "createdAt": "2024-04-02T09:19:28.997Z",
  "updatedAt": "2024-04-02T09:19:28.997Z",
  "status": 1,
  "provider": "Endesa",
  "amount": 22.36,
  "orderId": "63b0d1c3b297f968b7fd9bc1",
  "user": "626d49ee98a1ba31f130627d",
  "chargedKwh": 12,
  "physicalPlug": {
    "_id": "616b3830dca57819118cfe46",
    "logicPlug": "616a0c1bdca57819117693a9",
    "physicalPlugId": "101291f",
    "conectorType": 20,
    "status": false,
    "lastUpdate": "2021-10-16T20:41:48.000+00:00",
    "chargeMode": 1,
    "maxPower": 11,
    "provider": "EMT",
    "price": 0.15
  },
  "batteryLevel": 78,
  "co2": 23,
  "sendedDisconnectMessage": false,
  "sendedChargingMessage": true
}

403

Forbidden

500

Internal server error

application/json

Schema

Schema

message string
statusCode number
error string

Example (from schema)

{
  "message": "error message information",
  "statusCode": 500,
  "error": "Internal server error"
}

Loading...