OCPP 1.6 JSON Schemas (1.6J)

Download OpenAPI specification:Download

AuthorizeRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "Authorize"
	object (AuthorizeRequestPayload)

[2,
"19223201",
"Authorize",
{"idTag": "string"
}
]

BootNotificationRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "BootNotification"
	object (BootNotificationRequestPayload)

[2,
"19223201",
"BootNotification",
{"chargePointVendor": "string",
"chargePointModel": "string",
"chargePointSerialNumber": "string",
"chargeBoxSerialNumber": "string",
"firmwareVersion": "string",
"iccid": "string",
"imsi": "string",
"meterType": "string",
"meterSerialNumber": "string"
}
]

CancelReservationRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "CancelReservation"
	object (CancelReservationRequestPayload)

[2,
"19223201",
"CancelReservation",
{"reservationId": 0
}
]

ChangeAvailabilityRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "ChangeAvailability"
	object (ChangeAvailabilityRequestPayload)

[2,
"19223201",
"ChangeAvailability",
{"connectorId": 0,
"type": "Inoperative"
}
]

ChangeConfigurationRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "ChangeConfiguration"
	object (ChangeConfigurationRequestPayload)

[2,
"19223201",
"ChangeConfiguration",
{"key": "string",
"value": "string"
}
]

ClearCacheRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "ClearCache"
[3]	object (ClearCacheRequestPayload)

[2,
"19223201",
"ClearCache",
{ }
]

ClearChargingProfileRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "ClearChargingProfile"
	object (ClearChargingProfileRequestPayload)

[2,
"19223201",
"ClearChargingProfile",
{"id": 0,
"connectorId": 0,
"chargingProfilePurpose": "ChargePointMaxProfile",
"stackLevel": 0
}
]

DataTransferRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "DataTransfer"
	object (DataTransferRequestPayload)

[2,
"19223201",
"DataTransfer",
{"vendorId": "string",
"messageId": "string",
"data": "string"
}
]

DiagnosticsStatusNotificationRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "DiagnosticsStatusNotification"
	object (DiagnosticsStatusNotificationRequestPayload)

[2,
"19223201",
"DiagnosticsStatusNotification",
{"status": "Idle"
}
]

FirmwareStatusNotificationRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "FirmwareStatusNotification"
	object (FirmwareStatusNotificationRequestPayload)

[2,
"19223201",
"FirmwareStatusNotification",
{"status": "Downloaded"
}
]

GetCompositeScheduleRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "GetCompositeSchedule"
	object (GetCompositeScheduleRequestPayload)

[2,
"19223201",
"GetCompositeSchedule",
{"connectorId": 0,
"duration": 0,
"chargingRateUnit": "A"
}
]

GetConfigurationRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "GetConfiguration"
	object (GetConfigurationRequestPayload)

[2,
"19223201",
"GetConfiguration",
{"key": ["string"
]
}
]

GetDiagnosticsRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "GetDiagnostics"
	object (GetDiagnosticsRequestPayload)

[2,
"19223201",
"GetDiagnostics",
{"location": "http://example.com",
"retries": 0,
"retryInterval": 0,
"startTime": "2019-08-24T14:15:22Z",
"stopTime": "2019-08-24T14:15:22Z"
}
]

GetLocalListVersionRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "GetLocalListVersion"
[3]	object (GetLocalListVersionRequestPayload)

[2,
"19223201",
"GetLocalListVersion",
{ }
]

HeartbeatRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "Heartbeat"
[3]	object (HeartbeatRequestPayload)

[2,
"19223201",
"Heartbeat",
{ }
]

MeterValuesRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "MeterValues"
	object (MeterValuesRequestPayload)

[2,
"19223201",
"MeterValues",
{"connectorId": 0,
"transactionId": 0,
"meterValue": [{"timestamp": "2019-08-24T14:15:22Z",
"sampledValue": [{"value": "string",
"context": "Interruption.Begin",
"format": "Raw",
"measurand": "Energy.Active.Export.Register",
"phase": "L1",
"location": "Cable",
"unit": "Wh"
}
]
}
]
}
]

RemoteStartTransactionRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "RemoteStartTransaction"
	object (RemoteStartTransactionRequestPayload)

[2,
"19223201",
"RemoteStartTransaction",
{"connectorId": 0,
"idTag": "string",
"chargingProfile": {"chargingProfileId": 0,
"transactionId": 0,
"stackLevel": 0,
"chargingProfilePurpose": "ChargePointMaxProfile",
"chargingProfileKind": "Absolute",
"recurrencyKind": "Daily",
"validFrom": "2019-08-24T14:15:22Z",
"validTo": "2019-08-24T14:15:22Z",
"chargingSchedule": {"duration": 0,
"startSchedule": "2019-08-24T14:15:22Z",
"chargingRateUnit": "A",
"chargingSchedulePeriod": [{"startPeriod": 0,
"limit": 0,
"numberPhases": 0
}
],
"minChargingRate": 0
}
}
}
]

RemoteStopTransactionRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "RemoteStopTransaction"
	object (RemoteStopTransactionRequestPayload)

[2,
"19223201",
"RemoteStopTransaction",
{"transactionId": 0
}
]

ReserveNowRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "ReserveNow"
	object (ReserveNowRequestPayload)

[2,
"19223201",
"ReserveNow",
{"connectorId": 0,
"expiryDate": "2019-08-24T14:15:22Z",
"idTag": "string",
"parentIdTag": "string",
"reservationId": 0
}
]

ResetRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "Reset"
	object (ResetRequestPayload)

[2,
"19223201",
"Reset",
{"type": "Hard"
}
]

SendLocalListRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "SendLocalList"
	object (SendLocalListRequestPayload)

[2,
"19223201",
"SendLocalList",
{"listVersion": 0,
"localAuthorizationList": [{"idTag": "string",
"idTagInfo": {"expiryDate": "2019-08-24T14:15:22Z",
"parentIdTag": "string",
"status": "Accepted"
}
}
],
"updateType": "Differential"
}
]

SetChargingProfileRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "SetChargingProfile"
	object (SetChargingProfileRequestPayload)

[2,
"19223201",
"SetChargingProfile",
{"connectorId": 0,
"csChargingProfiles": {"chargingProfileId": 0,
"transactionId": 0,
"stackLevel": 0,
"chargingProfilePurpose": "ChargePointMaxProfile",
"chargingProfileKind": "Absolute",
"recurrencyKind": "Daily",
"validFrom": "2019-08-24T14:15:22Z",
"validTo": "2019-08-24T14:15:22Z",
"chargingSchedule": {"duration": 0,
"startSchedule": "2019-08-24T14:15:22Z",
"chargingRateUnit": "A",
"chargingSchedulePeriod": [{"startPeriod": 0,
"limit": 0,
"numberPhases": 0
}
],
"minChargingRate": 0
}
}
}
]

StartTransactionRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "StartTransaction"
	object (StartTransactionRequestPayload)

[2,
"19223201",
"StartTransaction",
{"connectorId": 0,
"idTag": "string",
"meterStart": 0,
"reservationId": 0,
"timestamp": "2019-08-24T14:15:22Z"
}
]

StatusNotificationRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "StatusNotification"
	object (StatusNotificationRequestPayload)

[2,
"19223201",
"StatusNotification",
{"connectorId": 0,
"errorCode": "ConnectorLockFailure",
"info": "string",
"status": "Available",
"timestamp": "2019-08-24T14:15:22Z",
"vendorId": "string",
"vendorErrorCode": "string"
}
]

StopTransactionRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "StopTransaction"
	object (StopTransactionRequestPayload)

[2,
"19223201",
"StopTransaction",
{"idTag": "string",
"meterStop": 0,
"timestamp": "2019-08-24T14:15:22Z",
"transactionId": 0,
"reason": "EmergencyStop",
"transactionData": [{"timestamp": "2019-08-24T14:15:22Z",
"sampledValue": [{"value": "string",
"context": "Interruption.Begin",
"format": "Raw",
"measurand": "Energy.Active.Export.Register",
"phase": "L1",
"location": "Cable",
"unit": "Wh"
}
]
}
]
}
]

TriggerMessageRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "TriggerMessage"
	object (TriggerMessageRequestPayload)

[2,
"19223201",
"TriggerMessage",
{"requestedMessage": "BootNotification",
"connectorId": 0
}
]

UnlockConnectorRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "UnlockConnector"
	object (UnlockConnectorRequestPayload)

[2,
"19223201",
"UnlockConnector",
{"connectorId": 0
}
]

UpdateFirmwareRequest

[0]	integer Message Type ID (2 for "REQUEST") Value: 2
[1]	string Unique ID for this call
[2]	string Action (without Request) Value: "UpdateFirmware"
	object (UpdateFirmwareRequestPayload)

[2,
"19223201",
"UpdateFirmware",
{"location": "http://example.com",
"retries": 0,
"retrieveDate": "2019-08-24T14:15:22Z",
"retryInterval": 0
}
]

AuthorizeResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "Authorize"
	object (AuthorizeResponsePayload)

[3,
"19223201",
"Authorize",
{"idTagInfo": {"expiryDate": "2019-08-24T14:15:22Z",
"parentIdTag": "string",
"status": "Accepted"
}
}
]

BootNotificationResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "BootNotification"
	object (BootNotificationResponsePayload)

[3,
"19223201",
"BootNotification",
{"status": "Accepted",
"currentTime": "2019-08-24T14:15:22Z",
"interval": 0
}
]

CancelReservationResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "CancelReservation"
	object (CancelReservationResponsePayload)

[3,
"19223201",
"CancelReservation",
{"status": "Accepted"
}
]

ChangeAvailabilityResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "ChangeAvailability"
	object (ChangeAvailabilityResponsePayload)

[3,
"19223201",
"ChangeAvailability",
{"status": "Accepted"
}
]

ChangeConfigurationResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "ChangeConfiguration"
	object (ChangeConfigurationResponsePayload)

[3,
"19223201",
"ChangeConfiguration",
{"status": "Accepted"
}
]

ClearCacheResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "ClearCache"
	object (ClearCacheResponsePayload)

