Data Transfer

Description.

Data Transfer is used to transmit custom messages to and from the CSMS over OCPP.

DataTransferRequest

Topic: cs/josev or josev/cs. Used to send a custom DataTransfer message.

type

object

properties

  • id

type

string

format

uuid

  • name

const

data_transfer

  • type

const

request

  • data

type

object

properties

  • vendor_id

type

string

  • message_id

type

string

  • data

Example:

{
    "id": "57828133-8cfe-477d-b829-0b60aff90c2a",
    "name": "data_transfer",
    "type": "request",
    "data": {"vendor_id": "vendor-id",
             "message_id": "message-id", # OPTIONAL
             "data": "data" # OPTIONAL
            }
}

data field can be any format

Data can be free form and the format should be agreed with the CSMS. The CSMS and Charging Station should be recognising the specific vendor and message ID and processing the data field accordingly. Josev itself will not do any processing of this message, it merely passes it between the CS and the CSMS.


DataTransferResponse

Topic: cs/josev or josev/cs. Used to respond to a custom DataTransfer message.

type

object

properties

  • id

type

string

format

uuid

  • name

const

data_transfer

  • type

const

response

  • data

type

object

properties

  • status

enum

accepted, rejected, unknown_message_id, unknown_vendor_id

  • data

Example:

{
    "id": "57828133-8cfe-477d-b829-0b60aff90c2a",
    "name": "data_transfer",
    "type": "response",
    "data": {
             "status": "accepted", # rejected, unknown_message_id, unknown_vendor_id
             "data": "data" # OPTIONAL
            }
}