Provides information of integration

x-ms-visibility: "important"

Use this endpoint to get integration details.

Path Parameters

integrationId string required

This is the globally unique ID for the integration

Responses

• 200
• 400
• 401

---

Return the JSON representation of integration details

application/json

Schema

Example (from schema)

---

Schema

integrationId string
integrationType string
integrationName string
integrationStatus string
statusDescription string
versionDetails object
version string
endpoints object[]
Array [
identifier int32
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8]
Default value: 0
role int32 nullable
Possible values: [0, 1, 2]
Default value: 0
url uri
]
credentialsExchangeRole string
endPointURL uri

If UtilityCloud integration, then contains scope

partnersCompanyDetail object[]
Also party data of the actual third party if credentials exchange has been done with a platform party
Array [
role string
partyId string
countryCode string
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
]
platformIntegration boolean
platformIntegrationId string
platformPartyId string
platformPartyCountryCode string
locations object[]
Array [
id string
lastUpdated date-time
name string
locationEnergyMix 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 [
category int32
Possible values: [0, 1]
Default value: 0
amount float
]
supplierName string
energyProductName string
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
]
chargingWhenClosed boolean nullable
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
]
timezone string
facilities int32[]
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]
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
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
directions object[]
Array [
language string
text string
]
parkingType int32 nullable
Possible values: [0, 1, 2, 3, 4, 5, 6, 7]
Default value: 0
relatedLocations object[]
Array [
latitude string
longitude string
name object
language string
text string
]
coordinates object
latitude string
longitude string
country string
state string
postalCode string
city string
address string
publishAllowedTo object[]
Array [
uid string
type int32
Possible values: [0, 1, 2, 3]
Default value: 0
visualNumber string
issuer string
groupId string
]
publish boolean nullable
chargers object[]
Array [
chargerID string
chargerName string
chargerGroupName string
chargerGroupID int64
amountOfSockets int32
activeConnection boolean
sockets object[]
Array [
id int32
type string
status string
format string
socketPowerType string
tariffIds string[]
]
]
siteId int64 nullable
]
tariffs object[]
Array [
id string
name string
externalId string
currency string
common boolean
useType int32 nullable
Possible values: [0, 1, 2]
Default value: 0
type int32 nullable
Possible values: [0, 1, 2, 3, 4]
Default value: 0
tariffAltText object[]
Array [
language string
text string
]
tariffAltUrl uri
minPrice object
exclVat double nullable
inclVat double nullable
maxPrice object
exclVat double nullable
inclVat double nullable
elements object[]
Array [
priceComponents object[]
Array [
type int32 nullable
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8]
Default value: 0
price double
Price excluding VAT
vat double nullable
margin double nullable
stepSize int32 nullable
marginPercentage double nullable
priceCap double nullable
costPercentage double nullable
biddingZone string
]
restrictions object
startTime string
endTime string
startDate string
endDate string
minKwh double nullable
maxKwh double nullable
minCurrent double nullable
maxCurrent double nullable
minPower double nullable
maxPower double nullable
minDuration int32 nullable
maxDuration int32 nullable
dayOfWeek int32[]
Possible values: [0, 1, 2, 3, 4, 5, 6]
reservation int32 nullable
Possible values: [0, 1]
Default value: 0
]
startDateTime date-time nullable
endDateTime date-time nullable
tariffEnergyMix 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 [
category int32
Possible values: [0, 1]
Default value: 0
amount float
]
supplierName string
energyProductName string
created date-time nullable
lastUpdated date-time
]
customerRoles int32[]

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8]

models object
pushCdr boolean nullable
pushSession boolean nullable
pushTariff boolean nullable
pushLocation boolean nullable
pullTokensAll boolean nullable
pullTariff boolean nullable
pullLocation boolean nullable
pullSession boolean nullable
pullCdr boolean nullable
pullVersionDetails boolean nullable
chargingPeriodIntervalInMinutes int32 nullable
stateofChargeIsSent boolean
freeVendingWithIdtagAllowed boolean
utilityCloudConnection object
tenant string
clientId string
clientSecret string
meteredValuesAreSent boolean nullable
activateConnection boolean nullable

{
  "integrationId": "string",
  "integrationType": "string",
  "integrationName": "string",
  "integrationStatus": "string",
  "statusDescription": "string",
  "versionDetails": {
    "version": "string",
    "endpoints": [
      {
        "identifier": 0,
        "role": 0,
        "url": "string"
      }
    ]
  },
  "credentialsExchangeRole": "string",
  "endPointURL": "string",
  "partnersCompanyDetail": [
    {
      "role": "string",
      "partyId": "string",
      "countryCode": "string",
      "name": "string",
      "website": "string",
      "logo": {
        "url": "string",
        "thumbnail": "string",
        "category": 0,
        "type": "string",
        "width": 0,
        "height": 0
      }
    }
  ],
  "platformIntegration": true,
  "platformIntegrationId": "string",
  "platformPartyId": "string",
  "platformPartyCountryCode": "string",
  "locations": [
    {
      "id": "string",
      "lastUpdated": "2024-09-02T06:33:51.720Z",
      "name": "string",
      "locationEnergyMix": {
        "isGreenEnergy": true,
        "energySources": [
          {
            "source": 0,
            "percentage": 0
          }
        ],
        "environImpact": [
          {
            "category": 0,
            "amount": 0
          }
        ],
        "supplierName": "string",
        "energyProductName": "string"
      },
      "images": [
        {
          "url": "string",
          "thumbnail": "string",
          "category": 0,
          "type": "string",
          "width": 0,
          "height": 0
        }
      ],
      "chargingWhenClosed": true,
      "openingTimes": {
        "twentyfourseven": true,
        "regularHours": [
          {
            "weekday": 0,
            "periodBegin": "string",
            "periodEnd": "string"
          }
        ],
        "exceptionalOpenings": [
          {
            "periodBegin": "2024-09-02T06:33:51.720Z",
            "periodEnd": "2024-09-02T06:33:51.720Z"
          }
        ],
        "exceptionalClosings": [
          {
            "periodBegin": "2024-09-02T06:33:51.720Z",
            "periodEnd": "2024-09-02T06:33:51.720Z"
          }
        ]
      },
      "timezone": "string",
      "facilities": [
        0
      ],
      "owner": {
        "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
        }
      },
      "directions": [
        {
          "language": "string",
          "text": "string"
        }
      ],
      "parkingType": 0,
      "relatedLocations": [
        {
          "latitude": "string",
          "longitude": "string",
          "name": {
            "language": "string",
            "text": "string"
          }
        }
      ],
      "coordinates": {
        "latitude": "string",
        "longitude": "string"
      },
      "country": "string",
      "state": "string",
      "postalCode": "string",
      "city": "string",
      "address": "string",
      "publishAllowedTo": [
        {
          "uid": "string",
          "type": 0,
          "visualNumber": "string",
          "issuer": "string",
          "groupId": "string"
        }
      ],
      "publish": true,
      "chargers": [
        {
          "chargerID": "string",
          "chargerName": "string",
          "chargerGroupName": "string",
          "chargerGroupID": 0,
          "amountOfSockets": 0,
          "activeConnection": true,
          "sockets": [
            {
              "id": 0,
              "type": "string",
              "status": "string",
              "format": "string",
              "socketPowerType": "string",
              "tariffIds": [
                "string"
              ]
            }
          ]
        }
      ],
      "siteId": 0
    }
  ],
  "tariffs": [
    {
      "id": "string",
      "name": "string",
      "externalId": "string",
      "currency": "string",
      "common": true,
      "useType": 0,
      "type": 0,
      "tariffAltText": [
        {
          "language": "string",
          "text": "string"
        }
      ],
      "tariffAltUrl": "string",
      "minPrice": {
        "exclVat": 0,
        "inclVat": 0
      },
      "maxPrice": {
        "exclVat": 0,
        "inclVat": 0
      },
      "elements": [
        {
          "priceComponents": [
            {
              "type": 0,
              "price": 0,
              "vat": 0,
              "margin": 0,
              "stepSize": 0,
              "marginPercentage": 0,
              "priceCap": 0,
              "costPercentage": 0,
              "biddingZone": "string"
            }
          ],
          "restrictions": {
            "startTime": "string",
            "endTime": "string",
            "startDate": "string",
            "endDate": "string",
            "minKwh": 0,
            "maxKwh": 0,
            "minCurrent": 0,
            "maxCurrent": 0,
            "minPower": 0,
            "maxPower": 0,
            "minDuration": 0,
            "maxDuration": 0,
            "dayOfWeek": [
              0
            ],
            "reservation": 0
          }
        }
      ],
      "startDateTime": "2024-09-02T06:33:51.721Z",
      "endDateTime": "2024-09-02T06:33:51.721Z",
      "tariffEnergyMix": {
        "isGreenEnergy": true,
        "energySources": [
          {
            "source": 0,
            "percentage": 0
          }
        ],
        "environImpact": [
          {
            "category": 0,
            "amount": 0
          }
        ],
        "supplierName": "string",
        "energyProductName": "string"
      },
      "created": "2024-09-02T06:33:51.721Z",
      "lastUpdated": "2024-09-02T06:33:51.721Z"
    }
  ],
  "customerRoles": [
    0
  ],
  "models": {
    "pushCdr": true,
    "pushSession": true,
    "pushTariff": true,
    "pushLocation": true,
    "pullTokensAll": true,
    "pullTariff": true,
    "pullLocation": true,
    "pullSession": true,
    "pullCdr": true,
    "pullVersionDetails": true
  },
  "chargingPeriodIntervalInMinutes": 0,
  "stateofChargeIsSent": true,
  "freeVendingWithIdtagAllowed": true,
  "utilityCloudConnection": {
    "tenant": "string",
    "clientId": "string",
    "clientSecret": "string",
    "meteredValuesAreSent": true,
    "activateConnection": true
  }
}

Something went wrong

Not authorised

Loading...