authorize

OCPP 2.1 Authorize 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
`certificate`	`String`	—	(2.1) The X.509 certificate chain presented by EV and encoded in PEM format. Order of certificates in chain is from leaf up to (but excluding) root certificate. + Only needed in case of central contract validation when Charging Station cannot validate the contract certificate. (max 10000 chars)
`custom_data`	`CustomData`	—
`id_token`	`IdToken`	✓
`iso15118_certificate_hash_data`	`List(OcspRequestData)`	—

Schema: AuthorizeRequest

pub type Request {
  Request(
    certificate: option.Option(String),
    custom_data: option.Option(custom_data.CustomData),
    id_token: id_token.IdToken,
    iso15118_certificate_hash_data: option.Option(
      List(ocsp_request_data.OcspRequestData),
    ),
  )
}

Constructors

Request(
  certificate: option.Option(String),
  custom_data: option.Option(custom_data.CustomData),
  id_token: id_token.IdToken,
  iso15118_certificate_hash_data: option.Option(
    List(ocsp_request_data.OcspRequestData),
  ),
)

Response

</>

Field	Type	Req	Description
`allowed_energy_transfer`	`List(EnergyTransferMode)`	—	(2.1) List of allowed energy transfer modes the EV can choose from. If omitted this defaults to charging only.
`certificate_status`	`AuthorizeCertificateStatus`	—
`custom_data`	`CustomData`	—
`id_token_info`	`IdTokenInfo`	✓
`tariff`	`Tariff`	—

Schema: AuthorizeResponse

pub type Response {
  Response(
    allowed_energy_transfer: option.Option(
      List(energy_transfer_mode.EnergyTransferMode),
    ),
    certificate_status: option.Option(
      authorize_certificate_status.AuthorizeCertificateStatus,
    ),
    custom_data: option.Option(custom_data.CustomData),
    id_token_info: id_token_info.IdTokenInfo,
    tariff: option.Option(tariff.Tariff),
  )
}

Constructors

Response(
  allowed_energy_transfer: option.Option(
    List(energy_transfer_mode.EnergyTransferMode),
  ),
  certificate_status: option.Option(
    authorize_certificate_status.AuthorizeCertificateStatus,
  ),
  custom_data: option.Option(custom_data.CustomData),
  id_token_info: id_token_info.IdTokenInfo,
  tariff: option.Option(tariff.Tariff),
)

Values

new_request

</>

pub fn new_request(
  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(
  id_token_info id_token_info: id_token_info.IdTokenInfo,
) -> 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.