OpenAPI reference

Sender CDRs

GET/cdrs/{cdr_id}

Retrieve a specific CDR by its id.

API: OCPI 2.1.1 (CPO) · Module: CDRs (CPO)
Base path: /cdrs · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1

Overview

GET /cdrs/{cdr_id}

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/cdrs/{cdr_id}

Retrieve a specific CDR by its id.

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 GET 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/cdrs/CDR1' \
2  -H "Authorization: Token $OCPI_TOKEN"

Request

Path parameters

Name	Type	Required	Description
`cdr_id`	`string`	Yes	CDR.id of the CDR object.

Responses

Status	Description	Schema
`200`	Successful Response	`CdrResponse`
`401`	Unauthorized	`—`
`404`	Not Found	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: CdrResponse

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "auth_id": "DE8ACC12E46L89",
7    "auth_method": "WHITELIST",
8    "charging_periods": [
9      {
10        "dimensions": [
11          {
12            "type": "TIME",
13            "volume": 1.973
14          }
15        ],
16        "start_date_time": "2015-06-29T21:39:09Z"
17      }
18    ],
19    "currency": "EUR",
20    "id": "12345",
21    "last_updated": "2015-06-29T22:01:13Z",
22    "location": {
23      "address": "F.Rooseveltlaan 3A",
24      "city": "Gent",
25      "coordinates": {
26        "latitude": "51.047599",
27        "longitude": "3.729944"
28      },
29      "country": "BEL",
30      "evses": [
31        {
32          "connectors": [
33            {
34              "amperage": 64,
35              "format": "SOCKET",
36              "id": "1",
37              "last_updated": "2015-03-16T10:10:02Z",
38              "power_type": "AC_1_PHASE",
39              "standard": "IEC_62196_T2",
40              "tariff_id": "11",
41              "voltage": 230
42            }
43          ],
44          "evse_id": "BE-BEC-E041503003",
45          "last_updated": "2015-06-28T08:12:01Z",
46          "status": "AVAILABLE",
47          "uid": "3256"
48        }
49      ],
50      "id": "LOC1",
51      "last_updated": "2015-06-29T20:39:09Z",
52      "postal_code": "9000",
53      "type": "ON_STREET"
54    },
55    "meter_id": "METER-001",
56    "remark": "Charged at Gent Zuid",
57    "start_date_time": "2015-06-29T21:39:09Z",
58    "stop_date_time": "2015-06-29T23:37:32Z",
59    "tariffs": [
60      {
61        "currency": "EUR",
62        "elements": [
63          {
64            "price_components": [
65              {
66                "price": 2,
67                "step_size": 300,
68                "type": "TIME"
69              }
70            ]
71          }
72        ],
73        "id": "12",
74        "last_updated": "2015-02-02T14:15:01Z"
75      }
76    ],
77    "total_cost": 4,
78    "total_energy": 15.342,
79    "total_parking_time": 0.25,
80    "total_time": 1.973
81  }
82}

`401` — unauthorized

application/json

Response example

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

`404` — not found

application/json

Response example

1{
2  "status_code": 2004,
3  "status_message": "Resource not found",
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 GET 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/cdrs/CDR1' \
2  -H "Authorization: Token $OCPI_TOKEN"

OpenAPI reference

Sender CDRs

GET/cdrs/{cdr_id}

Retrieve a specific CDR by its id.

API: OCPI 2.1.1 (CPO) · Module: CDRs (CPO)
Base path: /cdrs · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1

Overview

GET /cdrs/{cdr_id}

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/cdrs/{cdr_id}

Retrieve a specific CDR by its id.

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 GET 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/cdrs/CDR1' \
2  -H "Authorization: Token $OCPI_TOKEN"

Request

Path parameters

Name	Type	Required	Description
`cdr_id`	`string`	Yes	CDR.id of the CDR object.

Responses

Status	Description	Schema
`200`	Successful Response	`CdrResponse`
`401`	Unauthorized	`—`
`404`	Not Found	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: CdrResponse

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "auth_id": "DE8ACC12E46L89",
7    "auth_method": "WHITELIST",
8    "charging_periods": [
9      {
10        "dimensions": [
11          {
12            "type": "TIME",
13            "volume": 1.973
14          }
15        ],
16        "start_date_time": "2015-06-29T21:39:09Z"
17      }
18    ],
19    "currency": "EUR",
20    "id": "12345",
21    "last_updated": "2015-06-29T22:01:13Z",
22    "location": {
23      "address": "F.Rooseveltlaan 3A",
24      "city": "Gent",
25      "coordinates": {
26        "latitude": "51.047599",
27        "longitude": "3.729944"
28      },
29      "country": "BEL",
30      "evses": [
31        {
32          "connectors": [
33            {
34              "amperage": 64,
35              "format": "SOCKET",
36              "id": "1",
37              "last_updated": "2015-03-16T10:10:02Z",
38              "power_type": "AC_1_PHASE",
39              "standard": "IEC_62196_T2",
40              "tariff_id": "11",
41              "voltage": 230
42            }
43          ],
44          "evse_id": "BE-BEC-E041503003",
45          "last_updated": "2015-06-28T08:12:01Z",
46          "status": "AVAILABLE",
47          "uid": "3256"
48        }
49      ],
50      "id": "LOC1",
51      "last_updated": "2015-06-29T20:39:09Z",
52      "postal_code": "9000",
53      "type": "ON_STREET"
54    },
55    "meter_id": "METER-001",
56    "remark": "Charged at Gent Zuid",
57    "start_date_time": "2015-06-29T21:39:09Z",
58    "stop_date_time": "2015-06-29T23:37:32Z",
59    "tariffs": [
60      {
61        "currency": "EUR",
62        "elements": [
63          {
64            "price_components": [
65              {
66                "price": 2,
67                "step_size": 300,
68                "type": "TIME"
69              }
70            ]
71          }
72        ],
73        "id": "12",
74        "last_updated": "2015-02-02T14:15:01Z"
75      }
76    ],
77    "total_cost": 4,
78    "total_energy": 15.342,
79    "total_parking_time": 0.25,
80    "total_time": 1.973
81  }
82}

`401` — unauthorized

application/json

Response example

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

`404` — not found

application/json

Response example

1{
2  "status_code": 2004,
3  "status_message": "Resource not found",
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 GET 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/cdrs/CDR1' \
2  -H "Authorization: Token $OCPI_TOKEN"

Sender CDRs

Overview

How to call

Request

Path parameters

Responses

`200` — successful response

`401` — unauthorized

`404` — not found

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page

Sender CDRs

Overview

How to call

Request

Path parameters

Responses

`200` — successful response

`401` — unauthorized

`404` — not found

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page