reserve_now

OCPP 2.1 ReserveNow 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
`connector_type`	`String`	—	This field specifies the connector type. Values defined in Appendix as ConnectorEnumStringType. (max 20 chars)
`custom_data`	`CustomData`	—
`evse_id`	`Int`	—	This contains ID of the evse to be reserved. (≥ 0)
`expiry_date_time`	`DateTime`	✓	Date and time at which the reservation expires.
`group_id_token`	`IdToken`	—
`id`	`Int`	✓	Id of reservation. (≥ 0)
`id_token`	`IdToken`	✓

Schema: ReserveNowRequest

pub type Request {
  Request(
    connector_type: option.Option(String),
    custom_data: option.Option(custom_data.CustomData),
    evse_id: option.Option(Int),
    expiry_date_time: timestamp.Timestamp,
    group_id_token: option.Option(id_token.IdToken),
    id: Int,
    id_token: id_token.IdToken,
  )
}

Constructors

Request(
  connector_type: option.Option(String),
  custom_data: option.Option(custom_data.CustomData),
  evse_id: option.Option(Int),
  expiry_date_time: timestamp.Timestamp,
  group_id_token: option.Option(id_token.IdToken),
  id: Int,
  id_token: id_token.IdToken,
)

Response

</>

Field	Type	Req
`custom_data`	`CustomData`	—
`status`	`ReserveNowStatus`	✓
`status_info`	`StatusInfo`	—

Schema: ReserveNowResponse

pub type Response {
  Response(
    custom_data: option.Option(custom_data.CustomData),
    status: reserve_now_status.ReserveNowStatus,
    status_info: option.Option(status_info.StatusInfo),
  )
}

Constructors

Response(
  custom_data: option.Option(custom_data.CustomData),
  status: reserve_now_status.ReserveNowStatus,
  status_info: option.Option(status_info.StatusInfo),
)

Values

new_request

</>

pub fn new_request(
  expiry_date_time expiry_date_time: timestamp.Timestamp,
  id id: Int,
  id_token id_token: id_token.IdToken,
) -> Request

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

new_response

</>

pub fn new_response(
  status status: reserve_now_status.ReserveNowStatus,
) -> 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.