calculate_base_building_poll, calculate_package_building_poll

These methods check and return the status of a building calculation submitted using the calculate_base_building or calculate_package_building methods.

Parameters

NameDescriptionTypeLengthRequiredOptions
user_keyAPI key for accessstring32Yes
building_idID of building to check status ofint
Yes

Response

ElementDescription
resultCurrent status of building
messageDescription of status

Notes
  • The result can be one of the following:
    • pending - the building calculation is still in process
    • ok - the building calculation has successfully completed
    • error - there was an error during the calculation
    • none - the building exists but there is no status
  • Possible messages include:
    • Running Base Calcs
    • Running Package Calcs
    • Building #### results calculated successfully. (Base)
    • Building #### package results calculated successfully. (Package)
    • Label #### for building #### successfully generated
    • Does not exist
  • For possible error messages see the calculate_base_building method

Errors

Error TextMeaning
 API key is not authorized You need to submit a valid API key
 No building found for building_id ##### You need to submit a valid building_id