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

Name

session_token

user_key

batch_update_inputs

* building_ids

* external_building_id

* assessment_type

Description

Get from the get_session_token method

API key for access

The container element for the inputs below (denote by *)

Comma-separated list of IDs of all buildings to be updated with new values

If passed, all buildings in building_ids will be updated to have this external_building_id value

Type

string

string

string

string

string

Required

Yes

Yes

Yes

Yes

No

No

Options

initial, final, qa, alternative, test, corrected, mentor, preconstruction

If passed, all buildings in building_ids will be updated to have this assessment_type value

Response

*The parameters listed are contained in a 'result' element

Name

building_ids

external_building_id

assessment_type

error

Description

Comma-separated list of IDs of all buildings to be updated with new values

If passed, all buildings in building_ids will be updated to have this external_building_id value

Type

string

string

string

string

If passed, all buildings in building_ids will be updated to have this assessment_type value

Error message for specified building_ids (null if no errors)

Roles

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