Fetch Sessions from the CPO’s system.

Fetch Sessions from the CPO’s system.

Query Parameters

date_from date-time

Only return objects that have last_updated after or equal to this Date/Time (inclusive).

date_to date-time

Only return objects that have last_updated up to this Date/Time, but not including (exclusive).

offset string

The offset of the first object returned. Default is 0 (the first object).

limit string

The maximum number of objects to GET.

Header Parameters

Authorization string required

Token Base64encodedtoken

Responses

• 200
• 400

---

The OK response

Response Headers

• X-Limit any

  The maximum number of objects that the server can return.

• X-Total-Count any

  The total number of objects available in the server system that match the given parameters.

• Link any

  Link to the next page if exists.

application/json

Schema

Example (from schema)

---

Schema

data object[]
Array [
id string
startDatetime date-time nullable
endDatetime date-time nullable
kwh double nullable
authId string
authMethod int32 nullable
Possible values: [0, 1, 2]
Default value: 0
location object
id string
type int32 nullable
Possible values: [0, 1, 2, 3, 4, 5, 6, 7]
Default value: 0
name string
address string
city string
postalCode string
country string
coordinates object
latitude string
longitude string
relatedLocations object[]
Array [
latitude string
longitude string
name object
language string
text string
]
evses object[]
Array [
uid string
evseId string
status int32 nullable
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8]
Default value: 0
statusSchedule object[]
Array [
period_begin date-time
period_end date-time
status int32
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8]
Default value: 0
]
capabilities int32[]
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
connectors object[]
Array [
id string
standard int32 nullable
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26]
Default value: 0
format int32 nullable
Possible values: [0, 1]
Default value: 0
powerType int32 nullable
Possible values: [0, 1, 2]
Default value: 0
voltage int32 nullable
amperage int32 nullable
tariffId string
termsAndConditions uri
lastUpdated date-time nullable
]
floorLevel string
coordinates object
latitude string
longitude string
physicalReference string
directions object[]
Array [
language string
text string
]
parkingRestrictions int32[]
Possible values: [0, 1, 2, 3, 4]
images object[]
Array [
url uri
thumbnail uri
category int32
Possible values: [0, 1, 2, 3, 4, 5, 6]
Default value: 0
type string
width int32
height int32
]
lastUpdated date-time nullable
]
directions object[]
Array [
language string
text string
]
operator object
name string
website uri
logo object
url uri
thumbnail uri
category int32
Possible values: [0, 1, 2, 3, 4, 5, 6]
Default value: 0
type string
width int32
height int32
suboperator object
name string
website uri
logo object
url uri
thumbnail uri
category int32
Possible values: [0, 1, 2, 3, 4, 5, 6]
Default value: 0
type string
width int32
height int32
owner object
name string
website uri
logo object
url uri
thumbnail uri
category int32
Possible values: [0, 1, 2, 3, 4, 5, 6]
Default value: 0
type string
width int32
height int32
facilities int32[]
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]
timeZone string
openingTimes object
twentyfourseven boolean
regularHours object[]
Array [
weekday int32
periodBegin string
periodEnd string
]
exceptionalOpenings object[]
Array [
periodBegin date-time
periodEnd date-time
]
exceptionalClosings object[]
Array [
periodBegin date-time
periodEnd date-time
]
chargingWhenClosed boolean nullable
images object[]
Array [
url uri
thumbnail uri
category int32
Possible values: [0, 1, 2, 3, 4, 5, 6]
Default value: 0
type string
width int32
height int32
]
energyMix object
isGreenEnergy boolean
energySources object[]
Array [
source int32
Possible values: [0, 1, 2, 3, 4, 5, 6, 7]
Default value: 0
percentage float
]
environImpact object[]
Array [
source int32
Possible values: [0, 1]
Default value: 0
amount float
]
supplierName string
energyProductName string
lastUpdated date-time nullable
meterId string
currency string
chargingPeriods object[]
Array [
startDateTime date-time
dimensions object[]
Array [
type int32
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
Default value: 0
volume float
]
tariffId string
]
totalCost double nullable
status int32 nullable
Possible values: [0, 1, 2, 3, 4]
Default value: 0
lastUpdated date-time nullable
]
statusCode int32
statusMessage string
timestamp date-time

