Menu Close

Station Management

Get all charging ports

Arguments

None

HTTP Response

Code Reason
200 Response is valid
401 Incorrect credentials
403 Credentials accepted but insufficient access level
404 No charging sites found
GET /charging-ports

Example Request

curl https://api.ocpp.swyched.com/1.2/charging-ports -v -H "x-api-key: <api_key>"

Response

[
  {
    "port_uuid": "f1985d47-a946-4400-ba52-c00bb0c2cc0f",
    "name": "Swyched Lab Charging Port 1",
    "status": "Available",
    "site_uuid": "58f63755-c3e3-4960-b54c-dc3d1d7bc0f6"
  },{
    "port_uuid": "0c88ae5e-e8e3-471d-8399-58efafe5523a",
    "name": "Swyched Lab Charging Port 2",
    "status": "Unknown",
    "site_uuid": "58f63755-c3e3-4960-b54c-dc3d1d7bc0f6"
  },....
]

Staging Arguments

Name Description Type
stg Staging indicator. Set to: true boolean

Argument is passed in the payload. Example:

{
    "stg": true
}

Get a single charging port

Arguments

Name Description Type
port_uuid Port to get information about string

Argument is passed as a route parameter.

Example

/charging-ports/f1985d47-a946-4400-ba52-c00bb0c2cc0f

HTTP Response

Code Reason
200 Response is valid
401 Incorrect credentials
403 Credentials accepted but insufficient access level
404 No charging sites found
GET /charging-ports/<port_uuid>

Example Request

curl https://api.ocpp.swyched.com/1.2/charging-ports/f1985d47-a946-4400-ba52-c00bb0c2cc0f -v -H "x-api-key: <api_key>"

Response

{
  "port_uuid": "f1985d47-a946-4400-ba52-c00bb0c2cc0f",
  "name": "Swyched Lab Charging Port 1",
  "status": "Available",
  "site_uuid": "58f63755-c3e3-4960-b54c-dc3d1d7bc0f6"
}

Staging Arguments

Argument is passed in the payload. Example:

Name Description Type
stg Staging indicator. Set to: true boolean
{
    "stg": true
}