- Reference
- OCPI 2.2.1 (CPO)
- Receiver ChargingProfile
OpenAPI reference
Receiver ChargingProfile
/chargingprofiles/{session_id}Clears the ChargingProfile set by the eMSP on the given 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
DELETE /chargingprofiles/{session_id}Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/chargingprofiles/{session_id}
Clears the ChargingProfile set by the eMSP on the given 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.
curl -sS -X DELETE 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/chargingprofiles/SESSION1?response_url=example' \
-H "Authorization: Token $OCPI_TOKEN"Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
session_id | string | Yes | Session.id of the Session object. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
response_url | string | Yes | URL that the async result POST should be sent to. |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful Response | ChargingProfileResponseWrapper |
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
{
"data": {
"result": "ACCEPTED",
"timeout": 30
},
"status_code": 1000,
"status_message": "Success",
"timestamp": "2024-01-15T10:00:00Z"
}401 — unauthorized
application/json
Response example
{
"status_code": 2001,
"status_message": "Unauthorized",
"timestamp": "2025-01-01T00:00:00Z"
}422 — validation error
application/json
Schema: HTTPValidationError
| Field | Type | Required | Description |
|---|---|---|---|
detail | ValidationError[] | No | Detail |
Response example
{
"detail": [
{
"loc": [],
"msg": "string",
"type": "string",
"input": {
"_type": "Input"
},
"ctx": {
"_type": "Context"
}
}
]
}Examples
Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).
curl -sS -X DELETE 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/chargingprofiles/SESSION1?response_url=example' \
-H "Authorization: Token $OCPI_TOKEN"