Sign in

v1

latestOpenAPI 3.0.42026-07-241876123.9 KB
Installation

Installation details

Retrieves details for the specified installation.
The level of detail available depends on the current user's permissions.

get/api/installation/{id}

Path parameters

idstring uuid required

Installation ID

Query parameters

DetailLevel0 | 1 | 2

Determines the detail level to return for an installation.

0 = Default

1 = UserDetails

2 = UserGroups

0 = no extra details (default), 1 = include list of users that are present in the installation's charge history, 2 = include user group information associated with the installation.

0 = Default

1 = UserDetails

2 = UserGroups

Response

OK

idstring uuid
namestring nullable
addressstring nullable
zipCodestring nullable
citystring nullable
countryIdstring uuid nullable
vatNumberstring nullable
contactEmailstring nullable
installationType0 | 1

0 = Pro

1 = Smart

maxCurrentnumber double nullable
availableCurrentnumber double nullable
availableCurrentPhase1number double nullable
availableCurrentPhase2number double nullable
availableCurrentPhase3number double nullable
availableCurrentMode0 | 1 | 2

AvailableCurrentMode has been replaces by EnabledFeatures, but is still used in API

0 = Manual

1 = Schedule

2 = Auto

availableCurrentScheduleWeekendActiveboolean nullable
threeToOnePhaseSwitchCurrentnumber double nullable
defaultThreeToOneSwitchCurrentnumber double
installationCategoryIdstring uuid nullable
installationCategorystring nullable
useLoadBalancingboolean nullable

This indicates whether load balancing should be enabled for the installation. Defaults to true for Zaptec.ZapCloud.Domain.Models.InstallationAuthenticationType.Native, Zaptec.ZapCloud.Domain.Models.InstallationAuthenticationType.WebHooks, and Zaptec.ZapCloud.Domain.Models.InstallationAuthenticationType.Ocpp. For Zaptec.ZapCloud.Domain.Models.InstallationAuthenticationType.OcppNative, defaults to false depending on the charger's load balancing capability. Not all chargers support load balancing over OCPP natively; the capability is determined by the charger's feature support in its firmware. If a charger does not currently have load balancing support, updating its firmware to a newer version may enable this capability.

isRequiredAuthenticationboolean nullable
latitudenumber double nullable
longitudenumber double nullable
notesstring nullable
activeboolean nullable
networkType0 | 1 | 2 | 3 | 4

0 = Unknown

1 = IT_1_Phase

2 = IT_3_Phase

3 = TN_1_Phase

4 = TN_3_Phase

availableInternetAccessPLCboolean nullable
availableInternetAccessWiFiboolean nullable
createdOnDatestring date-time nullable
updatedOnstring date-time nullable
currentUserRoles0 | 1 | 2 | 4 | 8 | 15 | 16 | 32 | 64 | 128 | 256

0 = None

1 = User

2 = Owner

4 = Maintainer

8 = Administrator

15 = Any

16 = Onboarding

32 = DeviceAdministrator

64 = PartnerAdministrator

128 = Technical

256 = InternalData

authenticationType0 | 1 | 2 | 3

0 = Native

1 = WebHooks

2 = Ocpp

3 = OcppNative

webhooksAuthPayloadstring nullable
webhooksAuthUrlstring nullable
webhooksSessionStartUrlstring nullable
webhooksSessionEndUrlstring nullable
messagingEnabledboolean nullable
routingIdstring nullable
ocppCloudUrlstring nullable
ocppCloudUrlVersion0 | 1

0 = Legacy

1 = Ocpp16Compliant

ocppInitialChargePointPasswordstring nullable
ocppCentralSystemUrlstring nullable
timeZoneNamestring nullable

Time zone display name

timeZoneIanaNamestring nullable

IANA time zone identifier

updateStatusCode0 | 1

0 = Ok

1 = EcoScheduleUpdated

notifications0 | 1 | 2

0 = None

1 = ServicePaymentPastDue

2 = ServicePaymentUnpaid

isSubscriptionsAvailableForCurrentUserboolean nullable
hasUserGroupWithAllowOcppNativeboolean nullable

