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

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" } ] } }

Arguments

homeId
ID!,non-nullrequired
setMOBCountdownInput
SetMOBCountdownInput!,non-nullrequired

Return type

GeofenceSetMOBCountdownPayload
success
Boolean!,non-null
Mutation sample
mutation setMOBCountdown($homeId: ID!, $setMOBCountdownInput: SetMOBCountdownInput!) {
  setMOBCountdown(homeId: $homeId, setMOBCountdownInput: $setMOBCountdownInput) {
    success 
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "setMOBCountdownInput": { "countdown": 40 } }
Response sample
{ "data": { "success": true } }

Arguments

homeId
ID!,non-nullrequired

Return type

GeofenceSendMOBEmergencyMessagePayload
success
Boolean!,non-null
Mutation sample
mutation sendMOBEmergencyMessage($homeId: ID!) {
  sendMOBEmergencyMessage(homeId: $homeId) {
    success 
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "success": true } }

Arguments

homeId
ID!,non-nullrequired

Return type

GeofenceCancelMOBEmergencyPayload
success
Boolean!,non-null
Mutation sample
mutation cancelMOBEmergency($homeId: ID!) {
  cancelMOBEmergency(homeId: $homeId) {
    success 
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "success": true } }
Overview
Overview
Overview
Overview
Overview
Overview