clear_tariffs

OCPP 2.1 ClearTariffs 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_1/dispatch.

Types

Request

</>

Field	Type	Req	Description
`custom_data`	`CustomData`	—
`evse_id`	`Int`	—	When present only clear tariffs matching tariffIds at EVSE evseId. (≥ 0)
`tariff_ids`	`List(String)`	—	List of tariff Ids to clear. When absent clears all tariffs at evseId. (max 60 chars)

Schema: ClearTariffsRequest

pub type Request {
  Request(
    custom_data: option.Option(custom_data.CustomData),
    evse_id: option.Option(Int),
    tariff_ids: option.Option(List(String)),
  )
}

Constructors

Request(
  custom_data: option.Option(custom_data.CustomData),
  evse_id: option.Option(Int),
  tariff_ids: option.Option(List(String)),
)

Response

</>

Field	Type	Req	Description
`clear_tariffs_result`	`List(ClearTariffsResult)`	✓
`custom_data`	`CustomData`	—

Schema: ClearTariffsResponse

pub type Response {
  Response(
    clear_tariffs_result: List(
      clear_tariffs_result.ClearTariffsResult,
    ),
    custom_data: option.Option(custom_data.CustomData),
  )
}

Constructors

Response(
  clear_tariffs_result: List(
    clear_tariffs_result.ClearTariffsResult,
  ),
  custom_data: option.Option(custom_data.CustomData),
)

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(
  clear_tariffs_result clear_tariffs_result: List(
    clear_tariffs_result.ClearTariffsResult,
  ),
) -> 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.