archive_buildings_by_id

Tags one or more home assessments in the database as being archived. The main point of this is that the "archived" attribute is one of the attributes a home can be filtered on in the retrieve_buildings_by_id and retrieve_buildings_by_partner methods, the intent being that a GUI can allow a user to hide buildings that are no longer of interest.

Parameters

Response

Element

status

error_message

Description

false: failure

true: success

Error message returned if status=false

Roles

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