API for EVerest API clients to read and clear persistently stored session records.
Experimental. This API is exempt from the EVerest stability guarantees and the deprecation period; channels, operations and message payloads may change without further notice until it is promoted to stable.
Pagination. get_sessions returns records oldest first, one page per request. A reply carries a continuation_token if more matching records follow; pass it in the next request and iterate until a reply has no token. A page can hold fewer records than requested, in rare cases none, while still carrying a token. An invalid or outdated token starts the iteration from the beginning. The request payload is optional: an empty object requests the first page with the default page size. The started_after filter is compared at millisecond precision.
Deleting records. clear_sessions cannot be undone and also deletes records that are still open; when such a session finishes later, the finish is dropped. The payload is optional: an empty object deletes every stored record. To delete exactly the records already read, pass the session id of the last record received from get_sessions as up_to_session_id; that record and every older one are deleted, sessions that started in the meantime are kept.
Concurrent clients. Neither the bridge nor the store keeps per-client state, so several clients may use the API at the same time. A clear_sessions issued by one client while another is paging removes records from that iteration; the other client's token stays valid and resumes at the oldest surviving record. Clients sharing one store should coordinate clearing, or clear only what they have read via up_to_session_id.
Missing records. get_session replies with the JSON literal null when no stored record matches the identifier.
default local MQTT
The ID of the module as defined in the EVerest config file.
Direction: Module to EVerest. Request one page of stored session records, oldest first. Iterate by passing the continuation_token of a reply into the next request until a reply carries no token.
Available only on servers:
Accepts the following message:
Request one page of stored session records.
Address to send the response to.
Additional properties are allowed.
Page request for stored session records. An empty object requests the first page of all records with the default page size.
Maximum number of records in the reply. EVerest may return fewer, and clamps the value to its supported maximum.
Opaque token from a previous reply to continue the iteration. Omit to start from the oldest record. An invalid or outdated token starts the iteration from the beginning.
Criteria a session record must match to be returned
Lifecycle state of a stored session record
Only records of the EVSE with this numeric id
Only records whose session started strictly after this point in time, in RFC3339 format. Compared as an instant, so any UTC offset may be used. Fractional seconds are compared at millisecond precision. A value that is not a timestamp is ignored.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Request the first page of all stored sessions
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
},
"payload": {}
}
Request the next page of the finished sessions of EVSE 1
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
},
"payload": {
"limit": 100,
"continuation_token": "5f2a9c31d4e8b0a7:184",
"filter": {
"state": "Finished",
"evse_id": 1
}
}
}
Available only on servers:
Reply to the request to send one page of stored session records
One page of stored session records
The records of this page, in the order they were stored, oldest first. Empty if no more records match.
The EVSE generated UUID of the session. A session contains at most one transaction, so this also identifies the transaction charged within it.
The numeric id of the EVSE this session ran on, as used across EVerest interfaces (1-based).
The EVSEID of the EVSE this session ran on, as configured in the EvseManager. Empty if the EvseManager does not provide one.
The id of the connector that was used for this session.
Lifecycle state of a stored session record
Time the session started, in RFC3339 format
Time the session finished, in RFC3339 format. Absent while the record is Open, and absent on Stale records.
Reason for session start
The transaction charged within a session. It starts at the point where all preconditions for charging are met and finishes when one of them irrevocably becomes false, so the fields that are only known at the end of a transaction are absent while it is running.
Time the transaction started, in RFC3339 format
Time the transaction finished, in RFC3339 format. Absent while the transaction is still running.
Total imported energy reading taken when the transaction started, in Wh
Total imported energy reading taken when the transaction finished, in Wh. Absent while the transaction is still running.
Hash of the id token that started the transaction. The raw token is never stored as a dedicated field, but note that a stored signed meter value embeds it (OCMF ID field). Computed as the lower case hex encoded SHA256 digest of the id token type concatenated with the id token value, matching the hash the OCPP stack uses for its authorization cache, so a hash computed elsewhere in the stack can be compared to this one directly. Absent only if the digest could not be calculated.
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
Reason for stopping transaction
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Additional properties are allowed.
The transaction id known to the CSMS, always as a string. Only present in OCPP setups: for OCPP 2.0.1 and 2.1 it is identical to session_id, for OCPP 1.6 it is the numeric id assigned by the CSMS in decimal notation, which arrives only after the transaction has already started. With early OCPP TxStartPoints an OCPP transaction can exist for a session that never reaches an EVerest transaction, so this may be present while transaction is absent.
Time the OCPP transaction started, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction start and can differ from timestamp_start and from the timestamps of transaction, because the point at which an OCPP 2.x transaction starts is configurable via its TxStartPoint. Absent if no OCPP module is connected or the event was not received.
Time the OCPP transaction stopped, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction stop and can differ from timestamp_stop and from the timestamps of transaction, because the point at which an OCPP 2.x transaction stops is configurable via its TxStopPoint. Absent if no OCPP module is connected or the event was not received.
Session cost object containing the total cost of the session and a list of chunks
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
A list of connector ids to which the authorization can be assigned
Indicates that the id token is already validated by the provider
The X.509 certificated presented by EV and encoded in PEM format
Contains the information needed to verify the EV Contract Certificate via OCSP
Used algorithms for the hashes provided
Hashed value of the Issuer Distinguished Name
Hashed value of the issuers public key
The serial number of the certificate
This contains the responder URL
Additional properties are allowed.
The session id
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
List of cost chunks. The total cost of the session is the sum of all chunks.
Absolute timestamp for the start of this chunk in RFC3339 UTC format
Absolute timestamp for the end of this chunk in RFC3339 UTC format
Metervalue (energy Wh import) for the start of this chunk
Metervalue (energy Wh import) for the end of this chunk
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Cost category
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Charging prices.
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Pricing for the next period
Time when these prices become active.
Price components while charging
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.
Message to show to the user containing information about the price
Format of the message to be displayed
QR Code with more information. For example when the charging is finished, to download the invoice from
Additional properties are allowed.
Present if more matching records follow this page. Pass it in the next request to continue the iteration; a reply without it means the iteration is complete.
Additional properties are allowed.
{
"sessions": [
{
"session_id": "string",
"evse_id": 1,
"evse_id_string": "string",
"connector_id": 1,
"state": "Open",
"timestamp_start": "2019-08-24T14:15:22Z",
"timestamp_stop": "2019-08-24T14:15:22Z",
"start_reason": "EVConnected",
"transaction": {
"timestamp_start": "2019-08-24T14:15:22Z",
"timestamp_stop": "2019-08-24T14:15:22Z",
"energy_Wh_import_start": 0,
"energy_Wh_import_stop": 0,
"id_token_hash": "stringstringstringstringstringstringstringstringstringstringstri",
"id_token_type": "Central",
"authorization_type": "OCPP",
"stop_reason": "EmergencyStop",
"signed_meter_value_start": {
"signed_meter_data": "string",
"signing_method": "string",
"encoding_method": "string",
"public_key": "string",
"timestamp": "2019-08-24T14:15:22Z"
},
"signed_meter_value_stop": {
"signed_meter_data": "string",
"signing_method": "string",
"encoding_method": "string",
"public_key": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
},
"ocpp_transaction_id": "string",
"ocpp_transaction_timestamp_start": "2019-08-24T14:15:22Z",
"ocpp_transaction_timestamp_stop": "2019-08-24T14:15:22Z",
"cost": {
"id_tag": {
"request_id": 0,
"id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"parent_id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"authorization_type": "OCPP",
"connectors": [
1
],
"prevalidated": true,
"certificate": "string",
"iso15118CertificateHashData": [
{
"hashAlgorithm": "SHA256",
"issuerNameHash": "string",
"issuerKeyHash": "string",
"serialNumber": "string",
"responderURL": "string"
}
]
},
"session_id": "string",
"currency": {
"code": "AED",
"decimals": 0
},
"cost_chunks": [
{
"timestamp_from": "2019-08-24T14:15:22Z",
"timestamp_to": "2019-08-24T14:15:22Z",
"metervalue_from": 0,
"metervalue_to": 0,
"cost": {
"value": 0
},
"category": "Energy"
}
],
"idle_price": {
"grace_minutes": 0,
"hour_price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
},
"charging_price": [
{
"category": "Energy",
"price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
],
"next_period": {
"timestamp_from": "2019-08-24T14:15:22Z",
"charging_price": [
{
"category": "Energy",
"price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
],
"idle_price": {
"grace_minutes": 0,
"hour_price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
},
"status": "Running",
"message": [
{
"format": "ASCII",
"language": "string",
"content": "string"
}
],
"qr_code": "string"
}
}
],
"continuation_token": "string"
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Reply to the request to send one page of stored session records
One page of stored session records
The records of this page, in the order they were stored, oldest first. Empty if no more records match.
The EVSE generated UUID of the session. A session contains at most one transaction, so this also identifies the transaction charged within it.
The numeric id of the EVSE this session ran on, as used across EVerest interfaces (1-based).
The EVSEID of the EVSE this session ran on, as configured in the EvseManager. Empty if the EvseManager does not provide one.
The id of the connector that was used for this session.
Lifecycle state of a stored session record
Time the session started, in RFC3339 format
Time the session finished, in RFC3339 format. Absent while the record is Open, and absent on Stale records.
Reason for session start
The transaction charged within a session. It starts at the point where all preconditions for charging are met and finishes when one of them irrevocably becomes false, so the fields that are only known at the end of a transaction are absent while it is running.
Time the transaction started, in RFC3339 format
Time the transaction finished, in RFC3339 format. Absent while the transaction is still running.
Total imported energy reading taken when the transaction started, in Wh
Total imported energy reading taken when the transaction finished, in Wh. Absent while the transaction is still running.
Hash of the id token that started the transaction. The raw token is never stored as a dedicated field, but note that a stored signed meter value embeds it (OCMF ID field). Computed as the lower case hex encoded SHA256 digest of the id token type concatenated with the id token value, matching the hash the OCPP stack uses for its authorization cache, so a hash computed elsewhere in the stack can be compared to this one directly. Absent only if the digest could not be calculated.
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
Reason for stopping transaction
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Additional properties are allowed.
The transaction id known to the CSMS, always as a string. Only present in OCPP setups: for OCPP 2.0.1 and 2.1 it is identical to session_id, for OCPP 1.6 it is the numeric id assigned by the CSMS in decimal notation, which arrives only after the transaction has already started. With early OCPP TxStartPoints an OCPP transaction can exist for a session that never reaches an EVerest transaction, so this may be present while transaction is absent.
Time the OCPP transaction started, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction start and can differ from timestamp_start and from the timestamps of transaction, because the point at which an OCPP 2.x transaction starts is configurable via its TxStartPoint. Absent if no OCPP module is connected or the event was not received.
Time the OCPP transaction stopped, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction stop and can differ from timestamp_stop and from the timestamps of transaction, because the point at which an OCPP 2.x transaction stops is configurable via its TxStopPoint. Absent if no OCPP module is connected or the event was not received.
Session cost object containing the total cost of the session and a list of chunks
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
A list of connector ids to which the authorization can be assigned
Indicates that the id token is already validated by the provider
The X.509 certificated presented by EV and encoded in PEM format
Contains the information needed to verify the EV Contract Certificate via OCSP
Used algorithms for the hashes provided
Hashed value of the Issuer Distinguished Name
Hashed value of the issuers public key
The serial number of the certificate
This contains the responder URL
Additional properties are allowed.
The session id
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
List of cost chunks. The total cost of the session is the sum of all chunks.
Absolute timestamp for the start of this chunk in RFC3339 UTC format
Absolute timestamp for the end of this chunk in RFC3339 UTC format
Metervalue (energy Wh import) for the start of this chunk
Metervalue (energy Wh import) for the end of this chunk
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Cost category
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Charging prices.
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Pricing for the next period
Time when these prices become active.
Price components while charging
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.
Message to show to the user containing information about the price
Format of the message to be displayed
QR Code with more information. For example when the charging is finished, to download the invoice from
Additional properties are allowed.
Present if more matching records follow this page. Pass it in the next request to continue the iteration; a reply without it means the iteration is complete.
Additional properties are allowed.
{
"sessions": [
{
"session_id": "string",
"evse_id": 1,
"evse_id_string": "string",
"connector_id": 1,
"state": "Open",
"timestamp_start": "2019-08-24T14:15:22Z",
"timestamp_stop": "2019-08-24T14:15:22Z",
"start_reason": "EVConnected",
"transaction": {
"timestamp_start": "2019-08-24T14:15:22Z",
"timestamp_stop": "2019-08-24T14:15:22Z",
"energy_Wh_import_start": 0,
"energy_Wh_import_stop": 0,
"id_token_hash": "stringstringstringstringstringstringstringstringstringstringstri",
"id_token_type": "Central",
"authorization_type": "OCPP",
"stop_reason": "EmergencyStop",
"signed_meter_value_start": {
"signed_meter_data": "string",
"signing_method": "string",
"encoding_method": "string",
"public_key": "string",
"timestamp": "2019-08-24T14:15:22Z"
},
"signed_meter_value_stop": {
"signed_meter_data": "string",
"signing_method": "string",
"encoding_method": "string",
"public_key": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
},
"ocpp_transaction_id": "string",
"ocpp_transaction_timestamp_start": "2019-08-24T14:15:22Z",
"ocpp_transaction_timestamp_stop": "2019-08-24T14:15:22Z",
"cost": {
"id_tag": {
"request_id": 0,
"id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"parent_id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"authorization_type": "OCPP",
"connectors": [
1
],
"prevalidated": true,
"certificate": "string",
"iso15118CertificateHashData": [
{
"hashAlgorithm": "SHA256",
"issuerNameHash": "string",
"issuerKeyHash": "string",
"serialNumber": "string",
"responderURL": "string"
}
]
},
"session_id": "string",
"currency": {
"code": "AED",
"decimals": 0
},
"cost_chunks": [
{
"timestamp_from": "2019-08-24T14:15:22Z",
"timestamp_to": "2019-08-24T14:15:22Z",
"metervalue_from": 0,
"metervalue_to": 0,
"cost": {
"value": 0
},
"category": "Energy"
}
],
"idle_price": {
"grace_minutes": 0,
"hour_price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
},
"charging_price": [
{
"category": "Energy",
"price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
],
"next_period": {
"timestamp_from": "2019-08-24T14:15:22Z",
"charging_price": [
{
"category": "Energy",
"price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
],
"idle_price": {
"grace_minutes": 0,
"hour_price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
},
"status": "Running",
"message": [
{
"format": "ASCII",
"language": "string",
"content": "string"
}
],
"qr_code": "string"
}
}
],
"continuation_token": "string"
}
Direction: Module to EVerest. Request one session record, identified either by its session id or by its OCPP transaction id. The reply will be sent to the replyTo address specified in the message headers. If no record matches the identifier, a null payload will be sent.
Available only on servers:
Accepts the following message:
Request the session record matching the given identifier.
Address to send the response to.
Additional properties are allowed.
Identifies a single session record. Exactly one of the members must be set. If both are set, session_id takes precedence.
The EVSE generated UUID of the session
The transaction id known to the CSMS
Additional properties are allowed.
Additional properties are allowed.
Request a session by session id
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
},
"payload": {
"session_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
Available only on servers:
Reply to the request to send a single session record. Null if no record matches the identifier.
One persistently stored session record. A record is created when the session starts and completed when it finishes, so the fields that are only known at the end of a session are absent while the record is open.
The EVSE generated UUID of the session. A session contains at most one transaction, so this also identifies the transaction charged within it.
The numeric id of the EVSE this session ran on, as used across EVerest interfaces (1-based).
The EVSEID of the EVSE this session ran on, as configured in the EvseManager. Empty if the EvseManager does not provide one.
The id of the connector that was used for this session.
Lifecycle state of a stored session record
Time the session started, in RFC3339 format
Time the session finished, in RFC3339 format. Absent while the record is Open, and absent on Stale records.
Reason for session start
The transaction charged within a session. It starts at the point where all preconditions for charging are met and finishes when one of them irrevocably becomes false, so the fields that are only known at the end of a transaction are absent while it is running.
Time the transaction started, in RFC3339 format
Time the transaction finished, in RFC3339 format. Absent while the transaction is still running.
Total imported energy reading taken when the transaction started, in Wh
Total imported energy reading taken when the transaction finished, in Wh. Absent while the transaction is still running.
Hash of the id token that started the transaction. The raw token is never stored as a dedicated field, but note that a stored signed meter value embeds it (OCMF ID field). Computed as the lower case hex encoded SHA256 digest of the id token type concatenated with the id token value, matching the hash the OCPP stack uses for its authorization cache, so a hash computed elsewhere in the stack can be compared to this one directly. Absent only if the digest could not be calculated.
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
Reason for stopping transaction
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Additional properties are allowed.
The transaction id known to the CSMS, always as a string. Only present in OCPP setups: for OCPP 2.0.1 and 2.1 it is identical to session_id, for OCPP 1.6 it is the numeric id assigned by the CSMS in decimal notation, which arrives only after the transaction has already started. With early OCPP TxStartPoints an OCPP transaction can exist for a session that never reaches an EVerest transaction, so this may be present while transaction is absent.
Time the OCPP transaction started, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction start and can differ from timestamp_start and from the timestamps of transaction, because the point at which an OCPP 2.x transaction starts is configurable via its TxStartPoint. Absent if no OCPP module is connected or the event was not received.
Time the OCPP transaction stopped, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction stop and can differ from timestamp_stop and from the timestamps of transaction, because the point at which an OCPP 2.x transaction stops is configurable via its TxStopPoint. Absent if no OCPP module is connected or the event was not received.
Session cost object containing the total cost of the session and a list of chunks
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
A list of connector ids to which the authorization can be assigned
Indicates that the id token is already validated by the provider
The X.509 certificated presented by EV and encoded in PEM format
Contains the information needed to verify the EV Contract Certificate via OCSP
Used algorithms for the hashes provided
Hashed value of the Issuer Distinguished Name
Hashed value of the issuers public key
The serial number of the certificate
This contains the responder URL
Additional properties are allowed.
The session id
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
List of cost chunks. The total cost of the session is the sum of all chunks.
Absolute timestamp for the start of this chunk in RFC3339 UTC format
Absolute timestamp for the end of this chunk in RFC3339 UTC format
Metervalue (energy Wh import) for the start of this chunk
Metervalue (energy Wh import) for the end of this chunk
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Cost category
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Charging prices.
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Pricing for the next period
Time when these prices become active.
Price components while charging
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.
Message to show to the user containing information about the price
Format of the message to be displayed
QR Code with more information. For example when the charging is finished, to download the invoice from
Additional properties are allowed.
Additional properties are allowed.
{
"session_id": "string",
"evse_id": 1,
"evse_id_string": "string",
"connector_id": 1,
"state": "Open",
"timestamp_start": "2019-08-24T14:15:22Z",
"timestamp_stop": "2019-08-24T14:15:22Z",
"start_reason": "EVConnected",
"transaction": {
"timestamp_start": "2019-08-24T14:15:22Z",
"timestamp_stop": "2019-08-24T14:15:22Z",
"energy_Wh_import_start": 0,
"energy_Wh_import_stop": 0,
"id_token_hash": "stringstringstringstringstringstringstringstringstringstringstri",
"id_token_type": "Central",
"authorization_type": "OCPP",
"stop_reason": "EmergencyStop",
"signed_meter_value_start": {
"signed_meter_data": "string",
"signing_method": "string",
"encoding_method": "string",
"public_key": "string",
"timestamp": "2019-08-24T14:15:22Z"
},
"signed_meter_value_stop": {
"signed_meter_data": "string",
"signing_method": "string",
"encoding_method": "string",
"public_key": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
},
"ocpp_transaction_id": "string",
"ocpp_transaction_timestamp_start": "2019-08-24T14:15:22Z",
"ocpp_transaction_timestamp_stop": "2019-08-24T14:15:22Z",
"cost": {
"id_tag": {
"request_id": 0,
"id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"parent_id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"authorization_type": "OCPP",
"connectors": [
1
],
"prevalidated": true,
"certificate": "string",
"iso15118CertificateHashData": [
{
"hashAlgorithm": "SHA256",
"issuerNameHash": "string",
"issuerKeyHash": "string",
"serialNumber": "string",
"responderURL": "string"
}
]
},
"session_id": "string",
"currency": {
"code": "AED",
"decimals": 0
},
"cost_chunks": [
{
"timestamp_from": "2019-08-24T14:15:22Z",
"timestamp_to": "2019-08-24T14:15:22Z",
"metervalue_from": 0,
"metervalue_to": 0,
"cost": {
"value": 0
},
"category": "Energy"
}
],
"idle_price": {
"grace_minutes": 0,
"hour_price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
},
"charging_price": [
{
"category": "Energy",
"price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
],
"next_period": {
"timestamp_from": "2019-08-24T14:15:22Z",
"charging_price": [
{
"category": "Energy",
"price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
],
"idle_price": {
"grace_minutes": 0,
"hour_price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
},
"status": "Running",
"message": [
{
"format": "ASCII",
"language": "string",
"content": "string"
}
],
"qr_code": "string"
}
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Reply to the request to send a single session record. Null if no record matches the identifier.
One persistently stored session record. A record is created when the session starts and completed when it finishes, so the fields that are only known at the end of a session are absent while the record is open.
The EVSE generated UUID of the session. A session contains at most one transaction, so this also identifies the transaction charged within it.
The numeric id of the EVSE this session ran on, as used across EVerest interfaces (1-based).
The EVSEID of the EVSE this session ran on, as configured in the EvseManager. Empty if the EvseManager does not provide one.
The id of the connector that was used for this session.
Lifecycle state of a stored session record
Time the session started, in RFC3339 format
Time the session finished, in RFC3339 format. Absent while the record is Open, and absent on Stale records.
Reason for session start
The transaction charged within a session. It starts at the point where all preconditions for charging are met and finishes when one of them irrevocably becomes false, so the fields that are only known at the end of a transaction are absent while it is running.
Time the transaction started, in RFC3339 format
Time the transaction finished, in RFC3339 format. Absent while the transaction is still running.
Total imported energy reading taken when the transaction started, in Wh
Total imported energy reading taken when the transaction finished, in Wh. Absent while the transaction is still running.
Hash of the id token that started the transaction. The raw token is never stored as a dedicated field, but note that a stored signed meter value embeds it (OCMF ID field). Computed as the lower case hex encoded SHA256 digest of the id token type concatenated with the id token value, matching the hash the OCPP stack uses for its authorization cache, so a hash computed elsewhere in the stack can be compared to this one directly. Absent only if the digest could not be calculated.
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
Reason for stopping transaction
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Additional properties are allowed.
The transaction id known to the CSMS, always as a string. Only present in OCPP setups: for OCPP 2.0.1 and 2.1 it is identical to session_id, for OCPP 1.6 it is the numeric id assigned by the CSMS in decimal notation, which arrives only after the transaction has already started. With early OCPP TxStartPoints an OCPP transaction can exist for a session that never reaches an EVerest transaction, so this may be present while transaction is absent.
Time the OCPP transaction started, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction start and can differ from timestamp_start and from the timestamps of transaction, because the point at which an OCPP 2.x transaction starts is configurable via its TxStartPoint. Absent if no OCPP module is connected or the event was not received.
Time the OCPP transaction stopped, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction stop and can differ from timestamp_stop and from the timestamps of transaction, because the point at which an OCPP 2.x transaction stops is configurable via its TxStopPoint. Absent if no OCPP module is connected or the event was not received.
Session cost object containing the total cost of the session and a list of chunks
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
A list of connector ids to which the authorization can be assigned
Indicates that the id token is already validated by the provider
The X.509 certificated presented by EV and encoded in PEM format
Contains the information needed to verify the EV Contract Certificate via OCSP
Used algorithms for the hashes provided
Hashed value of the Issuer Distinguished Name
Hashed value of the issuers public key
The serial number of the certificate
This contains the responder URL
Additional properties are allowed.
The session id
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
List of cost chunks. The total cost of the session is the sum of all chunks.
Absolute timestamp for the start of this chunk in RFC3339 UTC format
Absolute timestamp for the end of this chunk in RFC3339 UTC format
Metervalue (energy Wh import) for the start of this chunk
Metervalue (energy Wh import) for the end of this chunk
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Cost category
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Charging prices.
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Pricing for the next period
Time when these prices become active.
Price components while charging
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.
Message to show to the user containing information about the price
Format of the message to be displayed
QR Code with more information. For example when the charging is finished, to download the invoice from
Additional properties are allowed.
Additional properties are allowed.
{
"session_id": "string",
"evse_id": 1,
"evse_id_string": "string",
"connector_id": 1,
"state": "Open",
"timestamp_start": "2019-08-24T14:15:22Z",
"timestamp_stop": "2019-08-24T14:15:22Z",
"start_reason": "EVConnected",
"transaction": {
"timestamp_start": "2019-08-24T14:15:22Z",
"timestamp_stop": "2019-08-24T14:15:22Z",
"energy_Wh_import_start": 0,
"energy_Wh_import_stop": 0,
"id_token_hash": "stringstringstringstringstringstringstringstringstringstringstri",
"id_token_type": "Central",
"authorization_type": "OCPP",
"stop_reason": "EmergencyStop",
"signed_meter_value_start": {
"signed_meter_data": "string",
"signing_method": "string",
"encoding_method": "string",
"public_key": "string",
"timestamp": "2019-08-24T14:15:22Z"
},
"signed_meter_value_stop": {
"signed_meter_data": "string",
"signing_method": "string",
"encoding_method": "string",
"public_key": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
},
"ocpp_transaction_id": "string",
"ocpp_transaction_timestamp_start": "2019-08-24T14:15:22Z",
"ocpp_transaction_timestamp_stop": "2019-08-24T14:15:22Z",
"cost": {
"id_tag": {
"request_id": 0,
"id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"parent_id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"authorization_type": "OCPP",
"connectors": [
1
],
"prevalidated": true,
"certificate": "string",
"iso15118CertificateHashData": [
{
"hashAlgorithm": "SHA256",
"issuerNameHash": "string",
"issuerKeyHash": "string",
"serialNumber": "string",
"responderURL": "string"
}
]
},
"session_id": "string",
"currency": {
"code": "AED",
"decimals": 0
},
"cost_chunks": [
{
"timestamp_from": "2019-08-24T14:15:22Z",
"timestamp_to": "2019-08-24T14:15:22Z",
"metervalue_from": 0,
"metervalue_to": 0,
"cost": {
"value": 0
},
"category": "Energy"
}
],
"idle_price": {
"grace_minutes": 0,
"hour_price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
},
"charging_price": [
{
"category": "Energy",
"price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
],
"next_period": {
"timestamp_from": "2019-08-24T14:15:22Z",
"charging_price": [
{
"category": "Energy",
"price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
],
"idle_price": {
"grace_minutes": 0,
"hour_price": {
"currency": {
"code": "AED",
"decimals": 0
},
"value": {
"value": 0
}
}
}
},
"status": "Running",
"message": [
{
"format": "ASCII",
"language": "string",
"content": "string"
}
],
"qr_code": "string"
}
}
Direction: Module to EVerest. Deletes stored session records, including records that are still open. An absent payload deletes every record, up_to_session_id limits the deletion to that record and the records stored before it. This cannot be undone. When a deleted open session finishes later, the finish is dropped and the record does not reappear.
Available only on servers:
Accepts the following message:
Delete all stored session records, or the records up to a given one.
Address to send the response to.
Additional properties are allowed.
Selects the session records to delete. An empty object deletes every stored record.
Session id of the newest record to delete. Deletes that record and every record stored before it, in the order get_sessions returns them, and keeps the records stored after it. A client that has read all records with get_sessions can pass the session id of the last record it received to delete exactly what it has read, without losing sessions that started in the meantime. If no record with this id exists, nothing is deleted.
Additional properties are allowed.
Additional properties are allowed.
Clear all stored sessions
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
}
}
Clear the sessions read so far, keeping sessions started in the meantime
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
},
"payload": {
"up_to_session_id": "550e8400-e29b-41d4-a716-446655440000"
}
}
Available only on servers:
Reply to the request to delete stored session records
Result of deleting stored session records
Number of session records that were deleted. With up_to_session_id set, 0 means that no record with that session id exists.
Additional properties are allowed.
{
"cleared": 0
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Reply to the request to delete stored session records
Result of deleting stored session records
Number of session records that were deleted. With up_to_session_id set, 0 means that no record with that session id exists.
Additional properties are allowed.
{
"cleared": 0
}
Accepts the following message:
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Heartbeat
Accepts the following message:
Signal to EVerest that communication is good or check shall be stopped
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
CommunicationCheck
Request one page of stored session records.
Address to send the response to.
Additional properties are allowed.
Page request for stored session records. An empty object requests the first page of all records with the default page size.
Maximum number of records in the reply. EVerest may return fewer, and clamps the value to its supported maximum.
Opaque token from a previous reply to continue the iteration. Omit to start from the oldest record. An invalid or outdated token starts the iteration from the beginning.
Criteria a session record must match to be returned
Lifecycle state of a stored session record
Only records of the EVSE with this numeric id
Only records whose session started strictly after this point in time, in RFC3339 format. Compared as an instant, so any UTC offset may be used. Fractional seconds are compared at millisecond precision. A value that is not a timestamp is ignored.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Reply to the request to send one page of stored session records
One page of stored session records
The records of this page, in the order they were stored, oldest first. Empty if no more records match.
The EVSE generated UUID of the session. A session contains at most one transaction, so this also identifies the transaction charged within it.
The numeric id of the EVSE this session ran on, as used across EVerest interfaces (1-based).
The EVSEID of the EVSE this session ran on, as configured in the EvseManager. Empty if the EvseManager does not provide one.
The id of the connector that was used for this session.
Lifecycle state of a stored session record
Time the session started, in RFC3339 format
Time the session finished, in RFC3339 format. Absent while the record is Open, and absent on Stale records.
Reason for session start
The transaction charged within a session. It starts at the point where all preconditions for charging are met and finishes when one of them irrevocably becomes false, so the fields that are only known at the end of a transaction are absent while it is running.
Time the transaction started, in RFC3339 format
Time the transaction finished, in RFC3339 format. Absent while the transaction is still running.
Total imported energy reading taken when the transaction started, in Wh
Total imported energy reading taken when the transaction finished, in Wh. Absent while the transaction is still running.
Hash of the id token that started the transaction. The raw token is never stored as a dedicated field, but note that a stored signed meter value embeds it (OCMF ID field). Computed as the lower case hex encoded SHA256 digest of the id token type concatenated with the id token value, matching the hash the OCPP stack uses for its authorization cache, so a hash computed elsewhere in the stack can be compared to this one directly. Absent only if the digest could not be calculated.
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
Reason for stopping transaction
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Additional properties are allowed.
The transaction id known to the CSMS, always as a string. Only present in OCPP setups: for OCPP 2.0.1 and 2.1 it is identical to session_id, for OCPP 1.6 it is the numeric id assigned by the CSMS in decimal notation, which arrives only after the transaction has already started. With early OCPP TxStartPoints an OCPP transaction can exist for a session that never reaches an EVerest transaction, so this may be present while transaction is absent.
Time the OCPP transaction started, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction start and can differ from timestamp_start and from the timestamps of transaction, because the point at which an OCPP 2.x transaction starts is configurable via its TxStartPoint. Absent if no OCPP module is connected or the event was not received.
Time the OCPP transaction stopped, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction stop and can differ from timestamp_stop and from the timestamps of transaction, because the point at which an OCPP 2.x transaction stops is configurable via its TxStopPoint. Absent if no OCPP module is connected or the event was not received.
Session cost object containing the total cost of the session and a list of chunks
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
A list of connector ids to which the authorization can be assigned
Indicates that the id token is already validated by the provider
The X.509 certificated presented by EV and encoded in PEM format
Contains the information needed to verify the EV Contract Certificate via OCSP
Used algorithms for the hashes provided
Hashed value of the Issuer Distinguished Name
Hashed value of the issuers public key
The serial number of the certificate
This contains the responder URL
Additional properties are allowed.
The session id
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
List of cost chunks. The total cost of the session is the sum of all chunks.
Absolute timestamp for the start of this chunk in RFC3339 UTC format
Absolute timestamp for the end of this chunk in RFC3339 UTC format
Metervalue (energy Wh import) for the start of this chunk
Metervalue (energy Wh import) for the end of this chunk
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Cost category
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Charging prices.
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Pricing for the next period
Time when these prices become active.
Price components while charging
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.
Message to show to the user containing information about the price
Format of the message to be displayed
QR Code with more information. For example when the charging is finished, to download the invoice from
Additional properties are allowed.
Present if more matching records follow this page. Pass it in the next request to continue the iteration; a reply without it means the iteration is complete.
Additional properties are allowed.
Request the session record matching the given identifier.
Address to send the response to.
Additional properties are allowed.
Identifies a single session record. Exactly one of the members must be set. If both are set, session_id takes precedence.
The EVSE generated UUID of the session
The transaction id known to the CSMS
Additional properties are allowed.
Additional properties are allowed.
Reply to the request to send a single session record. Null if no record matches the identifier.
One persistently stored session record. A record is created when the session starts and completed when it finishes, so the fields that are only known at the end of a session are absent while the record is open.
The EVSE generated UUID of the session. A session contains at most one transaction, so this also identifies the transaction charged within it.
The numeric id of the EVSE this session ran on, as used across EVerest interfaces (1-based).
The EVSEID of the EVSE this session ran on, as configured in the EvseManager. Empty if the EvseManager does not provide one.
The id of the connector that was used for this session.
Lifecycle state of a stored session record
Time the session started, in RFC3339 format
Time the session finished, in RFC3339 format. Absent while the record is Open, and absent on Stale records.
Reason for session start
The transaction charged within a session. It starts at the point where all preconditions for charging are met and finishes when one of them irrevocably becomes false, so the fields that are only known at the end of a transaction are absent while it is running.
Time the transaction started, in RFC3339 format
Time the transaction finished, in RFC3339 format. Absent while the transaction is still running.
Total imported energy reading taken when the transaction started, in Wh
Total imported energy reading taken when the transaction finished, in Wh. Absent while the transaction is still running.
Hash of the id token that started the transaction. The raw token is never stored as a dedicated field, but note that a stored signed meter value embeds it (OCMF ID field). Computed as the lower case hex encoded SHA256 digest of the id token type concatenated with the id token value, matching the hash the OCPP stack uses for its authorization cache, so a hash computed elsewhere in the stack can be compared to this one directly. Absent only if the digest could not be calculated.
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
Reason for stopping transaction
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Additional properties are allowed.
The transaction id known to the CSMS, always as a string. Only present in OCPP setups: for OCPP 2.0.1 and 2.1 it is identical to session_id, for OCPP 1.6 it is the numeric id assigned by the CSMS in decimal notation, which arrives only after the transaction has already started. With early OCPP TxStartPoints an OCPP transaction can exist for a session that never reaches an EVerest transaction, so this may be present while transaction is absent.
Time the OCPP transaction started, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction start and can differ from timestamp_start and from the timestamps of transaction, because the point at which an OCPP 2.x transaction starts is configurable via its TxStartPoint. Absent if no OCPP module is connected or the event was not received.
Time the OCPP transaction stopped, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction stop and can differ from timestamp_stop and from the timestamps of transaction, because the point at which an OCPP 2.x transaction stops is configurable via its TxStopPoint. Absent if no OCPP module is connected or the event was not received.
Session cost object containing the total cost of the session and a list of chunks
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
A list of connector ids to which the authorization can be assigned
Indicates that the id token is already validated by the provider
The X.509 certificated presented by EV and encoded in PEM format
Contains the information needed to verify the EV Contract Certificate via OCSP
Used algorithms for the hashes provided
Hashed value of the Issuer Distinguished Name
Hashed value of the issuers public key
The serial number of the certificate
This contains the responder URL
Additional properties are allowed.
The session id
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
List of cost chunks. The total cost of the session is the sum of all chunks.
Absolute timestamp for the start of this chunk in RFC3339 UTC format
Absolute timestamp for the end of this chunk in RFC3339 UTC format
Metervalue (energy Wh import) for the start of this chunk
Metervalue (energy Wh import) for the end of this chunk
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Cost category
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Charging prices.
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Pricing for the next period
Time when these prices become active.
Price components while charging
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.
Message to show to the user containing information about the price
Format of the message to be displayed
QR Code with more information. For example when the charging is finished, to download the invoice from
Additional properties are allowed.
Additional properties are allowed.
Delete all stored session records, or the records up to a given one.
Address to send the response to.
Additional properties are allowed.
Selects the session records to delete. An empty object deletes every stored record.
Session id of the newest record to delete. Deletes that record and every record stored before it, in the order get_sessions returns them, and keeps the records stored after it. A client that has read all records with get_sessions can pass the session id of the last record it received to delete exactly what it has read, without losing sessions that started in the meantime. If no record with this id exists, nothing is deleted.
Additional properties are allowed.
Additional properties are allowed.
Reply to the request to delete stored session records
Result of deleting stored session records
Number of session records that were deleted. With up_to_session_id set, 0 means that no record with that session id exists.
Additional properties are allowed.
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Signal to EVerest that communication is good or check shall be stopped
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
Criteria a session record must match to be returned
Lifecycle state of a stored session record
Only records of the EVSE with this numeric id
Only records whose session started strictly after this point in time, in RFC3339 format. Compared as an instant, so any UTC offset may be used. Fractional seconds are compared at millisecond precision. A value that is not a timestamp is ignored.
Additional properties are allowed.
Page request for stored session records. An empty object requests the first page of all records with the default page size.
Maximum number of records in the reply. EVerest may return fewer, and clamps the value to its supported maximum.
Opaque token from a previous reply to continue the iteration. Omit to start from the oldest record. An invalid or outdated token starts the iteration from the beginning.
Criteria a session record must match to be returned
Lifecycle state of a stored session record
Only records of the EVSE with this numeric id
Only records whose session started strictly after this point in time, in RFC3339 format. Compared as an instant, so any UTC offset may be used. Fractional seconds are compared at millisecond precision. A value that is not a timestamp is ignored.
Additional properties are allowed.
Additional properties are allowed.
One page of stored session records
The records of this page, in the order they were stored, oldest first. Empty if no more records match.
The EVSE generated UUID of the session. A session contains at most one transaction, so this also identifies the transaction charged within it.
The numeric id of the EVSE this session ran on, as used across EVerest interfaces (1-based).
The EVSEID of the EVSE this session ran on, as configured in the EvseManager. Empty if the EvseManager does not provide one.
The id of the connector that was used for this session.
Lifecycle state of a stored session record
Time the session started, in RFC3339 format
Time the session finished, in RFC3339 format. Absent while the record is Open, and absent on Stale records.
Reason for session start
The transaction charged within a session. It starts at the point where all preconditions for charging are met and finishes when one of them irrevocably becomes false, so the fields that are only known at the end of a transaction are absent while it is running.
Time the transaction started, in RFC3339 format
Time the transaction finished, in RFC3339 format. Absent while the transaction is still running.
Total imported energy reading taken when the transaction started, in Wh
Total imported energy reading taken when the transaction finished, in Wh. Absent while the transaction is still running.
Hash of the id token that started the transaction. The raw token is never stored as a dedicated field, but note that a stored signed meter value embeds it (OCMF ID field). Computed as the lower case hex encoded SHA256 digest of the id token type concatenated with the id token value, matching the hash the OCPP stack uses for its authorization cache, so a hash computed elsewhere in the stack can be compared to this one directly. Absent only if the digest could not be calculated.
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
Reason for stopping transaction
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Additional properties are allowed.
The transaction id known to the CSMS, always as a string. Only present in OCPP setups: for OCPP 2.0.1 and 2.1 it is identical to session_id, for OCPP 1.6 it is the numeric id assigned by the CSMS in decimal notation, which arrives only after the transaction has already started. With early OCPP TxStartPoints an OCPP transaction can exist for a session that never reaches an EVerest transaction, so this may be present while transaction is absent.
Time the OCPP transaction started, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction start and can differ from timestamp_start and from the timestamps of transaction, because the point at which an OCPP 2.x transaction starts is configurable via its TxStartPoint. Absent if no OCPP module is connected or the event was not received.
Time the OCPP transaction stopped, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction stop and can differ from timestamp_stop and from the timestamps of transaction, because the point at which an OCPP 2.x transaction stops is configurable via its TxStopPoint. Absent if no OCPP module is connected or the event was not received.
Session cost object containing the total cost of the session and a list of chunks
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
A list of connector ids to which the authorization can be assigned
Indicates that the id token is already validated by the provider
The X.509 certificated presented by EV and encoded in PEM format
Contains the information needed to verify the EV Contract Certificate via OCSP
Used algorithms for the hashes provided
Hashed value of the Issuer Distinguished Name
Hashed value of the issuers public key
The serial number of the certificate
This contains the responder URL
Additional properties are allowed.
The session id
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
List of cost chunks. The total cost of the session is the sum of all chunks.
Absolute timestamp for the start of this chunk in RFC3339 UTC format
Absolute timestamp for the end of this chunk in RFC3339 UTC format
Metervalue (energy Wh import) for the start of this chunk
Metervalue (energy Wh import) for the end of this chunk
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Cost category
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Charging prices.
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Pricing for the next period
Time when these prices become active.
Price components while charging
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.
Message to show to the user containing information about the price
Format of the message to be displayed
QR Code with more information. For example when the charging is finished, to download the invoice from
Additional properties are allowed.
Present if more matching records follow this page. Pass it in the next request to continue the iteration; a reply without it means the iteration is complete.
Additional properties are allowed.
One persistently stored session record. A record is created when the session starts and completed when it finishes, so the fields that are only known at the end of a session are absent while the record is open.
The EVSE generated UUID of the session. A session contains at most one transaction, so this also identifies the transaction charged within it.
The numeric id of the EVSE this session ran on, as used across EVerest interfaces (1-based).
The EVSEID of the EVSE this session ran on, as configured in the EvseManager. Empty if the EvseManager does not provide one.
The id of the connector that was used for this session.
Lifecycle state of a stored session record
Time the session started, in RFC3339 format
Time the session finished, in RFC3339 format. Absent while the record is Open, and absent on Stale records.
Reason for session start
The transaction charged within a session. It starts at the point where all preconditions for charging are met and finishes when one of them irrevocably becomes false, so the fields that are only known at the end of a transaction are absent while it is running.
Time the transaction started, in RFC3339 format
Time the transaction finished, in RFC3339 format. Absent while the transaction is still running.
Total imported energy reading taken when the transaction started, in Wh
Total imported energy reading taken when the transaction finished, in Wh. Absent while the transaction is still running.
Hash of the id token that started the transaction. The raw token is never stored as a dedicated field, but note that a stored signed meter value embeds it (OCMF ID field). Computed as the lower case hex encoded SHA256 digest of the id token type concatenated with the id token value, matching the hash the OCPP stack uses for its authorization cache, so a hash computed elsewhere in the stack can be compared to this one directly. Absent only if the digest could not be calculated.
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
Reason for stopping transaction
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Additional properties are allowed.
The transaction id known to the CSMS, always as a string. Only present in OCPP setups: for OCPP 2.0.1 and 2.1 it is identical to session_id, for OCPP 1.6 it is the numeric id assigned by the CSMS in decimal notation, which arrives only after the transaction has already started. With early OCPP TxStartPoints an OCPP transaction can exist for a session that never reaches an EVerest transaction, so this may be present while transaction is absent.
Time the OCPP transaction started, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction start and can differ from timestamp_start and from the timestamps of transaction, because the point at which an OCPP 2.x transaction starts is configurable via its TxStartPoint. Absent if no OCPP module is connected or the event was not received.
Time the OCPP transaction stopped, in RFC3339 format, as reported in the transaction events of the OCPP module. It is the charging station clock at the OCPP transaction stop and can differ from timestamp_stop and from the timestamps of transaction, because the point at which an OCPP 2.x transaction stops is configurable via its TxStopPoint. Absent if no OCPP module is connected or the event was not received.
Session cost object containing the total cost of the session and a list of chunks
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type for an id token
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
A list of additional custom id tokens than can be used for providing additional information for validation
Arbitrary value of the IdToken
Custom type of the token
Additional properties are allowed.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
A list of connector ids to which the authorization can be assigned
Indicates that the id token is already validated by the provider
The X.509 certificated presented by EV and encoded in PEM format
Contains the information needed to verify the EV Contract Certificate via OCSP
Used algorithms for the hashes provided
Hashed value of the Issuer Distinguished Name
Hashed value of the issuers public key
The serial number of the certificate
This contains the responder URL
Additional properties are allowed.
The session id
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
List of cost chunks. The total cost of the session is the sum of all chunks.
Absolute timestamp for the start of this chunk in RFC3339 UTC format
Absolute timestamp for the end of this chunk in RFC3339 UTC format
Metervalue (energy Wh import) for the start of this chunk
Metervalue (energy Wh import) for the end of this chunk
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Cost category
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Charging prices.
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Pricing for the next period
Time when these prices become active.
Price components while charging
Cost category
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Price components when idle
Grace period in minutes before idle time is charged. Grace minutes start counting from the timestamp of the message in which state changed from "Charging" to "Idle".
Price object containing the currency and the value of money.
Currency object containing the currency code and the accuracy of the minor unit according to ISO 4217.
Currency in 3 alphabetical characters according to ISO 4217.
The number of digits after the decimal separator, that are expressed by the minor units of the currency. For example for Euro, Euro cents express 2 digits after the decimal separator. In other words, the price in the main currency units would be the value * 10^(-decimals).
Additional properties are allowed.
'Money amount is expressed as an amount of minor units of the currency. Example price of 1.23 EUR is expressed as { value: 123 }'
The amount of minor units of the currency.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Session status enum. Session can be running or finished. Costs of the running session are not final and can change.
Message to show to the user containing information about the price
Format of the message to be displayed
QR Code with more information. For example when the charging is finished, to download the invoice from
Additional properties are allowed.
Additional properties are allowed.
The transaction charged within a session. It starts at the point where all preconditions for charging are met and finishes when one of them irrevocably becomes false, so the fields that are only known at the end of a transaction are absent while it is running.
Time the transaction started, in RFC3339 format
Time the transaction finished, in RFC3339 format. Absent while the transaction is still running.
Total imported energy reading taken when the transaction started, in Wh
Total imported energy reading taken when the transaction finished, in Wh. Absent while the transaction is still running.
Hash of the id token that started the transaction. The raw token is never stored as a dedicated field, but note that a stored signed meter value embeds it (OCMF ID field). Computed as the lower case hex encoded SHA256 digest of the id token type concatenated with the id token value, matching the hash the OCPP stack uses for its authorization cache, so a hash computed elsewhere in the stack can be compared to this one directly. Absent only if the digest could not be calculated.
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
Reason for stopping transaction
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Representation of a signed meter value
Signed meter data (encoded in a string representation with eg. Base64)
Method used to create the signature
Method used to encode the meter values before signing them
Public key (encoded in a string representation with eg. Base64)
Timestamp of measurement
Additional properties are allowed.
Additional properties are allowed.
Lifecycle state of a stored session record
Identifies a single session record. Exactly one of the members must be set. If both are set, session_id takes precedence.
The EVSE generated UUID of the session
The transaction id known to the CSMS
Additional properties are allowed.
Selects the session records to delete. An empty object deletes every stored record.
Session id of the newest record to delete. Deletes that record and every record stored before it, in the order get_sessions returns them, and keeps the records stored after it. A client that has read all records with get_sessions can pass the session id of the last record it received to delete exactly what it has read, without losing sessions that started in the meantime. If no record with this id exists, nothing is deleted.
Additional properties are allowed.
Result of deleting stored session records
Number of session records that were deleted. With up_to_session_id set, 0 means that no record with that session id exists.
Additional properties are allowed.
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached