Add a new location

x-ms-visibility: "important"

Creates a location.

Path Parameters

integrationId string required

Integration ID

application/json

Request Body required

Details for the location

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
]
operator 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
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
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
chargers object[]
Array [
chargerId string
connector object[]
Array [
id string
tariffIds string[]
]
]
siteId int64 nullable
tariffIds string[]

Responses

• 201
• 400
• 401

---

Created location ID

application/json

Schema

Example (from schema)

---

Schema

id string
integrationId string
received boolean
externalId string
countryCode string
partyId 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
]
operator 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
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
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
uid string
evseId string
status string nullable
Possible values: [AVAILABLE, BLOCKED, CHARGING, INOPERATIVE, OUTOFORDER, PLANNED, REMOVED, RESERVED, UNKNOWN]
Default value: AVAILABLE
statusSchedule object[]
Array [
period_begin date-time
period_end date-time
status string
Possible values: [AVAILABLE, BLOCKED, CHARGING, INOPERATIVE, OUTOFORDER, PLANNED, REMOVED, RESERVED, UNKNOWN]
Default value: AVAILABLE
]
capabilities string[]
Possible values: [CHARGING_PROFILE_CAPABLE, CHARGING_PREFERENCES_CAPABLE, CHIP_CARD_SUPPORT, CONTACTLESS_CARD_SUPPORT, CREDIT_CARD_PAYABLE, DEBIT_CARD_PAYABLE, PED_TERMINAL, REMOTE_START_STOP_CAPABLE, RESERVABLE, RFID_READER, START_SESSION_CONNECTOR_REQUIRED, TOKEN_GROUP_CAPABLE, UNLOCK_CAPABLE]
connectors object[]
Array [
id string
standard string nullable
Possible values: [CHADEMO, CHAOJI, DOMESTIC_A, DOMESTIC_B, DOMESTIC_C, DOMESTIC_D, DOMESTIC_E, DOMESTIC_F, DOMESTIC_G, DOMESTIC_H, DOMESTIC_I, DOMESTIC_J, DOMESTIC_K, DOMESTIC_L, DOMESTIC_M, DOMESTIC_N, DOMESTIC_O, GBT_AC, GBT_DC, IEC_60309_2_single_16, IEC_60309_2_three_16, IEC_60309_2_three_32, IEC_60309_2_three_64, IEC_62196_T1, IEC_62196_T1_COMBO, IEC_62196_T2, IEC_62196_T2_COMBO, IEC_62196_T3A, IEC_62196_T3C, NEMA_5_20, NEMA_6_30, NEMA_6_50, NEMA_10_30, NEMA_10_50, NEMA_14_30, NEMA_14_50, PANTOGRAPH_BOTTOM_UP, PANTOGRAPH_TOP_DOWN, TESLA_R, TESLA_S]
Default value: CHADEMO
format string nullable
Possible values: [SOCKET, CABLE]
Default value: SOCKET
powerType string nullable
Possible values: [AC_1_PHASE, AC_2_PHASE, AC_2_PHASE_SPLIT, AC_3_PHASE, DC]
Default value: AC_1_PHASE
maxVoltage int32 nullable
maxAmperage int32 nullable
maxElectricPower int32 nullable
tariffIds 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 string[]
Possible values: [EV_ONLY, PLUGGED, DISABLED, CUSTOMERS, MOTORCYCLES]
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
]
lastUpdated date-time nullable
]
created date-time
lastUpdated date-time

{
  "id": "string",
  "integrationId": "string",
  "received": true,
  "externalId": "string",
  "countryCode": "string",
  "partyId": "string",
  "name": "string",
  "publish": true,
  "publishAllowedTo": [
    {
      "uid": "string",
      "type": "AD_HOC_USER",
      "visualNumber": "string",
      "issuer": "string",
      "groupId": "string"
    }
  ],
  "address": "string",
  "city": "string",
  "postalCode": "string",
  "state": "string",
  "country": "string",
  "coordinates": {
    "latitude": "string",
    "longitude": "string"
  },
  "relatedLocations": [
    {
      "latitude": "string",
      "longitude": "string",
      "name": {
        "language": "string",
        "text": "string"
      }
    }
  ],
  "parkingType": "ALONG_MOTORWAY",
  "directions": [
    {
      "language": "string",
      "text": "string"
    }
  ],
  "operator": {
    "name": "string",
    "website": "string",
    "logo": {
      "url": "string",
      "thumbnail": "string",
      "category": "CHARGER",
      "type": "string",
      "width": 0,
      "height": 0
    }
  },
  "suboperator": {
    "name": "string",
    "website": "string",
    "logo": {
      "url": "string",
      "thumbnail": "string",
      "category": "CHARGER",
      "type": "string",
      "width": 0,
      "height": 0
    }
  },
  "owner": {
    "name": "string",
    "website": "string",
    "logo": {
      "url": "string",
      "thumbnail": "string",
      "category": "CHARGER",
      "type": "string",
      "width": 0,
      "height": 0
    }
  },
  "facilities": [
    "HOTEL"
  ],
  "timezone": "string",
  "openingTimes": {
    "twentyfourseven": true,
    "regularHours": [
      {
        "weekday": 0,
        "periodBegin": "string",
        "periodEnd": "string"
      }
    ],
    "exceptionalOpenings": [
      {
        "periodBegin": "2025-05-28T10:55:51.228Z",
        "periodEnd": "2025-05-28T10:55:51.228Z"
      }
    ],
    "exceptionalClosings": [
      {
        "periodBegin": "2025-05-28T10:55:51.229Z",
        "periodEnd": "2025-05-28T10:55:51.229Z"
      }
    ]
  },
  "chargingWhenClosed": true,
  "images": [
    {
      "url": "string",
      "thumbnail": "string",
      "category": "CHARGER",
      "type": "string",
      "width": 0,
      "height": 0
    }
  ],
  "locationEnergyMix": {
    "isGreenEnergy": true,
    "energySources": [
      {
        "source": "NUCLEAR",
        "percentage": 0
      }
    ],
    "environImpact": [
      {
        "category": "NUCLEAR_WASTE",
        "amount": 0
      }
    ],
    "supplierName": "string",
    "energyProductName": "string"
  },
  "siteId": 0,
  "evses": [
    {
      "chargerId": "string",
      "uid": "string",
      "evseId": "string",
      "status": "AVAILABLE",
      "statusSchedule": [
        {
          "period_begin": "2025-05-28T10:55:51.229Z",
          "period_end": "2025-05-28T10:55:51.229Z",
          "status": "AVAILABLE"
        }
      ],
      "capabilities": [
        "CHARGING_PROFILE_CAPABLE"
      ],
      "connectors": [
        {
          "id": "string",
          "standard": "CHADEMO",
          "format": "SOCKET",
          "powerType": "AC_1_PHASE",
          "maxVoltage": 0,
          "maxAmperage": 0,
          "maxElectricPower": 0,
          "tariffIds": [
            "string"
          ],
          "termsAndConditions": "string",
          "lastUpdated": "2025-05-28T10:55:51.229Z"
        }
      ],
      "floorLevel": "string",
      "coordinates": {
        "latitude": "string",
        "longitude": "string"
      },
      "physicalReference": "string",
      "directions": [
        {
          "language": "string",
          "text": "string"
        }
      ],
      "parkingRestrictions": [
        "EV_ONLY"
      ],
      "images": [
        {
          "url": "string",
          "thumbnail": "string",
          "category": "CHARGER",
          "type": "string",
          "width": 0,
          "height": 0
        }
      ],
      "lastUpdated": "2025-05-28T10:55:51.229Z"
    }
  ],
  "created": "2025-05-28T10:55:51.229Z",
  "lastUpdated": "2025-05-28T10:55:51.229Z"
}

Validation error occurred.

application/json

Schema

Example (from schema)

---

Schema

errorCode string
message string
errorNumber int32
helpLink string

{
  "errorCode": "string",
  "message": "string",
  "errorNumber": 0,
  "helpLink": "string"
}

User not authorized.

Loading...