Documentation

Experimental OCPP 1.2 over Websocket

Basic data types :

SOAP type (XML schema)	JSON type
s:string	JSON string
s:int	JSON number
s:dateTime	JSON string, formatted as an ISO 8601 combined date and time, with a "Z" suffix (UTC timezone).
s:anyURI	JSON string
s:boolean	JSON boolean

Central System service

Authorize

Request example:
```
{
  "idTag": "B4F62CEF"
}
```

Response example:

{
  "idTagInfo": {
    "status": "Accepted",
    "expiryDate": "2013-02-01T15:09:18Z",
    "parentIdTag": "PARENT"
  }
}

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AuthorizeRequest",
  "type": "object",
  "properties": {
    "idTag": {
      "type": "string"
    }
  },
  "required": [
    "idTag"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "AuthorizeResponse",
  "type": "object",
  "properties": {
    "idTagInfo": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "Accepted",
            "Blocked",
            "Expired",
            "Invalid",
            "ConcurrentTx"
          ]
        },
        "expiryDate": {
          "type": "string",
          "format": "date-time"
        },
        "parentIdTag": {
          "type": "string"
        }
      },
      "required": [
        "status"
      ]
    }
  },
  "required": [
    "idTagInfo"
  ]
}

StartTransaction

Request example:

{
  "connectorId": 2,
  "idTag": "B4F62CEF",
  "timestamp": "2013-02-01T15:09:18Z",
  "meterStart": 0
}

Response example:

{
  "transactionId": 0,
  "idTagInfo": {
    "status": "Accepted",
    "expiryDate": "2013-02-01T15:09:18Z",
    "parentIdTag": "PARENT"
  }
}

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "StartTransactionRequest",
  "type": "object",
  "properties": {
    "connectorId": {
      "type": "number"
    },
    "idTag": {
      "type": "string"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "meterStart": {
      "type": "number"
    }
  },
  "required": [
    "connectorId",
    "idTag",
    "timestamp",
    "meterStart"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "StartTransactionResponse",
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "number"
    },
    "idTagInfo": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "Accepted",
            "Blocked",
            "Expired",
            "Invalid",
            "ConcurrentTx"
          ]
        },
        "expiryDate": {
          "type": "string",
          "format": "date-time"
        },
        "parentIdTag": {
          "type": "string"
        }
      },
      "required": [
        "status"
      ]
    }
  },
  "required": [
    "transactionId",
    "idTagInfo"
  ]
}

StopTransaction

Request example:

{
  "transactionId": 0,
  "idTag": "B4F62CEF",
  "timestamp": "2013-02-01T15:09:18Z",
  "meterStop": 20
}

Response example:

{
  "idTagInfo": {
    "status": "Expired",
    "expiryDate": "2013-02-01T15:09:18Z",
    "parentIdTag": "PARENT"
  }
}

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "StopTransactionRequest",
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "number"
    },
    "idTag": {
      "type": "string"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "meterStop": {
      "type": "number"
    }
  },
  "required": [
    "transactionId",
    "timestamp",
    "meterStop"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "StopTransactionResponse",
  "type": "object",
  "properties": {
    "idTagInfo": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "Accepted",
            "Blocked",
            "Expired",
            "Invalid",
            "ConcurrentTx"
          ]
        },
        "expiryDate": {
          "type": "string",
          "format": "date-time"
        },
        "parentIdTag": {
          "type": "string"
        }
      },
      "required": [
        "status"
      ]
    }
  }
}

Heartbeat

Request example:
```
{}
```

Response example:

{
  "currentTime": "2013-02-01T15:09:18Z"
}

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "HeartbeatRequest",
  "type": "object",
  "properties": {}
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "HeartbeatResponse",
  "type": "object",
  "properties": {
    "currentTime": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "currentTime"
  ]
}

MeterValues

Request example:

{
  "connectorId": 2,
  "values": [
    {
      "timestamp": "2013-02-01T15:09:18Z",
      "value": 0
    },
    {
      "timestamp": "2013-02-01T15:09:18Z",
      "value": 20
    }
  ]
}

