POST api/v1/ocpp/authorize-transaction

Request Information

URI Parameters

None.

Body Parameters

OcppAuthorizeTransactionRequest
NameDescriptionTypeAdditional information
id

globally unique identifier

Required

tokenId

globally unique identifier

None.

chargerId

string

None.

direct_payment

boolean

None.

idTag

string

None.

email

string

None.

phone

string

None.

ip

string

None.

height

integer

None.

width

integer

None.

holder

string

None.

Request Formats

application/json, text/json

Sample:
{
  "id": "050f5c6f-f4e6-4a75-8581-8088032ef056",
  "tokenId": "d432631f-7c1c-452d-bf47-265ae0e21562",
  "chargerId": "sample string 3",
  "direct_payment": true,
  "idTag": "sample string 6",
  "email": "sample string 7",
  "phone": "sample string 8",
  "ip": "sample string 9",
  "height": 1,
  "width": 1,
  "holder": "sample string 10"
}

application/xml, text/xml

Sample:
<OcppAuthorizeTransactionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
  <chargerId>sample string 3</chargerId>
  <direct_payment>true</direct_payment>
  <email>sample string 7</email>
  <height>1</height>
  <holder>sample string 10</holder>
  <id>050f5c6f-f4e6-4a75-8581-8088032ef056</id>
  <idTag>sample string 6</idTag>
  <ip>sample string 9</ip>
  <phone>sample string 8</phone>
  <tokenId>d432631f-7c1c-452d-bf47-265ae0e21562</tokenId>
  <width>1</width>
</OcppAuthorizeTransactionRequest>

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 'OcppAuthorizeTransactionRequest'.

Response Information

Resource Description

OcppAuthorizeTransactionResponse
NameDescriptionTypeAdditional information
id

globally unique identifier

Required

result

string

None.

id_transaction

integer

None.

errorMessage

string

None.

tagId

string

None.

sessionId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "10c6d6b1-3f3e-4536-b0d2-292481e1aac1",
  "result": "sample string 2",
  "id_transaction": 3,
  "errorMessage": "sample string 4",
  "tagId": "sample string 5",
  "sessionId": "sample string 6"
}

application/xml, text/xml

Sample:
<OcppAuthorizeTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
  <errorMessage>sample string 4</errorMessage>
  <id>10c6d6b1-3f3e-4536-b0d2-292481e1aac1</id>
  <id_transaction>3</id_transaction>
  <result>sample string 2</result>
  <sessionId>sample string 6</sessionId>
  <tagId>sample string 5</tagId>
</OcppAuthorizeTransactionResponse>