OpenAPI reference

Receiver SetChargingProfile

PUT/chargingprofiles/{session_id}

Creates or updates a ChargingProfile for a specific charging session. This gateway currently fail-closes with `NOT_SUPPORTED` until a real ChargingProfiles dispatcher is wired.

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

Overview

PUT /chargingprofiles/{session_id}

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

Creates or updates a ChargingProfile for a specific charging session. This gateway currently fail-closes with NOT_SUPPORTED until a real ChargingProfiles dispatcher is wired.

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/chargingprofiles/SESSION1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"charging_profile":{"charging_rate_unit":"W","charging_profile_period":[{"start_period":0,"limit":11000},{"start_period":3600,"limit":7000},{"start_period":7200,"limit":3500}]},"response_url":"https://example.com/ocpi/emsp/2.2.1/chargingprofiles/result/5678"}'

Request

Path parameters

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

Request body

application/json · Required

Schema: SetChargingProfile

Field	Type	Required	Description
`charging_profile`	`ChargingProfile`	Yes	`ChargingProfile`
`response_url`	`string`	Yes	URL for the async ChargingProfileResult POST.

Request examples

Example 1

1{
2  "charging_profile": {
3    "charging_rate_unit": "W",
4    "charging_profile_period": [
5      {
6        "start_period": 0,
7        "limit": 11000
8      },
9      {
10        "start_period": 3600,
11        "limit": 7000
12      },
13      {
14        "start_period": 7200,
15        "limit": 3500
16      }
17    ]
18  },
19  "response_url": "https://example.com/ocpi/emsp/2.2.1/chargingprofiles/result/5678"
20}

Example 2

1{
2  "charging_profile": {
3    "charging_rate_unit": "A",
4    "charging_profile_period": [
5      {
6        "start_period": 0,
7        "limit": 16
8      },
9      {
10        "start_period": 1800,
11        "limit": 10
12      }
13    ]
14  },
15  "response_url": "https://example.com/ocpi/emsp/2.2.1/chargingprofiles/result/9012"
16}

Responses

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

`200` — successful response

application/json

Schema: ChargingProfileResponseWrapper

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`ChargingProfileResponse`	No	Immediate response to a ChargingProfiles request.

Response example

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

`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/chargingprofiles/SESSION1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"charging_profile":{"charging_rate_unit":"W","charging_profile_period":[{"start_period":0,"limit":11000},{"start_period":3600,"limit":7000},{"start_period":7200,"limit":3500}]},"response_url":"https://example.com/ocpi/emsp/2.2.1/chargingprofiles/result/5678"}'

OpenAPI reference

Receiver SetChargingProfile

PUT/chargingprofiles/{session_id}

Creates or updates a ChargingProfile for a specific charging session. This gateway currently fail-closes with `NOT_SUPPORTED` until a real ChargingProfiles dispatcher is wired.

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

Overview

PUT /chargingprofiles/{session_id}

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

Creates or updates a ChargingProfile for a specific charging session. This gateway currently fail-closes with NOT_SUPPORTED until a real ChargingProfiles dispatcher is wired.

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/chargingprofiles/SESSION1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"charging_profile":{"charging_rate_unit":"W","charging_profile_period":[{"start_period":0,"limit":11000},{"start_period":3600,"limit":7000},{"start_period":7200,"limit":3500}]},"response_url":"https://example.com/ocpi/emsp/2.2.1/chargingprofiles/result/5678"}'

Request

Path parameters

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

Request body

application/json · Required

Schema: SetChargingProfile

Field	Type	Required	Description
`charging_profile`	`ChargingProfile`	Yes	`ChargingProfile`
`response_url`	`string`	Yes	URL for the async ChargingProfileResult POST.

Request examples

Example 1

1{
2  "charging_profile": {
3    "charging_rate_unit": "W",
4    "charging_profile_period": [
5      {
6        "start_period": 0,
7        "limit": 11000
8      },
9      {
10        "start_period": 3600,
11        "limit": 7000
12      },
13      {
14        "start_period": 7200,
15        "limit": 3500
16      }
17    ]
18  },
19  "response_url": "https://example.com/ocpi/emsp/2.2.1/chargingprofiles/result/5678"
20}

Example 2

1{
2  "charging_profile": {
3    "charging_rate_unit": "A",
4    "charging_profile_period": [
5      {
6        "start_period": 0,
7        "limit": 16
8      },
9      {
10        "start_period": 1800,
11        "limit": 10
12      }
13    ]
14  },
15  "response_url": "https://example.com/ocpi/emsp/2.2.1/chargingprofiles/result/9012"
16}

Responses

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

`200` — successful response

application/json

Schema: ChargingProfileResponseWrapper

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`ChargingProfileResponse`	No	Immediate response to a ChargingProfiles request.

Response example

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

`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/chargingprofiles/SESSION1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"charging_profile":{"charging_rate_unit":"W","charging_profile_period":[{"start_period":0,"limit":11000},{"start_period":3600,"limit":7000},{"start_period":7200,"limit":3500}]},"response_url":"https://example.com/ocpi/emsp/2.2.1/chargingprofiles/result/5678"}'

Receiver SetChargingProfile

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

Receiver SetChargingProfile

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