Response example:
```
{}
```

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "MeterValuesRequest",
  "type": "object",
  "properties": {
    "connectorId": {
      "type": "number"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "timestamp": {
            "type": "string",
            "format": "date-time"
          },
          "value": {
            "type": "number"
          }
        }
      }
    }
  },
  "required": [
    "connectorId"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "MeterValuesResponse",
  "type": "object",
  "properties": {}
}

BootNotification

Request example:

{
  "chargePointVendor": "DBT",
  "chargePointModel": "NQC-ACDC",
  "chargePointSerialNumber": "gir.vat.mx.000e48",
  "chargeBoxSerialNumber": "gir.vat.mx.000e48",
  "firmwareVersion": "1.0.49",
  "iccid": "",
  "imsi": "",
  "meterType": "DBT NQC-ACDC",
  "meterSerialNumber": "gir.vat.mx.000e48"
}

Response example:

{
  "status": "Accepted",
  "currentTime": "2013-02-01T15:09:18Z",
  "heartbeatInterval": 1200
}

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "BootNotificationRequest",
  "type": "object",
  "properties": {
    "chargePointVendor": {
      "type": "string"
    },
    "chargePointModel": {
      "type": "string"
    },
    "chargePointSerialNumber": {
      "type": "string"
    },
    "chargeBoxSerialNumber": {
      "type": "string"
    },
    "firmwareVersion": {
      "type": "string"
    },
    "iccid": {
      "type": "string"
    },
    "imsi": {
      "type": "string"
    },
    "meterType": {
      "type": "string"
    },
    "meterSerialNumber": {
      "type": "string"
    }
  },
  "required": [
    "chargePointVendor",
    "chargePointModel"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "BootNotificationResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "Accepted",
        "Rejected"
      ]
    },
    "currentTime": {
      "type": "string",
      "format": "date-time"
    },
    "heartbeatInterval": {
      "type": "number"
    }
  },
  "required": [
    "status"
  ]
}

StatusNotification

Request example:

{
  "connectorId": 2,
  "status": "Available",
  "errorCode": "NoError"
}

Response example:
```
{}
```

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "StatusNotificationRequest",
  "type": "object",
  "properties": {
    "connectorId": {
      "type": "number"
    },
    "status": {
      "type": "string",
      "enum": [
        "Available",
        "Occupied",
        "Faulted",
        "Unavailable"
      ]
    },
    "errorCode": {
      "type": "string",
      "enum": [
        "ConnectorLockFailure",
        "HighTemperature",
        "Mode3Error",
        "NoError",
        "PowerMeterFailure",
        "PowerSwitchFailure",
        "ReaderFailure",
        "ResetFailure"
      ]
    }
  },
  "required": [
    "connectorId",
    "status",
    "errorCode"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "StatusNotificationResponse",
  "type": "object",
  "properties": {}
}

FirmwareStatusNotification

Request example:
```
{
  "status": "DownloadFailed"
}
```
Response example:
```
{}
```

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "FirmwareStatusNotificationRequest",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "Downloaded",
        "DownloadFailed",
        "InstallationFailed",
        "Installed"
      ]
    }
  },
  "required": [
    "status"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "FirmwareStatusNotificationResponse",
  "type": "object",
  "properties": {}
}

DiagnosticsStatusNotification

Request example:
```
{
  "status": "Uploaded"
}
```
Response example:
```
{}
```

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "DiagnosticsStatusNotificationRequest",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "Uploaded",
        "UploadFailed"
      ]
    }
  },
  "required": [
    "status"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "DiagnosticsStatusNotificationResponse",
  "type": "object",
  "properties": {}
}

Charge Point service

UnlockConnector

Request example:
```
{
  "connectorId": 1
}
```
Response example:
```
{
  "status": "Accepted"
}
```

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "UnlockConnectorRequest",
  "type": "object",
  "properties": {
    "connectorId": {
      "type": "number"
    }
  },
  "required": [
    "connectorId"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "UnlockConnectorResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "Accepted",
        "Rejected"
      ]
    }
  },
  "required": [
    "status"
  ]
}

Reset

Request example:
```
{
  "type": "Soft"
}
```
Response example:
```
{
  "status": "Accepted"
}
```

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ResetRequest",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "Hard",
        "Soft"
      ]
    }
  },
  "required": [
    "type"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ResetResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "Accepted",
        "Rejected"
      ]
    }
  },
  "required": [
    "status"
  ]
}