[3,
"19223201",
"ClearCache",
{"status": "Accepted"
}
]

ClearChargingProfileResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "ClearChargingProfile"
	object (ClearChargingProfileResponsePayload)

[3,
"19223201",
"ClearChargingProfile",
{"status": "Accepted"
}
]

DataTransferResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "DataTransfer"
	object (DataTransferResponsePayload)

[3,
"19223201",
"DataTransfer",
{"status": "Accepted",
"data": "string"
}
]

DiagnosticsStatusNotificationResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "DiagnosticsStatusNotification"
[3]	object (DiagnosticsStatusNotificationResponsePayload)

[3,
"19223201",
"DiagnosticsStatusNotification",
{ }
]

FirmwareStatusNotificationResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "FirmwareStatusNotification"
[3]	object (FirmwareStatusNotificationResponsePayload)

[3,
"19223201",
"FirmwareStatusNotification",
{ }
]

GetCompositeScheduleResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "GetCompositeSchedule"
	object (GetCompositeScheduleResponsePayload)

[3,
"19223201",
"GetCompositeSchedule",
{"status": "Accepted",
"connectorId": 0,
"scheduleStart": "2019-08-24T14:15:22Z",
"chargingSchedule": {"duration": 0,
"startSchedule": "2019-08-24T14:15:22Z",
"chargingRateUnit": "A",
"chargingSchedulePeriod": [{"startPeriod": 0,
"limit": 0,
"numberPhases": 0
}
],
"minChargingRate": 0
}
}
]

GetConfigurationResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "GetConfiguration"
	object (GetConfigurationResponsePayload)

[3,
"19223201",
"GetConfiguration",
{"configurationKey": [{"key": "string",
"readonly": true,
"value": "string"
}
],
"unknownKey": ["string"
]
}
]

GetDiagnosticsResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "GetDiagnostics"
	object (GetDiagnosticsResponsePayload)

[3,
"19223201",
"GetDiagnostics",
{"fileName": "string"
}
]

GetLocalListVersionResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "GetLocalListVersion"
	object (GetLocalListVersionResponsePayload)

[3,
"19223201",
"GetLocalListVersion",
{"listVersion": 0
}
]

HeartbeatResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "Heartbeat"
	object (HeartbeatResponsePayload)

[3,
"19223201",
"Heartbeat",
{"currentTime": "2019-08-24T14:15:22Z"
}
]

MeterValuesResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "MeterValues"
[3]	object (MeterValuesResponsePayload)

[3,
"19223201",
"MeterValues",
{ }
]

RemoteStartTransactionResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "RemoteStartTransaction"
	object (RemoteStartTransactionResponsePayload)

[3,
"19223201",
"RemoteStartTransaction",
{"status": "Accepted"
}
]

RemoteStopTransactionResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "RemoteStopTransaction"
	object (RemoteStopTransactionResponsePayload)

[3,
"19223201",
"RemoteStopTransaction",
{"status": "Accepted"
}
]

ReserveNowResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "ReserveNow"
	object (ReserveNowResponsePayload)

[3,
"19223201",
"ReserveNow",
{"status": "Accepted"
}
]

ResetResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "Reset"
	object (ResetResponsePayload)

[3,
"19223201",
"Reset",
{"status": "Accepted"
}
]

SendLocalListResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "SendLocalList"
	object (SendLocalListResponsePayload)

[3,
"19223201",
"SendLocalList",
{"status": "Accepted"
}
]

SetChargingProfileResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "SetChargingProfile"
	object (SetChargingProfileResponsePayload)

[3,
"19223201",
"SetChargingProfile",
{"status": "Accepted"
}
]

StartTransactionResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "StartTransaction"
	object (StartTransactionResponsePayload)

[3,
"19223201",
"StartTransaction",
{"idTagInfo": {"expiryDate": "2019-08-24T14:15:22Z",
"parentIdTag": "string",
"status": "Accepted"
},
"transactionId": 0
}
]

StatusNotificationResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "StatusNotification"
[3]	object (StatusNotificationResponsePayload)

[3,
"19223201",
"StatusNotification",
{ }
]

StopTransactionResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "StopTransaction"
	object (StopTransactionResponsePayload)

[3,
"19223201",
"StopTransaction",
{"idTagInfo": {"expiryDate": "2019-08-24T14:15:22Z",
"parentIdTag": "string",
"status": "Accepted"
}
}
]

TriggerMessageResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "TriggerMessage"
	object (TriggerMessageResponsePayload)

[3,
"19223201",
"TriggerMessage",
{"status": "Accepted"
}
]

UnlockConnectorResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "UnlockConnector"
	object (UnlockConnectorResponsePayload)

[3,
"19223201",
"UnlockConnector",
{"status": "Unlocked"
}
]

UpdateFirmwareResponse

[0]	integer Message Type ID (3 for "RESPONSE") Value: 3
[1]	string Unique ID for this call
[2]	string Action (without Response) Value: "UpdateFirmware"
[3]	object (UpdateFirmwareResponsePayload)

[3,
"19223201",
"UpdateFirmware",
{ }
]