OpenAPI reference

Sender ChargingPreferences

PUT/sessions/{session_id}/charging_preferences

Set charging preferences on an ongoing session. **This CPO does not implement smart charging** and advertises no `CHARGING_PREFERENCES_CAPABLE` EVSE, so per OCPI 2.2.1 §9.2.2 every request is answered

API: OCPI 2.2.1 (CPO) · Module: Sessions (CPO)
Base path: /sessions · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1

Overview

PUT /sessions/{session_id}/charging_preferences

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/sessions/{session_id}/charging_preferences

Set charging preferences on an ongoing session. This CPO does not implement smart charging and advertises no CHARGING_PREFERENCES_CAPABLE EVSE, so per OCPI 2.2.1 §9.2.2 every request is answered with OCPI status_code 2001 (the spec's not-capable response). The gateway logs a compliance warning if it ever observes a session whose EVSE does advertise that capability.

Requires authentication. Use Authorization: Token <token>. See OCPI credentials.

How to call

Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/sessions/SESSION1/charging_preferences' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"profile_type":"CHEAP","departure_time":"2020-03-10T18:00:00Z"}'

Request

Path parameters

Name	Type	Required	Description
`session_id`	`string`	Yes	Session.id of the Session object.

Request body

application/json · Required

Schema: ChargingPreferences

Field	Type	Required	Description
`profile_type`	`"CHEAP"	"FAST"	"GREEN"
`departure_time`	`string (date-time)`	No	—
`energy_need`	`number`	No	—
`discharge_allowed`	`boolean`	No	—

Request examples

Example 1

1{
2  "profile_type": "CHEAP",
3  "departure_time": "2020-03-10T18:00:00Z"
4}

Example 2

1{
2  "profile_type": "GREEN"
3}

Responses

Status	Description	Schema
`200`	Successful Response	`ChargingPreferencesResultResponse`
`400`	Invalid or missing parameters (HTTP 200, OCPI envelope)	`—`
`401`	Unauthorized	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: ChargingPreferencesResultResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`"ACCEPTED"	"DEPARTURE_REQUIRED"	"ENERGY_NEED_REQUIRED"

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2024-01-15T10:00:00Z",
5  "data": "ACCEPTED"
6}

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Invalid or missing parameters",
4  "timestamp": "2025-01-01T00:00:00Z",
5  "doc_url": "https://github.com/ocpplab/ocpi-gateway/blob/main/docs/errors.md#2001-invalid-parameters",
6  "errors": [
7    {
8      "field": "country_code",
9      "message": "expected 'NL' to match Token A identity",
10      "type": "value_error.identity_mismatch"
11    }
12  ]
13}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`422` — validation error

application/json

Schema: HTTPValidationError

Field	Type	Required	Description
`detail`	`ValidationError[]`	No	`Detail`

Response example

1{
2  "detail": [
3    {
4      "loc": [],
5      "msg": "string",
6      "type": "string",
7      "input": {
8        "_type": "Input"
9      },
10      "ctx": {
11        "_type": "Context"
12      }
13    }
14  ]
15}

Examples

Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/sessions/SESSION1/charging_preferences' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"profile_type":"CHEAP","departure_time":"2020-03-10T18:00:00Z"}'

OpenAPI reference

Sender ChargingPreferences

PUT/sessions/{session_id}/charging_preferences

API: OCPI 2.2.1 (CPO) · Module: Sessions (CPO)
Base path: /sessions · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1

Overview

PUT /sessions/{session_id}/charging_preferences

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/sessions/{session_id}/charging_preferences

Requires authentication. Use Authorization: Token <token>. See OCPI credentials.

How to call

Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/sessions/SESSION1/charging_preferences' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"profile_type":"CHEAP","departure_time":"2020-03-10T18:00:00Z"}'

Request

Path parameters

Name	Type	Required	Description
`session_id`	`string`	Yes	Session.id of the Session object.

Request body

application/json · Required

Schema: ChargingPreferences

Field	Type	Required	Description
`profile_type`	`"CHEAP"	"FAST"	"GREEN"
`departure_time`	`string (date-time)`	No	—
`energy_need`	`number`	No	—
`discharge_allowed`	`boolean`	No	—

Request examples

Example 1

1{
2  "profile_type": "CHEAP",
3  "departure_time": "2020-03-10T18:00:00Z"
4}

Example 2

1{
2  "profile_type": "GREEN"
3}

Responses

Status	Description	Schema
`200`	Successful Response	`ChargingPreferencesResultResponse`
`400`	Invalid or missing parameters (HTTP 200, OCPI envelope)	`—`
`401`	Unauthorized	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: ChargingPreferencesResultResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`"ACCEPTED"	"DEPARTURE_REQUIRED"	"ENERGY_NEED_REQUIRED"

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2024-01-15T10:00:00Z",
5  "data": "ACCEPTED"
6}

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Invalid or missing parameters",
4  "timestamp": "2025-01-01T00:00:00Z",
5  "doc_url": "https://github.com/ocpplab/ocpi-gateway/blob/main/docs/errors.md#2001-invalid-parameters",
6  "errors": [
7    {
8      "field": "country_code",
9      "message": "expected 'NL' to match Token A identity",
10      "type": "value_error.identity_mismatch"
11    }
12  ]
13}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`422` — validation error

application/json

Schema: HTTPValidationError

Field	Type	Required	Description
`detail`	`ValidationError[]`	No	`Detail`

Response example

1{
2  "detail": [
3    {
4      "loc": [],
5      "msg": "string",
6      "type": "string",
7      "input": {
8        "_type": "Input"
9      },
10      "ctx": {
11        "_type": "Context"
12      }
13    }
14  ]
15}

Examples

Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/sessions/SESSION1/charging_preferences' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"profile_type":"CHEAP","departure_time":"2020-03-10T18:00:00Z"}'

Sender ChargingPreferences

Overview

How to call

Request

Path parameters

Request body

Request examples

Responses

`200` — successful response

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

`401` — unauthorized

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page

Sender ChargingPreferences

Overview

How to call

Request

Path parameters

Request body

Request examples

Responses

`200` — successful response

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

`401` — unauthorized

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page