Home Energy Scoring‎ > ‎API Definitions‎ > ‎API Methods‎ > ‎2017.2‎ > ‎

delete_buildings_by_id

Tags one or more home assessments in the database as being deleted.  This results in the building's relationship to the assessor who created it being removed.  The building is no longer accessible to any user, though the record remains in the Home Energy Score database.  WARNING: This is NOT a reversible operation!

Parameters

Name Description Type Required Options
 session_token  Get from the get_session_token method string Yes  
user_key API key for access string Yes
 buildings  IDs of buildings to delete, separated by "|"  string Yes  


Response

Element Description
status 0: failure
1: success
error_message Error message returned if status=0


Roles

Method access is limited by the roles assigned the user to whom the session token was assigned

RoleAccess
AssessorThe logged-in user must own all requested buildings
PartnerNo access
 Admin No access