Indicates whether the installation has a user group connected with permissions for enabling OCPP 1.6J

currentUserHasServiceLevelTechnicalReadAccessboolean nullable

Service-level entitlement flag (not a regular role/permission): true when the current user is entitled to TechnicalRead (debug-log) access on this installation. The entitlement is granted through a user group that carries the Zaptec.ZapCloud.Domain.Models.ServiceLevel.TechnicalRead service level and has an effective Owner permission on the installation (including inherited and wildcard targets). Used by the frontend to decide whether to surface relevant UI. null unless explicitly requested (opt-in).

availableFeatures0 | 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256 | 512 | 65536 | 131072

0 = None

1 = Api_MessageSubscription

2 = Authentication_Internal

4 = PowerManagement_Apm

8 = PowerManagement_EcoMode

16 = PowerManagement_Schedule

32 = PowerManagement_Apm_PowerLimit

64 = Connectivity_4G

128 = Authentication_Ocpp

256 = PowerManagement_Apm_Tariff_PowerLimit

512 = Authentication_OcppNative

65536 = PowerManagement_Apm_Tic

131072 = PowerManagement_Apm_SurplusMode

enabledFeatures0 | 1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256 | 512 | 65536 | 131072

0 = None

1 = Api_MessageSubscription

2 = Authentication_Internal

4 = PowerManagement_Apm

8 = PowerManagement_EcoMode

16 = PowerManagement_Schedule

32 = PowerManagement_Apm_PowerLimit

64 = Connectivity_4G

128 = Authentication_Ocpp

256 = PowerManagement_Apm_Tariff_PowerLimit

512 = Authentication_OcppNative

65536 = PowerManagement_Apm_Tic

131072 = PowerManagement_Apm_SurplusMode

activeChargerCountinteger nullable
feature_PowerManagement_EcoMode_DepartureTimeinteger nullable
feature_PowerManagement_EcoMode_MinEnergynumber double nullable
feature_PowerManagement_EcoMode_DeliveryArea0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14

0 = Unknown

1 = NO1

2 = NO2

3 = NO3

4 = NO4

5 = NO5

6 = SE1

7 = SE2

8 = SE3

9 = SE4

10 = DK1

11 = DK2

12 = FI

13 = NL

14 = BE

feature_PowerManagement_Apm_PowerBudgetKwnumber double nullable
feature_PowerManagement_Apm_PowerRolloverPercentagenumber double nullable
feature_PowerManagement_Apm_EvaluationMinutesnumber double nullable
propertyTariffKwhLimitnumber double nullable
propertyIsMinimumPowerOfflineModeboolean nullable
propertyOfflineModeAllowAnonymousboolean nullable
propertyEnergySensorUniqueIdstring nullable
propertyMainFuseCurrentnumber double nullable
propertyEnergySensorTransmitIntervalinteger nullable
propertyEnergySensorTransmitThresholdnumber double nullable
propertyEnergySensorAverageinteger nullable
propertyMinimumAvailableCurrentPhase1number double nullable
propertyMinimumAvailableCurrentPhase2number double nullable
propertyMinimumAvailableCurrentPhase3number double nullable
propertyLockToMinimumAvailableCurrentboolean nullable
propertyOcppDefaultIdTagstring nullable
propertyEnergySensorRippleEnabledboolean nullable
propertyEnergySensorRippleNumBitsinteger nullable
propertyEnergySensorRipplePercentBits00integer nullable
propertyEnergySensorRipplePercentBits01integer nullable
propertyEnergySensorRipplePercentBits10integer nullable
propertyHomeApmOrderedboolean nullable
propertyEnergySensorScalingFactornumber double nullable
propertyEnergySensorIsOfflineboolean nullable
powerLimitKwnumber double nullable
powerFactornumber double nullable
chargePowerLimitKwnumber double nullable
propertyFirmwareAutomaticUpdatesboolean nullable
propertyMaxSinglePhaseChargeCurrentnumber double nullable
propertySessionMaxStopCountinteger nullable

The maximum number of times a session can be stopped before the charging station will stick to single phase charging. Note that start commands that require phase shifting will require a stop and will add to the counter.