POST api/v1/ocpp/transaction

Request Information

URI Parameters

None.

Body Parameters

OcppTransactionRequest
NameDescriptionTypeAdditional information
sessionId

string

None.

id

globally unique identifier

Required

tokenId

globally unique identifier

None.

command

string

None.

chargerId

string

None.

connectorId

integer

None.

idTag

string

None.

meterValue

OcppMeterValue

None.

Request Formats

application/json, text/json

Sample:
{
  "sessionId": "sample string 1",
  "id": "d53db796-fd32-477e-82a8-53b412a6b84c",
  "tokenId": "4947c2ec-f3aa-472d-a04b-3d3dcfa4961e",
  "command": "sample string 4",
  "chargerId": "sample string 5",
  "connectorId": 6,
  "idTag": "sample string 7",
  "meterValue": {
    "unit": "sample string 1",
    "value": 1.0,
    "dateTime": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<OcppTransactionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
  <chargerId>sample string 5</chargerId>
  <command>sample string 4</command>
  <connectorId>6</connectorId>
  <id>d53db796-fd32-477e-82a8-53b412a6b84c</id>
  <idTag>sample string 7</idTag>
  <meterValue>
    <dateTime>sample string 2</dateTime>
    <unit>sample string 1</unit>
    <value>1</value>
  </meterValue>
  <sessionId>sample string 1</sessionId>
  <tokenId>4947c2ec-f3aa-472d-a04b-3d3dcfa4961e</tokenId>
</OcppTransactionRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OcppTransactionRequest'.

Response Information

Resource Description

OcppTransactionResponse
NameDescriptionTypeAdditional information
id

globally unique identifier

Required

result

string

None.

errorMessage

string

None.

chargerId

string

None.

connectorId

integer

None.

meterValue

OcppMeterValue

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "0cb4a30a-95fa-48a2-901c-35791b91dcd0",
  "result": "sample string 2",
  "errorMessage": "sample string 3",
  "chargerId": "sample string 4",
  "connectorId": 5,
  "meterValue": {
    "unit": "sample string 1",
    "value": 1.0,
    "dateTime": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<OcppTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
  <chargerId>sample string 4</chargerId>
  <connectorId>5</connectorId>
  <errorMessage>sample string 3</errorMessage>
  <id>0cb4a30a-95fa-48a2-901c-35791b91dcd0</id>
  <meterValue>
    <dateTime>sample string 2</dateTime>
    <unit>sample string 1</unit>
    <value>1</value>
  </meterValue>
  <result>sample string 2</result>
</OcppTransactionResponse>