{
  "data": [
    {
      "id": "string",
      "startDatetime": "2024-10-10T06:49:35.977Z",
      "endDatetime": "2024-10-10T06:49:35.977Z",
      "kwh": 0,
      "authId": "string",
      "authMethod": 0,
      "location": {
        "id": "string",
        "type": 0,
        "name": "string",
        "address": "string",
        "city": "string",
        "postalCode": "string",
        "country": "string",
        "coordinates": {
          "latitude": "string",
          "longitude": "string"
        },
        "relatedLocations": [
          {
            "latitude": "string",
            "longitude": "string",
            "name": {
              "language": "string",
              "text": "string"
            }
          }
        ],
        "evses": [
          {
            "uid": "string",
            "evseId": "string",
            "status": 0,
            "statusSchedule": [
              {
                "period_begin": "2024-10-10T06:49:35.977Z",
                "period_end": "2024-10-10T06:49:35.977Z",
                "status": 0
              }
            ],
            "capabilities": [
              0
            ],
            "connectors": [
              {
                "id": "string",
                "standard": 0,
                "format": 0,
                "powerType": 0,
                "voltage": 0,
                "amperage": 0,
                "tariffId": "string",
                "termsAndConditions": "string",
                "lastUpdated": "2024-10-10T06:49:35.977Z"
              }
            ],
            "floorLevel": "string",
            "coordinates": {
              "latitude": "string",
              "longitude": "string"
            },
            "physicalReference": "string",
            "directions": [
              {
                "language": "string",
                "text": "string"
              }
            ],
            "parkingRestrictions": [
              0
            ],
            "images": [
              {
                "url": "string",
                "thumbnail": "string",
                "category": 0,
                "type": "string",
                "width": 0,
                "height": 0
              }
            ],
            "lastUpdated": "2024-10-10T06:49:35.977Z"
          }
        ],
        "directions": [
          {
            "language": "string",
            "text": "string"
          }
        ],
        "operator": {
          "name": "string",
          "website": "string",
          "logo": {
            "url": "string",
            "thumbnail": "string",
            "category": 0,
            "type": "string",
            "width": 0,
            "height": 0
          }
        },
        "suboperator": {
          "name": "string",
          "website": "string",
          "logo": {
            "url": "string",
            "thumbnail": "string",
            "category": 0,
            "type": "string",
            "width": 0,
            "height": 0
          }
        },
        "owner": {
          "name": "string",
          "website": "string",
          "logo": {
            "url": "string",
            "thumbnail": "string",
            "category": 0,
            "type": "string",
            "width": 0,
            "height": 0
          }
        },
        "facilities": [
          0
        ],
        "timeZone": "string",
        "openingTimes": {
          "twentyfourseven": true,
          "regularHours": [
            {
              "weekday": 0,
              "periodBegin": "string",
              "periodEnd": "string"
            }
          ],
          "exceptionalOpenings": [
            {
              "periodBegin": "2024-10-10T06:49:35.977Z",
              "periodEnd": "2024-10-10T06:49:35.977Z"
            }
          ],
          "exceptionalClosings": [
            {
              "periodBegin": "2024-10-10T06:49:35.977Z",
              "periodEnd": "2024-10-10T06:49:35.977Z"
            }
          ]
        },
        "chargingWhenClosed": true,
        "images": [
          {
            "url": "string",
            "thumbnail": "string",
            "category": 0,
            "type": "string",
            "width": 0,
            "height": 0
          }
        ],
        "energyMix": {
          "isGreenEnergy": true,
          "energySources": [
            {
              "source": 0,
              "percentage": 0
            }
          ],
          "environImpact": [
            {
              "source": 0,
              "amount": 0
            }
          ],
          "supplierName": "string",
          "energyProductName": "string"
        },
        "lastUpdated": "2024-10-10T06:49:35.978Z"
      },
      "meterId": "string",
      "currency": "string",
      "chargingPeriods": [
        {
          "startDateTime": "2024-10-10T06:49:35.978Z",
          "dimensions": [
            {
              "type": 0,
              "volume": 0
            }
          ],
          "tariffId": "string"
        }
      ],
      "totalCost": 0,
      "status": 0,
      "lastUpdated": "2024-10-10T06:49:35.978Z"
    }
  ],
  "statusCode": 0,
  "statusMessage": "string",
  "timestamp": "2024-10-10T06:49:35.978Z"
}

Something went wrong

Loading...