Menu
Commands

Get a command

GET/v1/charging-stations/{chargingStationId}/commands/{commandId}

Returns a command and everything known about it so far. Poll it after sending a command to learn how it ended, or watch for commandStatusChanged on live updates instead.

Once status is final (accepted, rejected, failed, superseded or expired) it never changes again.

Authorization

  • Authorizationheader · stringrequired
    Bearer <token>, with an ID token from a console sign-in or an API key (flw_ak_…). How authentication works

Parameters

  • chargingStationIdpath · uuidrequired
    The charger the command was sent to.
  • commandIdpath · uuidrequired
    The command to read.

Responses

The command as it stands now.

  • chargingStationIduuidrequired
    The charger the command is for.
  • commandTypeenumrequired
    Which command this is, such as reset or remoteStartTransaction.
    One ofresetunlockConnectorchangeAvailabilityremoteStartTransactionremoteStopTransactionreserveNowcancelReservationupdateFirmwaregetDiagnosticschangeConfigurationdataTransfergetConfigurationgetVariablessetVariablessetChargingProfileclearChargingProfiletriggerMessage
  • createdAtdate-timerequired
  • expiresAtdate-timerequired
    If the command is still waiting to be delivered at this time, it's dropped and becomes expired. Five minutes for reset, unlockConnector and changeAvailability, 30 minutes for reservations, and 15 minutes for everything else.
  • iduuidrequired
  • requestone of 17required
    What was sent to the charger. It can differ from what you posted: a reserveNow gains the reservationId Flowion assigned, and a start shows the limits it was sent with.
    One of 17 shapes
    reset
    • kindenumrequired
      Soft restarts the charger's software gracefully, ending running sessions properly. Hard power-cycles it; use it when a soft restart hasn't helped.
      One ofSoftHard
    • typeenumrequired
      One ofreset
    • evseIdintegernullable≥ 0
      Restart only this EVSE. Leave out to restart the whole charger. Not supported on every charger.
    • scheduleenumnullable
      When to restart: immediate, onIdle (once no session is running) or immediateAndResume (resume the running session afterwards). Not supported on every charger.
      One ofimmediateonIdleimmediateAndResume
    unlockConnector
    • connectorIdintegerrequired≥ 0
      The charger's own number for the connector (1, 2, …), not an id from the API.
    • typeenumrequired
      One ofunlockConnector
    • evseIdintegernullable≥ 0
      The EVSE the connector is on, for chargers where connector numbers repeat across EVSEs.
    changeAvailability
    • connectorIdintegerrequired≥ 0
      The charger's own number for the connector (1, 2, …), not an id from the API. 0 means the whole charger.
    • kindenumrequired
      Operative to accept new sessions, Inoperative to refuse them.
      One ofOperativeInoperative
    • typeenumrequired
      One ofchangeAvailability
    • evseIdintegernullable≥ 0
      Target one EVSE instead. Not supported on every charger.
    remoteStartTransaction
    • typeenumrequired
      One ofremoteStartTransaction
    • chargingProfileobjectnullable
      The rate limit the session was started with, if any.
      10 child fields
      • iduuidrequired
      • kindenumrequired
        How the schedule is timed.
        One ofAbsoluteRecurringRelative
      • profileNumberintegerrequired
        The number the charger knows this limit by.
      • purposeenumrequired
        What the limit applies to.
        One ofChargePointMaxProfileTxDefaultProfileTxProfile
      • scheduleobjectrequired
        The power the limit allows over time.
        5 child fields
        • periodsarray of objectrequired
          The steps, in order of offsetSeconds.
        • unitenumrequired
          Whether the limits are in amps or watts.
          One ofampswatts
        • anchordate-timenullable
          The moment the schedule's steps are counted from. null for a limit that counts from the start of each session.
        • durationSecondsintegernullable≥ 0
          How long the schedule, or each daily or weekly cycle, lasts, in seconds. null keeps the last step in force.
        • minRatenumbernullable
          The lowest rate the car can charge at, in the schedule's unit. A hint for the charger.
      • stackLevelintegerrequired≥ 0
        The limit's priority on the charger. Higher wins.
      • recurrencyKindenumnullable
        Daily or Weekly for a repeating limit. null otherwise.
        One ofDailyWeekly
      • transactionIdone of 2nullable
        The session this limit is for, as the charger identifies it. null unless it's for one session.
        One of 2 shapes
        integer
          string
          • validFromdate-timenullable
            When the limit starts applying. null means immediately.
          • validTodate-timenullable
            When the limit stops applying. null means until it's replaced.
        • connectorIdintegernullable≥ 0
          The connector number asked for. null let the charger choose.
        • evseIdintegernullable≥ 0
          The EVSE asked for. null let the charger choose.
        • principalIduuidnullable
          The person the charge was started for, if any.
        • transactionLimitobjectnullable
          The cap on the session's total, if any.
          3 child fields
          • maxEnergyWhnumbernullable
            The most energy the session may deliver, in Wh.
          • maxSocPercentintegernullable≥ 0
            The state of charge to stop at, from 0 to 100.
          • maxTimeSecondsintegernullable
            The longest the session may run, in seconds from its start.
        remoteStopTransaction
        • transactionIdone of 2required
          The session to stop, the way the charger knows it: the transaction's numericId as a number, or its textId as a string.
          One of 2 shapes
          integer
            string
            • typeenumrequired
              One ofremoteStopTransaction
            reserveNow
            • connectorIdintegerrequired≥ 0
              The connector number held. 0 means the charger rather than one connector.
            • expiresAtdate-timerequired
              When the reservation ends if it hasn't been used.
            • reservationIdintegerrequired
              The reservation's number. Use it to cancel it with cancelReservation.
            • typeenumrequired
              One ofreserveNow
            • connectorTypestringnullable
              The kind of connector asked for, if any.
            • evseIdintegernullable≥ 0
              The EVSE held, if one was named.
            • principalIduuidnullable
              The person it's held for.
            cancelReservation
            • reservationIdintegerrequired
              The reservation to cancel: the reservationId in the reserveNow command's request.
            • typeenumrequired
              One ofcancelReservation
            updateFirmware
            • retrieveDatedate-timerequired
              When the charger should start downloading the firmware.
            • typeenumrequired
              One ofupdateFirmware
            • retriesintegernullable≥ 0
              How many more times the charger may try if the download fails.
            • retryIntervalintegernullable≥ 0
              Seconds between download attempts.
            getDiagnostics
            • locationstringrequired
              Where the charger was asked to upload the file.
            • typeenumrequired
              One ofgetDiagnostics
            • retriesintegernullable≥ 0
              How many more times the charger may try if the upload fails.
            • retryIntervalintegernullable≥ 0
              Seconds between upload attempts.
            • startTimedate-timenullable
              The earliest log entries asked for.
            • stopTimedate-timenullable
              The latest log entries asked for.
            changeConfiguration
            • keystringrequired
              The setting's key.
            • typeenumrequired
              One ofchangeConfiguration
            • valuestringrequired
              The new value that was sent.
            dataTransfer
            • typeenumrequired
              One ofdataTransfer
            • vendorIdstringrequired
              Whose messages these are.
            • datastringnullable
              The message body that was sent.
            • messageIdstringnullable
              Which message, within the manufacturer's set.
            getConfiguration
            • keysarray of stringrequired
              The keys asked for. Empty means all of them.
            • typeenumrequired
              One ofgetConfiguration
            getVariables
            • typeenumrequired
              One ofgetVariables
            • variablesarray of objectrequired
              The variables asked for.
              3 child fields
              • componentobjectrequired
                The component the variable belongs to.
              • variableobjectrequired
                The variable to read.
              • attributeTypeenumnullable
                Which value to read. Leave out for the actual value.
                One ofactualtargetmin_setmax_set
            setVariables
            • typeenumrequired
              One ofsetVariables
            • variablesarray of objectrequired
              The variables and values sent.
              4 child fields
              • componentobjectrequired
                The component the variable belongs to.
              • valuestringrequired
                The new value, as a string.
              • variableobjectrequired
                The variable to change.
              • attributeTypeenumnullable
                Which value to set. Leave out for the actual value.
                One ofactualtargetmin_setmax_set
            setChargingProfile
            • connectorIdintegerrequired≥ 0
              The connector number the limit applies to. 0 means the whole charger.
            • profileobjectrequired
              The limit that was sent.
              10 child fields
              • iduuidrequired
              • kindenumrequired
                How the schedule is timed.
                One ofAbsoluteRecurringRelative
              • profileNumberintegerrequired
                The number the charger knows this limit by.
              • purposeenumrequired
                What the limit applies to.
                One ofChargePointMaxProfileTxDefaultProfileTxProfile
              • scheduleobjectrequired
                The power the limit allows over time.
                5 child fields
                • periodsarray of objectrequired
                  The steps, in order of offsetSeconds.
                • unitenumrequired
                  Whether the limits are in amps or watts.
                  One ofampswatts
                • anchordate-timenullable
                  The moment the schedule's steps are counted from. null for a limit that counts from the start of each session.
                • durationSecondsintegernullable≥ 0
                  How long the schedule, or each daily or weekly cycle, lasts, in seconds. null keeps the last step in force.
                • minRatenumbernullable
                  The lowest rate the car can charge at, in the schedule's unit. A hint for the charger.
              • stackLevelintegerrequired≥ 0
                The limit's priority on the charger. Higher wins.
              • recurrencyKindenumnullable
                Daily or Weekly for a repeating limit. null otherwise.
                One ofDailyWeekly
              • transactionIdone of 2nullable
                The session this limit is for, as the charger identifies it. null unless it's for one session.
                One of 2 shapes
                integer
                  string
                  • validFromdate-timenullable
                    When the limit starts applying. null means immediately.
                  • validTodate-timenullable
                    When the limit stops applying. null means until it's replaced.
                • typeenumrequired
                  One ofsetChargingProfile
                clearChargingProfile
                • criteriaobjectrequired
                  Which limits to remove.
                  4 child fields
                  • connectorIdintegernullable≥ 0
                    Only limits on this connector number.
                  • idintegernullable
                    Only the limit with this number.
                  • purposeenumnullable
                    Only limits of this kind.
                    One ofChargePointMaxProfileTxDefaultProfileTxProfile
                  • stackLevelintegernullable≥ 0
                    Only limits at this priority.
                • typeenumrequired
                  One ofclearChargingProfile
                triggerMessage
                • requestedMessageenumrequired
                  The report asked for.
                  One ofstatusNotificationheartbeatbootNotificationmeterValuesfirmwareStatusNotificationdiagnosticsStatusNotification
                • typeenumrequired
                  One oftriggerMessage
                • connectorIdintegernullable≥ 0
                  The connector number asked about. null means all of them.
              • statusenumrequired
                queued (waiting for the charger to connect), sent (delivered, waiting for an answer), then one of: accepted or rejected (the charger's answer, in result), failed (no usable answer came back), superseded (replaced by a newer command, see supersededBy) or expired (never delivered before expiresAt). Final states never change.
                One ofqueuedsentacceptedrejectedfailedsupersededexpired
              • evseIdintegernullable≥ 0
                The EVSE the command is for. null for the whole charger.
              • failureReasonstringnullable
                Why the command was rejected or failed, when there is a reason. null otherwise.
              • issuedByobjectnullable
                Who sent the command.
                4 child fields
                • kindenumrequired
                  A person, an API key or Flowion itself.
                  One ofpersonapiKeyflowion
                • apiKeyIdstringnullable
                  The API key that sent it, when kind is apiKey.
                • displayNamestringnullable
                  The member's email, when Flowion could look it up. Absent otherwise, for example for someone who has since left.
                • userIdstringnullable
                  The member who sent it, when kind is person.
              • resolvedAtdate-timenullable
                When the command reached its final status. null until then.
              • resultone of 17nullable
                The charger's answer, once it has given one. null until then, and for a command that failed or expired.
                One of 17 shapes
                reset
                • statusenumrequired
                  Accepted, Rejected, or Scheduled: accepted, and it restarts as soon as it can.
                  One ofAcceptedRejectedScheduled
                • typeenumrequired
                  One ofreset
                unlockConnector
                • statusenumrequired
                  Whether the cable was released.
                  One ofUnlockedUnlockFailedNotSupportedUnknownConnectorOngoingAuthorizedTransaction
                • typeenumrequired
                  One ofunlockConnector
                changeAvailability
                • statusenumrequired
                  Accepted, Rejected, or Scheduled: a session is running, so the change applies when it ends.
                  One ofAcceptedRejectedScheduled
                • typeenumrequired
                  One ofchangeAvailability
                remoteStartTransaction
                • statusenumrequired
                  Accepted (it will try) or Rejected.
                  One ofAcceptedRejected
                • typeenumrequired
                  One ofremoteStartTransaction
                remoteStopTransaction
                • statusenumrequired
                  Accepted (it will stop) or Rejected.
                  One ofAcceptedRejected
                • typeenumrequired
                  One ofremoteStopTransaction
                reserveNow
                • statusenumrequired
                  Accepted, or why not: Faulted, Occupied, Rejected or Unavailable.
                  One ofAcceptedFaultedOccupiedRejectedUnavailable
                • typeenumrequired
                  One ofreserveNow
                cancelReservation
                • statusenumrequired
                  Accepted, or Rejected when the charger held no matching reservation.
                  One ofAcceptedRejected
                • typeenumrequired
                  One ofcancelReservation
                updateFirmware
                • typeenumrequired
                  One ofupdateFirmware
                getDiagnostics
                • typeenumrequired
                  One ofgetDiagnostics
                • fileNamestringnullable
                  The name of the file the charger will upload. null when it has no diagnostics to send.
                changeConfiguration
                • statusenumrequired
                  Whether the charger took the change.
                  One ofAcceptedRejectedRebootRequiredNotSupported
                • typeenumrequired
                  One ofchangeConfiguration
                dataTransfer
                • statusenumrequired
                  The charger's verdict.
                  One ofAcceptedRejectedUnknownMessageIdUnknownVendorId
                • typeenumrequired
                  One ofdataTransfer
                • datastringnullable
                  The charger's own reply, if it sent one, exactly as received.
                getConfiguration
                • keysarray of objectrequired
                  The settings the charger reported.
                  3 child fields
                  • keystringrequired
                    The setting's key.
                  • readonlybooleanrequired
                    true if the setting can't be changed. false means you can change it with Change a charger setting.
                  • valuestringnullable
                    The current value. null when the charger knows the key but has no value for it.
                • typeenumrequired
                  One ofgetConfiguration
                • unknownKeysarray of stringrequired
                  Keys asked for that the charger doesn't recognise.
                getVariables
                • resultsarray of objectrequired
                  One result per variable asked for.
                  5 child fields
                  • componentobjectrequired
                    The component the variable belongs to.
                  • statusenumrequired
                    Whether the charger could read it.
                    One ofAcceptedRejectedUnknownComponentUnknownVariableNotSupportedAttributeType
                  • variableobjectrequired
                    The variable that was read.
                  • attributeTypeenumnullable
                    Which value of the variable this is.
                    One ofactualtargetmin_setmax_set
                  • valuestringnullable
                    The value. Only present when status is Accepted.
                • typeenumrequired
                  One ofgetVariables
                setVariables
                • resultsarray of objectrequired
                  One result per variable sent.
                  4 child fields
                  • componentobjectrequired
                    The component the variable belongs to.
                  • statusenumrequired
                    Whether the charger took the change.
                    One ofAcceptedRejectedUnknownComponentUnknownVariableNotSupportedAttributeTypeRebootRequired
                  • variableobjectrequired
                    The variable that was set.
                  • attributeTypeenumnullable
                    Which value of the variable was set.
                    One ofactualtargetmin_setmax_set
                • typeenumrequired
                  One ofsetVariables
                setChargingProfile
                • statusenumrequired
                  Accepted, Rejected, or NotSupported when the charger can't take limits.
                  One ofAcceptedRejectedNotSupported
                • typeenumrequired
                  One ofsetChargingProfile
                clearChargingProfile
                • statusenumrequired
                  Accepted, or Unknown when no limit matched.
                  One ofAcceptedUnknown
                • typeenumrequired
                  One ofclearChargingProfile
                triggerMessage
                • statusenumrequired
                  Accepted, Rejected or NotImplemented.
                  One ofAcceptedRejectedNotImplemented
                • typeenumrequired
                  One oftriggerMessage
              • sentAtdate-timenullable
                When the command was delivered to the charger. null while it's queued.
              • supersededByuuidnullable
                The newer command that replaced this one. null unless status is superseded.

              Headers

              • RateLimit-Limitheader · string
              • RateLimit-Remainingheader · string
              • RateLimit-Resetheader · string

              Your token is missing, has expired or isn't valid. Sign in again, or use a valid API key.

              • errorenumrequired
                A stable code for the error. Switch on this value: it doesn't change between releases.
                One ofaccountHasOpenBalanceaccountNotReadyalreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecannotDeleteDefaultcapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnectedduplicateeaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownforbiddenhandoverNotReadyhasChildCircuitsholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinvalidRequestinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectgrantNotActivelastCircuitOnLocationlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundnotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehicleocppUnavailableorganizationNotEmptyownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablephaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailableserviceUnavailablesessionServiceUnavailablestationOfflinesigningSecretTooShortsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpenunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPin
              • messagestringrequired
                A description for people. Its wording may change, so don't parse it.
              • requestIdstring
                This request's id, the same as the x-request-id response header. Quote it when you contact support.

              There's no such command, or it belongs to a charger outside your organization.

              • errorenumrequired
                A stable code for the error. Switch on this value: it doesn't change between releases.
                One ofaccountHasOpenBalanceaccountNotReadyalreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecannotDeleteDefaultcapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnectedduplicateeaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownforbiddenhandoverNotReadyhasChildCircuitsholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinvalidRequestinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectgrantNotActivelastCircuitOnLocationlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundnotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehicleocppUnavailableorganizationNotEmptyownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablephaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailableserviceUnavailablesessionServiceUnavailablestationOfflinesigningSecretTooShortsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpenunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPin
              • messagestringrequired
                A description for people. Its wording may change, so don't parse it.
              • requestIdstring
                This request's id, the same as the x-request-id response header. Quote it when you contact support.

              Too many requests. Wait the number of seconds in Retry-After, then try again.

              • errorenumrequired
                A stable code for the error. Switch on this value: it doesn't change between releases.
                One ofaccountHasOpenBalanceaccountNotReadyalreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecannotDeleteDefaultcapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnectedduplicateeaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownforbiddenhandoverNotReadyhasChildCircuitsholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinvalidRequestinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectgrantNotActivelastCircuitOnLocationlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundnotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehicleocppUnavailableorganizationNotEmptyownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablephaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailableserviceUnavailablesessionServiceUnavailablestationOfflinesigningSecretTooShortsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpenunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPin
              • messagestringrequired
                A description for people. Its wording may change, so don't parse it.
              • requestIdstring
                This request's id, the same as the x-request-id response header. Quote it when you contact support.

              Headers

              • Retry-Afterheader · string
              • X-RateLimit-Afterheader · string

              Something went wrong on our side. Try again, and if it keeps happening, contact support with the response's requestId.

              • errorenumrequired
                A stable code for the error. Switch on this value: it doesn't change between releases.
                One ofaccountHasOpenBalanceaccountNotReadyalreadyStartedambiguousIdTokenambiguousReservationAddressassetServiceUnavailableassistantCardRequiredassistantDisabledassistantLimitReachedinstallerPhotoDayLimitinstallerPhotoConversationLimitassistantNotEnabledassistantRouteNotAllowedassistantUnavailableauthenticationRequiredauthorizationUnavailablebadRequestbatchTooLargebillingAccountClosedbillingAccountSuspendedbillingNotConfiguredbillingServiceUnavailablecannotDeleteDefaultcapacityExceededcardAlreadyHeldcardBlockedcardOwnedByPrincipalcertificateAuthorityServiceUnavailablechargerUnsafeForHoldcircuitChosenTwicecircuitNotFoundcircuitNotOnJobLocationchargerNotRunningchargePointIdTakenchargerSplitAcrossLocationschargingStationNotAcceptedclaimNotEligibleclaimNotFoundcommandNotSupportedcommandTypeRemovedcommandsUnavailableconflictconfirmationInvalidconfirmationLockedconfirmationNotSentconfirmationRequiredconfirmEraseRequiredconsentMissingconversationClosedconversationBusyconnectionNotEligibleconnectorAlreadyOccupiedconnectorNotFoundconnectorNotOccupiedconfirmOverPlanRequiredcsmsManagedSettingdeclineddiagnosticsReceiverServiceUnavailablediagnosticsRequestOutstandingdiagnosticsUnsupportedProtocolVersiondisconnectedduplicateeaseeCircuitUnmappedeaseeSiteClaimedElsewhereeaseeUnreachableeaseeWrongSerialOrPinemailNotVerifiedemptyEventTypesemptyLimitemptyTransactionLimitenergyControllerUnavailableenergyPricingServiceUnavailableeventTypeNotSubscribableexceedsCapabilityfileExpiredfileNotAvailablefirmwareIdentityUnknownforbiddenhandoverNotReadyhasChildCircuitsholdAmountOutOfRangeholdNotAuthorizedidTokenNotAcceptedidTokenNotRecoverableidempotencyKeyConflictidempotencyKeyInFlightidempotencyKeyReplayedidempotencyStoreUnavailableintegrationEaseeServiceUnavailableintegrationUnavailableconnectionsServiceUnavailableinternalErrorinvalidinvalidAddressinvalidAppDestinationinvalidClientinvalidCoordinatesinvalidCountryinvalidCurrentTypeinvalidEvsesinvalidCursorinvalidErrorCodeinvalidIdTokeninvalidLineinvalidModeinvalidMonitorAssignmentinvalidMonitorConnectioninvalidNameinvalidPaginationinvalidRedirectUriinvalidReasoninvalidPhaseCountinvalidRequestinvalidImageimageTooLargeinvalidWindowmethodNotUsablenotAPaidChargernotCapturedoverRefundpaymentRequiredrevisionConflictinvalidScheduleinvalidScopeinvalidSettingValueinvalidLocationTargetinvalidSluginvalidStartingSocinvalidTargetSocinvalidTargetinvalidTargetUrlinvalidTariffinvalidTariffConditioninvalidTariffIdinvalidTimeZoneinvalidUrlinvalidValueinstallerNotHeldinvitationAlreadyAcceptedinvitationExpiredjobsServiceUnavailableopenJobsservesCustomerGrantsnotAnInstallationsProjectgrantNotActivelastCircuitOnLocationlocationUnderInstallationlocationNotBuiltlocationAlreadyBuiltmetricsStoreErrormetricsStoreUnavailablemessageTooLongmissingIdTokenmissingIdempotencyKeymonitorConflictmonitorNotFoundmqttServiceUnavailablemissingOrMalformedHeaderinvalidTokenjwksUnavailableapiKeyServiceUnavailablenotConnectednotDispatchablenotEntitledassigneeCannotReadJobnotFoundnotReadynotSandboxModenoFirmwareCatalogednoOpenSessionnoSupportedTransferProtocolnoVehicleocppUnavailableorganizationNotEmptyownerCannotLeaveownsOrganizationspaymentMethodRequiredbinding.driver_policy_requires_access_permissionbinding.holder_outside_home_projectpermission_policy.deny_not_allowedpermission_policy.deny_on_owner_floorpermission_policy.in_usepermission_policy.invalid_documentpermission_policy.limit_exceededpermission_policy.managed_immutablepermission_policy.management_permission_for_non_memberpermission_policy.name_takenpermission_policy.not_grantablepermission_policy.unknown_permissionpermission_policy.would_remove_last_editorpaymentsAccountNotFoundpaymentsAccountSubmittedpaymentsOrganizationSyntheticpaymentsUnavailablephaseTopologyNotConfirmedprincipalErasedprincipalInactiveprincipalNotFoundprojectNotFoundproposalAlreadyDecidedprotocolErrorrateLimitErrorrateLimitedratedCurrentNotPositivereferenceTakensandboxOrganizationChargerLimitReachedsandboxProjectChargerLimitReachedsandboxStationRefusedselfParentsellerUnavailableserviceUnavailablesessionServiceUnavailablestationOfflinesigningSecretTooShortsiteClaimedElsewheresiteOwnedByAnotherEaseeOperatorslugChangeNotAcknowledgedslugTakenspotCurrencyMismatchtariffEnergyAndSpottimeZoneRequiredtimedOutscopeNotGrantedscopeTooLargewindowEndedwindowTooLongsessionCapExceededinvalidMonthmonthTooLargemixedCurrenciesmonthNotClosablemonthHasOpenHoldsmonthAlreadyClosedmonthNotClosedoutcomeFinalmonthClosednotCarriabletargetMonthClosedsettlementServiceUnavailabletransactionAlreadyOpentransactionNotOpenunauthorizedunavailableunintelligibleResponseunknownBiddingZoneunknownChargerModelunknownEventTypeunknownFallbackStatusunknownSerialunknownVariableunknownVehicleModelunprocessableunrecognisedApiKeyModeunrecognisedSessionModeunsupportedvendorManagedFirmwarevendorUnreachablevirtualChargerLimitReachedvirtualChargerOrganizationLimitReachedvirtualChargerServiceUnavailablevirtualChargerStateUnavailablewebhookServiceUnavailablewrongPin
              • messagestringrequired
                A description for people. Its wording may change, so don't parse it.
              • requestIdstring
                This request's id, the same as the x-request-id response header. Quote it when you contact support.