Back to all

Why is using Floorplan APIs inefficent

To get a sheet from a floorplan you must use https://developers.fieldwire.com/reference/get_floorplans_in_project

The query parameter with_current_sheet needs to be set true

This will return all active sheets for ALL layouts in a project.

Working from tasks - you can return the associated Floorplan ID.

If you use this ID within the API call https://developers.fieldwire.com/reference/get_floorplan_by_id

this does not return a current sheet within the response, nor does it return a sheet ID to be able to use the sheet API https://developers.fieldwire.com/reference/get_sheet_by_id

The only way to do this is to use the less efficient get_floorplans_in_project and iterate through all until you find a matching floorplan ID.

You could also filter this request by floorplan name but to get the floorplan name you need to have fetched a floorplan object by id - equating to multiple requests or iterating through an array. Also an array request would not be idempotent where as a request by ID would so caching would also be worse.

Also your APIs need consistency especially for the same object type.