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

Arguments

homeId
ID!,non-nullrequired
overrideName
String

Return type

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

Arguments

homeId
ID!,non-nullrequired

Return type

AlarmStationDisablePayload
Mutation sample
mutation alarmStationDisable($homeId: ID!) {
  alarmStationDisable(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

Return type

AlarmStationAddEmergencyContactPayload
Mutation sample
mutation alarmStationAddEmergencyContact($homeId: ID!, $data: AlarmStationAddEmergencyContactInput!) {
  alarmStationAddEmergencyContact(homeId: $homeId, data: $data) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "fixedPriority": 40 } }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

homeId
ID!,non-nullrequired
id
ID!,non-nullrequired

Return type

AlarmStationUpdateEmergencyContactPayload
Mutation sample
mutation alarmStationUpdateEmergencyContact(
  $homeId: ID!
  $id: ID!
  $data: AlarmStationUpdateEmergencyContactInput!
) {
  alarmStationUpdateEmergencyContact(
    homeId: $homeId
    id: $id
    data: $data
  ) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" } } }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

homeId
ID!,non-nullrequired
id
ID!,non-nullrequired

Return type

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

Arguments

housingAssociationId
ID!,non-nullrequired

Return type

HousingAssociationCollectiveAlarmCreateZonePayload
collectiveAlarmZone
Mutation sample
mutation housingAssociationCollectiveAlarmCreateZone($housingAssociationId: ID!) {
  housingAssociationCollectiveAlarmCreateZone(housingAssociationId: $housingAssociationId) {
    collectiveAlarmZone {
      id 
      facilities {
        id 
        units {
          id 
          unitNumber 
        }
        commonAreas {
          id 
          nickname 
        }
      }
      configurations {
        propagationDelaySeconds 
        meetingPointMap(
          # Arguments Here
        ) {
          url {
            original 
            small 
            medium 
            large 
          }
          uploadUrl 
        }
      }
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{ "housingAssociationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "collectiveAlarmZone": { "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" } } ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

zoneId
ID!,non-nullrequired

Return type

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

Arguments

zoneId
ID!,non-nullrequired

Return type

HousingAssociationCollectiveAlarmConfigureZonePayload
collectiveAlarmZone
Mutation sample
mutation housingAssociationCollectiveAlarmConfigureZone($zoneId: ID!, $data: CollectiveAlarmZoneConfigurationInput!) {
  housingAssociationCollectiveAlarmConfigureZone(zoneId: $zoneId, data: $data) {
    collectiveAlarmZone {
      id 
      facilities {
        id 
        units {
          id 
          unitNumber 
        }
        commonAreas {
          id 
          nickname 
        }
      }
      configurations {
        propagationDelaySeconds 
        meetingPointMap(
          # Arguments Here
        ) {
          url {
            original 
            small 
            medium 
            large 
          }
          uploadUrl 
        }
      }
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{ "zoneId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "fireAlarmZoneConfigurationInput": { "propagationDelaySeconds": 40 } } }
Response sample
{ "data": { "collectiveAlarmZone": { "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" } } ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

zoneId
ID!,non-nullrequired
data
ZoneAddFacilityInput!,non-nullrequired

Return type

HousingAssociationCollectiveAlarmZoneAddFacilityPayload
collectiveAlarmZone
Mutation sample
mutation housingAssociationCollectiveAlarmZoneAddFacility($zoneId: ID!, $data: ZoneAddFacilityInput!) {
  housingAssociationCollectiveAlarmZoneAddFacility(zoneId: $zoneId, data: $data) {
    collectiveAlarmZone {
      id 
      facilities {
        id 
        units {
          id 
          unitNumber 
        }
        commonAreas {
          id 
          nickname 
        }
      }
      configurations {
        propagationDelaySeconds 
        meetingPointMap(
          # Arguments Here
        ) {
          url {
            original 
            small 
            medium 
            large 
          }
          uploadUrl 
        }
      }
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{ "zoneId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "facilityType": "BUILDING", "facilityId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" } }
Response sample
{ "data": { "collectiveAlarmZone": { "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" } } ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

zoneId
ID!,non-nullrequired
facilityId
ID!,non-nullrequired

Return type

HousingAssociationCollectiveAlarmZoneRemoveFacilityPayload
collectiveAlarmZone
Mutation sample
mutation housingAssociationCollectiveAlarmZoneRemoveFacility($zoneId: ID!, $facilityId: ID!) {
  housingAssociationCollectiveAlarmZoneRemoveFacility(zoneId: $zoneId, facilityId: $facilityId) {
    collectiveAlarmZone {
      id 
      facilities {
        id 
        units {
          id 
          unitNumber 
        }
        commonAreas {
          id 
          nickname 
        }
      }
      configurations {
        propagationDelaySeconds 
        meetingPointMap(
          # Arguments Here
        ) {
          url {
            original 
            small 
            medium 
            large 
          }
          uploadUrl 
        }
      }
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{ "zoneId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "facilityId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "collectiveAlarmZone": { "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" } } ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

collectiveAlarmId
ID!,non-nullrequired

Return type

CollectiveAlarmCreatePayload
Mutation sample
mutation collectiveAlarmCreate($collectiveAlarmId: ID!) {
  collectiveAlarmCreate(collectiveAlarmId: $collectiveAlarmId) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "collectiveAlarmId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Misc
Overview
Overview
Other
Overview
Overview
Overview
Overview
Overview
Overview
Overview
Overview