batch_update

Allows groups of buildings to be updated. The fields that can be updated are strictly limited to values that do not have any effect on the model results, which means this method can be used on buildings regardless of whether they are locked.

Parameters

NameDescriptionTypeRequiredOptions
 session_token Get from the get_session_token methodstringYes 
user_keyAPI key for accessstringYes
 batch_update_inputs The container element for the inputs below (denote by *)  Yes 
 *    building_ids Comma-separated list of IDs of all buildings to be updated with new values stringYes 
 *    external_building_id If passed, all buildings in building_ids will be updated to have this external_building_id value string No 
 *    assessment_type
 If passed, all buildings in building_ids will be updated to have this assessment_type value
 string Noinitial, final, qa, alternative, test, corrected, mentor, preconstruction



Response

*The parameters listed are contained in a 'result' element
NameDescriptionType
 building_ids Comma-separated list of IDs of all buildings to be updated with new values string
 external_building_id If passed, all buildings in building_ids will be updated to have this external_building_id value string
 assessment_type
 If passed, all buildings in building_ids will be updated to have this assessment_type value
string
 error     Error message for specified building_ids (null if no errors) string




Roles

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

RoleAccess
AssessorNo access
PartnerNo access
 Admin Access allowed for any building