Skip to content
Abra GraphQL APIs
/
Other
/
/
housingAssociation

GraphQL Overview

Download GraphQL schema
schema.graphql
Home

Queries

Overview

Mutations

Overview
Users

Queries

Overview

Mutations

Overview
Fire

Queries

Overview

Mutations

Overview
Water

Queries

Overview

Mutations

Overview
Access

Queries

Overview

Mutations

Overview
Energy

Queries

Overview

Mutations

Overview
Misc

Queries

Overview

Mutations

Overview
Other

Queries

Overview

smartChargeUserSync

SmartChargeUserSyncPayload

Return type

SmartChargeUserSyncPayload
payload
String
Query sample
query smartChargeUserSync {
  smartChargeUserSync {
    payload 
  }
}
Response sample
{
  "data": {
    "payload": "Example String"
  }
}

routines

(homeId)
RoutineCollection

Arguments

homeId
ID!,non-nullrequired

Return type

RoutineCollection
routines
[Routine!]!,non-null
Query sample
query routines($homeId: ID!) {
  routines(homeId: $homeId) {
    routines {
      id 
      logic {
        trigger {
          condition {
            at 
          }
        }
        action {
          deviceId 
          chargingOn 
        }
        compensatingAction {
          deviceId 
          chargingOn 
        }
      }
      state 
      origin {
        type 
        source 
      }
      description {
        name 
        description 
      }
    }
  }
}
Variables
{
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "routines": [
      {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "logic": {
          "trigger": {
            "condition": {
              "at": "Example String"
            }
          },
          "action": {
            "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "chargingOn": true
          },
          "compensatingAction": {
            "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "chargingOn": true
          }
        },
        "state": "ACTIVE",
        "origin": {
          "type": "CUSTOM",
          "source": "DEMAND_RESPONSE"
        },
        "description": {
          "name": "Example String",
          "description": "Example String"
        }
      }
    ]
  }
}

routine

(routineId)
Routine

Arguments

routineId
ID!,non-nullrequired

Return type

Routine
id
ID!,non-null
logic
RoutineLogic!,non-null
state
RoutineState!,non-null
origin
RoutineOrigin!,non-null
description
RoutineDescription
Query sample
query routine($routineId: ID!) {
  routine(routineId: $routineId) {
    id 
    logic {
      trigger {
        condition {
          at 
        }
      }
      action {
        deviceId 
        chargingOn 
      }
      compensatingAction {
        deviceId 
        chargingOn 
      }
    }
    state 
    origin {
      type 
      source 
    }
    description {
      name 
      description 
    }
  }
}
Variables
{
  "routineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "logic": {
      "trigger": {
        "condition": {
          "at": "Example String"
        }
      },
      "action": {
        "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "chargingOn": true
      },
      "compensatingAction": {
        "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "chargingOn": true
      }
    },
    "state": "ACTIVE",
    "origin": {
      "type": "CUSTOM",
      "source": "DEMAND_RESPONSE"
    },
    "description": {
      "name": "Example String",
      "description": "Example String"
    }
  }
}

demandResponse

DemandResponse

Return type

DemandResponse
eligible
Boolean!,non-null
enrolled
Boolean!,non-null
Query sample
query demandResponse {
  demandResponse {
    eligible 
    enrolled 
  }
}
Response sample
{
  "data": {
    "eligible": true,
    "enrolled": true
  }
}

smartEnergy

(homeId)
SmartEnergy

Arguments

homeId
ID!,non-nullrequired

Return type

SmartEnergy
enabled
Boolean!,non-null
configuration
SmartEnergyConfiguration
devices
[SmartEnergyDevice!]!,non-null
Query sample
query smartEnergy($homeId: ID!) {
  smartEnergy(homeId: $homeId) {
    enabled 
    configuration {
      hourlyLimitWatts 
    }
    devices {
      enabled 
      deviceId 
    }
  }
}
Variables
{
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "enabled": true,
    "configuration": {
      "hourlyLimitWatts": 40
    },
    "devices": [
      {
        "enabled": true,
        "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      }
    ]
  }
}

housingAssociation

(housingAssociationId)
HousingAssociation

Arguments

housingAssociationId
ID!,non-nullrequired

Return type

HousingAssociation
id
ID!,non-null
buildings
[Building!]!,non-null
collectiveAlarmZones
[CollectiveAlarmZone!]!,non-null
Query sample
query housingAssociation($housingAssociationId: ID!) {
  housingAssociation(housingAssociationId: $housingAssociationId) {
    id 
    buildings {
      id 
      units {
        id 
        unitNumber 
      }
      commonAreas {
        id 
        nickname 
      }
    }
    collectiveAlarmZones {
      id 
      facilities {
        id 
        units {
          id 
          unitNumber 
        }
        commonAreas {
          id 
          nickname 
        }
      }
      configurations {
        propagationDelaySeconds 
        meetingPointMap(
          # Arguments Here
        ) {
          url {
            original 
            small 
            medium 
            large 
          }
          uploadUrl 
        }
      }
    }
  }
}
Variables
{
  "housingAssociationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "buildings": [
      {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "units": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "unitNumber": "Example String"
          }
        ],
        "commonAreas": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "nickname": "Example String"
          }
        ]
      }
    ],
    "collectiveAlarmZones": [
      {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "facilities": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "units": [
              {
                "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                "unitNumber": "Example String"
              }
            ],
            "commonAreas": [
              {
                "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                "nickname": "Example String"
              }
            ]
          }
        ],
        "configurations": [
          {
            "propagationDelaySeconds": 40,
            "meetingPointMap": {
              "url": {
                "original": "Example String",
                "small": "Example String",
                "medium": "Example String",
                "large": "Example String"
              },
              "uploadUrl": "Example String"
            }
          }
        ]
      }
    ]
  }
}

getGeofenceStatus

(homeId)
GeofenceStatus

Arguments

homeId
ID!,non-nullrequired

Return type

GeofenceStatus
isActive
Boolean!,non-null
radius
Int!,non-null
geofenceAlarm
String!,non-null
Query sample
query getGeofenceStatus($homeId: ID!) {
  getGeofenceStatus(homeId: $homeId) {
    isActive 
    radius 
    geofenceAlarm 
  }
}
Variables
{
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "isActive": true,
    "radius": 40,
    "geofenceAlarm": "Example String"
  }
}

Mutations

Overview

Subscriptions

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview