ZAzaptec
Installation

Installation hierarchy

Changed on

Retrieves an installation along with its circuit and charger hierarchy
(requires owner or service permissions).

<b>Note:</b> Only basic properties of the returned model will be populated.

get/api/installation/{id}/hierarchy

Request

  • Base URL
    https://api.zaptec.com
  • URL
    https://api.zaptec.com/api/installation/{id}/hierarchy
  • Auth
    OAuth 2
    Password
    Token URL: https://api.zaptec.com/oauth/token

Path parameters

idstring uuid required

Installation ID

Response

OK

idstring uuid

Get the unique identifier of the installation.

namestring nullable

Get the installation name.

installationNamestring nullable

<strong>This property is obsolete and is scheduled for removal,</strong> please use InstallationName instead.

networkTypeinteger nullable

Get the installation electrical grid type Id. Please refer to the Zaptec integration document for information for explanation of grid type Id.

Changes

  • ba5be4fed4a6Revision changes
    • warning

      removed the optional property from the response with the status (media type: text/plain)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: text/json)

    • info

      the endpoint scheme security legacy_auth was removed from the API