get_transaction_status

OCPP 2.0.1 GetTransactionStatus action.

Request/Response payload types with their OCPP-J codecs (request_to_json/request_decoder, response_to_json/ response_decoder). Transport-agnostic; the action-string mapping lives in ocpp/v2_0_1/dispatch.

Types

Request

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—
`transaction_id`	`String`	—	The Id of the transaction for which the status is requested. (max 36 chars)

Schema: GetTransactionStatusRequest

pub type Request {
  Request(
    custom_data: option.Option(custom_data.CustomData),
    transaction_id: option.Option(String),
  )
}

Constructors

Request(
  custom_data: option.Option(custom_data.CustomData),
  transaction_id: option.Option(String),
)

Response

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—
`messages_in_queue`	`Bool`	✓	Whether there are still message to be delivered.
`ongoing_indicator`	`Bool`	—	Whether the transaction is still ongoing.

Schema: GetTransactionStatusResponse

pub type Response {
  Response(
    custom_data: option.Option(custom_data.CustomData),
    messages_in_queue: Bool,
    ongoing_indicator: option.Option(Bool),
  )
}

Constructors

Response(
  custom_data: option.Option(custom_data.CustomData),
  messages_in_queue: Bool,
  ongoing_indicator: option.Option(Bool),
)

Values

new_request

</>

pub fn new_request() -> Request

Construct a Request from its required fields, with every optional field set to None.

new_response

</>

pub fn new_response(
  messages_in_queue messages_in_queue: Bool,
) -> Response

Construct a Response from its required fields, with every optional field set to None.

request_decoder

</>

pub fn request_decoder() -> decode.Decoder(Request)

Decode a Request from its OCPP-J JSON object, enforcing schema constraints.

request_to_json

</>

pub fn request_to_json(value: Request) -> json.Json

Encode a Request to its OCPP-J JSON object.

response_decoder

</>

pub fn response_decoder() -> decode.Decoder(Response)

Decode a Response from its OCPP-J JSON object, enforcing schema constraints.

response_to_json

</>

pub fn response_to_json(value: Response) -> json.Json

Encode a Response to its OCPP-J JSON object.