Building sync
BuildingSync

Services relating to BuildingSync.

Supported Formats

json
>>>

GET /api/v2/building_sync/download/rp/buildings/:id
Export the building with the given ID. Response for a successful request is a BuildingSync XML document.

GET /api/v2/building_sync/download/rp/nyc/properties/:id
Export the NYC property with the given ID. Response for a successful request is a BuildingSync XML document.

Supported Formats

json

Errors

Code Description
401 Unauthorized
422 Unprocessable Entity
401 Unauthorized
422 Unprocessable Entity

Params

Param name Description
token
required

The token for user authentication.

Validations:

  • Must be a String
>>>

POST /api/v2/building_sync/upload
Import Buildings. Response for a successful request is an object with the assigned unique IDs for the new buildings.

Supported Formats

json

Errors

Code Description
401 Unauthorized
422 Unprocessable Entity

Params

Param name Description
token
required

The token for user authentication.

Validations:

  • Must be a String
audit_file
required

The BuildingSync XML document. Validated against the BuildingSync XML schema document.

Validations:

  • Must be a File