Skip to content
Home
Overview
Overview
Users
Overview
Overview
Fire
Overview
Overview
Water
Overview
Overview
Access
Overview
Overview
Energy
Overview
Overview
Misc
Overview
Overview
Other
Overview
Overview

Arguments

data

Return type

PushNotificationEndpointSetPayload
Mutation sample
mutation pushNotificationEndpointSet($data: PushNotificationEndpointInput!) {
  pushNotificationEndpointSet(data: $data) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "data": { "address": "Example String", "channel": "GCM" } }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

notificationIds
[ID!]!,non-nullrequired

Return type

NotificationInboxMarkAsReadPayload
Mutation sample
mutation notificationInboxMarkAsRead($notificationIds: [ID!]!) {
  notificationInboxMarkAsRead(notificationIds: $notificationIds) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "notificationIds": [ "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" ] }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Return type

DemandResponseEnrollPayload
Mutation sample
mutation demandResponseEnroll {
  demandResponseEnroll {
    errors {
      message 
      path 
    }
  }
}
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Return type

DemandResponseUnenrollPayload
Mutation sample
mutation demandResponseUnenroll {
  demandResponseUnenroll {
    errors {
      message 
      path 
    }
  }
}
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

homeId
ID!,non-nullrequired
hourlyLimitWatts
Int!,non-nullrequired

Return type

SmartEnergyEnablePayload
Mutation sample
mutation smartEnergyEnable($homeId: ID!, $hourlyLimitWatts: Int!) {
  smartEnergyEnable(homeId: $homeId, hourlyLimitWatts: $hourlyLimitWatts) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "hourlyLimitWatts": 40 }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

homeId
ID!,non-nullrequired

Return type

SmartEnergyDisablePayload
Mutation sample
mutation smartEnergyDisable($homeId: ID!) {
  smartEnergyDisable(homeId: $homeId) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

homeId
ID!,non-nullrequired
hourlyLimitWatts
Int!,non-nullrequired

Return type

SmartEnergySetHourlyLimitPayload
Mutation sample
mutation smartEnergySetHourlyLimit($homeId: ID!, $hourlyLimitWatts: Int!) {
  smartEnergySetHourlyLimit(homeId: $homeId, hourlyLimitWatts: $hourlyLimitWatts) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "hourlyLimitWatts": 40 }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

housingAssociationId
ID!,non-nullrequired
buildingId
ID!,non-nullrequired
homeId
ID!,non-nullrequired
isCommonArea
Boolean!,non-nullrequired

Return type

HousingAssociationBuildingAddFacilityTempPayload
Mutation sample
mutation housingAssociationBuildingAddFacilityTemp(
  $housingAssociationId: ID!
  $buildingId: ID!
  $homeId: ID!
  $isCommonArea: Boolean!
) {
  housingAssociationBuildingAddFacilityTemp(
    housingAssociationId: $housingAssociationId
    buildingId: $buildingId
    homeId: $homeId
    isCommonArea: $isCommonArea
  ) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "housingAssociationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "buildingId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "isCommonArea": true }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

buildingId
ID!,non-nullrequired
homeId
ID!,non-nullrequired

Return type

HousingAssociationBuildingRemoveFacilityTempPayload
Mutation sample
mutation housingAssociationBuildingRemoveFacilityTemp($buildingId: ID!, $homeId: ID!) {
  housingAssociationBuildingRemoveFacilityTemp(buildingId: $buildingId, homeId: $homeId) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "buildingId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

homeId
ID!,non-nullrequired
hubId
ID!,non-nullrequired
activateGeofenceInput
ActivateGeofenceInput!,non-nullrequired

Return type

GeofenceActivatePayload
isActive
Boolean!,non-null
message
String
Mutation sample
mutation activateGeofence(
  $homeId: ID!
  $hubId: ID!
  $activateGeofenceInput: ActivateGeofenceInput!
) {
  activateGeofence(
    homeId: $homeId
    hubId: $hubId
    activateGeofenceInput: $activateGeofenceInput
  ) {
    isActive 
    message 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "activateGeofenceInput": { "radius": 40, "referenceLat": 40, "referenceLong": 40, "type": "GEOFENCE" } }
Response sample
{ "data": { "isActive": true, "message": "Example String", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

homeId
ID!,non-nullrequired
deactivateGeofenceInput
DeactivateGeofenceInput!,non-nullrequired

Return type

GeofenceDeactivatePayload
geofenceActivationStatus
Boolean!,non-null
message
String
Mutation sample
mutation deactivateGeofence($homeId: ID!, $deactivateGeofenceInput: DeactivateGeofenceInput!) {
  deactivateGeofence(homeId: $homeId, deactivateGeofenceInput: $deactivateGeofenceInput) {
    geofenceActivationStatus 
    message 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deactivateGeofenceInput": { "type": "GEOFENCE" } }
Response sample
{ "data": { "geofenceActivationStatus": true, "message": "Example String", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Overview
Overview
Overview
Overview
Overview
Overview