Allows a batch of buildings to be created and results generated


 session_token Get from the get_session_token methodstringYes
user_keyAPI key for accessstringYes
 batch_id See the response of method csv_batch_import stringYes

The response contains one "result" element for each building submitted. These appear in the same order as the buildings in the submitted CSV file. Each csv_batch_import_result element contains the following fields:

 address The address of the building - intended to simplify identifying which status entry corresponds to which building in the batch (though the order of buildings returned can also be used since it's the same as the order of buildings in the submitted batch file). string
 building_id If the status of the building is "success", this field will contain the ID of the building record that was created.int
 status The status of the building. One of "success", "waiting", "processing" or "error".

success: The building has successfully been processed
waiting: The building is in queue and will be processed
processing: The building has begun processing
error: The building was unable to be processed due to an error
 error_message If the status of the building is "error", this field contains a message explaining the error. string

An additional element may be set in addition to the "result" elements:

 result_url URL from which the results file for this batch can be downloadedstring

If the batch is completed but this element is still empty, it is because the results file is still being generated - just call this API method again after a short wait and it should appear.


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

AssessorNo access
PartnerNo access
 Admin Access allowed