Skip to main content

Get locations for an integration​

x-ms-visibility: "important"

Retrieve a list of locations for the integration.

Path Parameters
    integrationId string required

    Integration ID

Query Parameters
    page int32

    Page to be fetched. Default: 1

    limit int32

    Limit (No. of records per page). Max value: 100. Default: 100.

    search string

    Free text filter for driver name.

    sortKey string

    Field to be used for sorting. Default: name

    sortDescending boolean

    Set to 'true' to sort descending based on sort key. Default: 'false'

Responses

List of locations.

Schema
    page int32
    limit int32
    totalRecords int32
    hasNextPage boolean
    hasPreviousPage boolean
    items object[]
  • Array [
    • id string
    integrationId string
    externalId string
    countryCode string
    name string
    publish boolean nullable
    publishAllowedTo object[]
  • Array [
    • uid string
    type string

    Possible values: [AD_HOC_USER, APP_USER, OTHER, RFID]

    Default value: AD_HOC_USER

    visualNumber string
    issuer string
    groupId string
  • ]
    • address string
    city string
    postalCode string
    state string
    country string
    coordinates object
    latitude string
    longitude string
    relatedLocations object[]
  • Array [
    • latitude string
    longitude string
    name object
    language string
    text string
  • ]
    • parkingType string nullable

    Possible values: [ALONG_MOTORWAY, PARKING_GARAGE, PARKING_LOT, ON_DRIVEWAY, ON_STREET, UNDERGROUND_GARAGE, OTHER, UNKNOWN]

    Default value: ALONG_MOTORWAY

    directions object[]
  • Array [
    • language string
    text string
  • ]
    • owner object
    name string
    website uri
    logo object
    url uri
    thumbnail uri
    category string

    Possible values: [CHARGER, ENTRANCE, LOCATION, NETWORK, OPERATOR, OTHER, OWNER]

    Default value: CHARGER

    type string
    width int32
    height int32
    suboperator object
    name string
    website uri
    logo object
    url uri
    thumbnail uri
    category string

    Possible values: [CHARGER, ENTRANCE, LOCATION, NETWORK, OPERATOR, OTHER, OWNER]

    Default value: CHARGER

    type string
    width int32
    height int32
    facilities string[]

    Possible values: [HOTEL, RESTAURANT, CAFE, MALL, SUPERMARKET, SPORT, RECREATION_AREA, NATURE, MUSEUM, BIKE_SHARING, BUS_STOP, TAXI_STAND, TRAM_STOP, METRO_STATION, TRAIN_STATION, AIRPORT, PARKING_LOT, CARPOOL_PARKING, FUEL_STATION, WIFI]

    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 string

    Possible values: [CHARGER, ENTRANCE, LOCATION, NETWORK, OPERATOR, OTHER, OWNER]

    Default value: CHARGER

    type string
    width int32
    height int32
  • ]
    • locationEnergyMix object
    isGreenEnergy boolean
    energySources object[]
  • Array [
    • source string

    Possible values: [NUCLEAR, GENERAL_FOSSIL, COAL, GAS, GENERAL_GREEN, SOLAR, WIND, WATER]

    Default value: NUCLEAR

    percentage float
  • ]
    • environImpact object[]
  • Array [
    • category string

    Possible values: [NUCLEAR_WASTE, CARBON_DIOXIDE]

    Default value: NUCLEAR_WASTE

    amount float
  • ]
    • supplierName string
    energyProductName string
    siteId int64 nullable
    evses object[]
  • Array [
    • chargerId string
    connector object[]
  • Array [
    • id string
    tariffIds string[]
  • ]
  • ]
    • lastUpdated date-time
    chargers object[]
  • Array [
    • chargerId string
    chargerName string
    evseId string
    splitEvseBySocket boolean
    siteName string
    siteId int64
    amountOfSockets int64
    activeConnection boolean
    sockets object[]
  • Array [
    • id int32
    name string
    type string
    status string
    format string
    socketPowerType string
    maxVoltage int32 nullable
    maxAmperage int32 nullable
    maxWatts int32 nullable
    tariffs object[]
  • Array [
    • id string
    name string
    currency string
  • ]
  • ]
  • ]
  • ]
Loading...