ChangeAvailability

Request example:

{
  "connectorId": 1,
  "type": "Inoperative"
}

Response example:
```
{
  "status": "Accepted"
}
```

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ChangeAvailabilityRequest",
  "type": "object",
  "properties": {
    "connectorId": {
      "type": "number"
    },
    "type": {
      "type": "string",
      "enum": [
        "Inoperative",
        "Operative"
      ]
    }
  },
  "required": [
    "connectorId",
    "type"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ChangeAvailabilityResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "Accepted",
        "Rejected",
        "Scheduled"
      ]
    }
  },
  "required": [
    "status"
  ]
}

GetDiagnostics

Request example:

{
  "location": "ftp://root:root@axis.gir.foo/tmp",
  "startTime": "2013-02-01T15:09:18Z",
  "stopTime": "2013-02-01T15:09:18Z",
  "retries": 4,
  "retryInterval": 20
}

Response example:

{
  "fileName": "diag-gir.vat.mx.000e48-20130131132608.txt"
}

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "GetDiagnosticsRequest",
  "type": "object",
  "properties": {
    "location": {
      "type": "string",
      "format": "uri"
    },
    "startTime": {
      "type": "string",
      "format": "date-time"
    },
    "stopTime": {
      "type": "string",
      "format": "date-time"
    },
    "retries": {
      "type": "number"
    },
    "retryInterval": {
      "type": "number"
    }
  },
  "required": [
    "location"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "GetDiagnosticsResponse",
  "type": "object",
  "properties": {
    "fileName": {
      "type": "string"
    }
  }
}

ClearCache

Request example:
```
{}
```
Response example:
```
{
  "status": "Accepted"
}
```

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ClearCacheRequest",
  "type": "object",
  "properties": {}
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ClearCacheResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "Accepted",
        "Rejected"
      ]
    }
  },
  "required": [
    "status"
  ]
}

UpdateFirmware

Request example:

{
  "retrieveDate": "2013-02-01T15:09:18Z",
  "location": "ftp://root:root@fork.gir.foo/tmp/kvcbx-updt.amx",
  "retries": 4,
  "retryInterval": 20
}

Response example:
```
{}
```

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "UpdateFirmwareRequest",
  "type": "object",
  "properties": {
    "retrieveDate": {
      "type": "string",
      "format": "date-time"
    },
    "location": {
      "type": "string",
      "format": "uri"
    },
    "retries": {
      "type": "number"
    },
    "retryInterval": {
      "type": "number"
    }
  },
  "required": [
    "retrieveDate",
    "location"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "UpdateFirmwareResponse",
  "type": "object",
  "properties": {}
}

ChangeConfiguration

Request example:

{
  "key": "KVCBX_LANG",
  "value": "FR"
}

Response example:
```
{
  "status": "Accepted"
}
```

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ChangeConfigurationRequest",
  "type": "object",
  "properties": {
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ChangeConfigurationResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "Accepted",
        "Rejected",
        "NotSupported"
      ]
    }
  },
  "required": [
    "status"
  ]
}

RemoteStartTransaction

Request example:

{
  "idTag": "044943121F1D80",
  "connectorId": 2
}

Response example:
```
{
  "status": "Accepted"
}
```

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "RemoteStartTransactionRequest",
  "type": "object",
  "properties": {
    "idTag": {
      "type": "string"
    },
    "connectorId": {
      "type": "number"
    }
  },
  "required": [
    "idTag"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "RemoteStartTransactionResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "Accepted",
        "Rejected"
      ]
    }
  },
  "required": [
    "status"
  ]
}

RemoteStopTransaction

Request example:
```
{
  "transactionId": 1
}
```
Response example:
```
{
  "status": "Accepted"
}
```

Request schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "RemoteStopTransactionRequest",
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "number"
    }
  },
  "required": [
    "transactionId"
  ]
}

Response schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "RemoteStopTransactionResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "Accepted",
        "Rejected"
      ]
    }
  },
  "required": [
    "status"
  ]
}