• OCPP 2 API

OCPP

post

Inject OCPP raw request to device

This endpoint injects an OCPP raw request to the device.

actionstring

required

The name of the action to be executed

Enum
  • CancelReservation
  • ChangeAvailability
  • ChangeConfiguration
  • ClearCache
  • ClearChargingProfile
  • DataTransfer
  • GetCompositeSchedule
  • GetConfiguration
  • GetDiagnostics
  • GetLocalListVersion
  • RemoteStartTransaction
  • RemoteStopTransaction
  • ReserveNow
  • Reset
  • SendLocalList
  • SetChargingProfile
  • TriggerMessage
  • UnlockConnector
  • UpdateFirmware
  • CertificateSigned
  • ClearDisplayMessage
  • ClearVariableMonitoring
  • CostUpdated
  • CustomerInformation
  • DeleteCertificate
  • GetBaseReport
  • GetChargingProfiles
  • GetDisplayMessages
  • GetInstalledCertificateIds
  • GetLog
  • GetMonitoringReport
  • GetReport
  • GetTransactionStatus
  • GetVariables
  • InstallCertificate
  • PublishFirmware
  • RequestStartTransaction
  • RequestStopTransaction
  • SetDisplayMessage
  • SetMonitoringBase
  • SetMonitoringLevel
  • SetNetworkProfile
  • SetVariableMonitoring
  • SetVariables
  • UnpublishFirmware
assetIdstring

required

The id of the asset to send the request to

payloadobject

required

The payload to be sent to the asset

networkobject

The network to send the request to

idstring

required

The id of the network to send the request to

asyncboolean

Whether the request should be sent asynchronously. If false, the data will be present in the response

Default
true
requestIdstring

An optional request ID that will be used as the OCPP message ID. If not provided one will be generated.

Responses

Request examples

{
  "action": "CancelReservation",
  "assetId": "string",
  "payload": {},
  "network": {
    "id": "string"
  },
  "async": true,
  "requestId": "string"
}

Response examples

OK

{
  "status": "Success",
  "async": true,
  "ocppMessageId": "string",
  "data": {
    "ocppMessageId": "string",
    "connection": {
      "connectionId": "string",
      "protocol": "ocpp2.0.1"
    },
    "request": {
      "messageType": "2",
      "messageId": "string",
      "action": "string",
      "payload": {}
    },
    "response": {
      "messageType": "CALL_ERROR",
      "messageId": "string",
      "errorCode": "string",
      "ErrorDescription": "string",
      "errorDetails": {},
      "payload": {}
    }
  }
}
post

Disable rate display for the station

This endpoint sends a request to the station to disable rate display

assetIdstring

required

The ID of the asset

Responses

Response examples

OK

Empty response

post

Sync rate to the station

This endpoint sends a request to the station to sync rate

OAuth2 oauth2

Required Scopes:

write:ocpp

This endpoint sends a request to the station to sync rate

All Scopes

  • abort:session · Abruptly end session
  • read:asset · Retrieve assets
  • read:assetgroup · Retrieve asset groups
  • read:assetstatus · Retrieve asset statuses
  • read:driver · Retrieve drivers
  • read:invitation · Retrieve invitations
  • read:invoice · Retrieve an invoice
  • read:invoiceitem · Retrieve invoice item
  • read:networkaccessprofile · Retrieve network access profiles
  • read:panel · Retrieve panels.
  • read:payment_terminals_payment · Read payments from payment terminal
  • read:paymentprofile · Retrieve payment profile from payment terminal
  • read:projects · Retrieve projects
  • read:session · Retrieve a session
  • read:simgroup · Retrieve sim groups
  • read:sitepartner · Retrieve site partners
  • read:sitepartneruser · Retrieve site partner users
  • read:subscription · Retrieve subsciption
  • read:token · Retrieve tokens
  • write:asset · Create and update assets
  • write:assetgroup · Create and update asset groups
  • write:driver · Create and update drivers
  • write:invitation · Create and update invitations
  • write:invitecode · Create and update invite codes
  • write:network · Create and update networks
  • write:notification.email · Create and update email
  • write:ocpp · Sends request over OCPP
  • write:ocpp.raw_request · Sends raw request over OCPP
  • write:onboardinglink · Create an onboarding link
  • write:panel · Create and update panels.
  • write:paymentprofile · Create payment profile
  • write:plugandcharge_enrollment · Update Plug and Charge enrollment status
  • write:project_stations · Create and update project stations
  • write:projects · Create and update projects
  • write:session · Create or update a session
  • write:simgroup · Create sim groups
  • write:sitepartner · Create and update site partners
  • write:sitepartneruser · Create and update site partner users
  • write:ticket · Create a ticket
  • write:token · Create and update tokens
  • write:verificationcode · Send and confirm verification codes
Flow Type:
client_credentials
Token URL:
https://lynkwell-prod.us.auth0.com/oauth/token

Responses

Response examples

OK

{
  "status": "Accepted",
  "timestamp": "2023-06-07T17:32:28Z",
  "data": {
    "ocppMessageId": "string",
    "rateId": "string",
    "connection": {
      "connectionId": "string",
      "protocol": "ocpp2.0.1"
    }
  }
}

Was this page helpful?