Fixture and Finish

Show the account's 11x17 drawing sheet, blank, as an image: the title block with the builder's logo and details, and with a project_id that project's name and address, plus the drawing area each page's image fills. Returns the drawing area's size in inches, its aspect ratio, and the pixel size that prints at about 200 dpi, so images can be exported to fill it before render_drawing_set.

get_drawing_sheet_template

Return the inspiration images uploaded to a Fixture & Finish project, as images, each captioned with its name, room, and source link. Covers the whole project, or one room when room_name is given, leaving out archived images. At most 8 come back per call, ordered by room; offset pages through the rest. Takes a project_id from list_projects.

get_inspiration_images

Full detail on one item in a Fixture & Finish project, covering both what the item should look like and where its order stands. Returns the item and its current selections, the room it is in with up to 6 of that room's inspiration images, the project's style and existing-selections palette, the account's preferred and avoided vendors, the approved selection's locked price, and any order lines with expected delivery dates. item_id comes from find_items or from the item_id parameter of a Fixture & Finish URL. On a second item in the same project, omit can leave out the existing-selections palette and the inspiration images already seen.

get_item_context

Render one page of a plan sheet or detailed drawing from a Fixture & Finish project as an image of the document itself, sized to fit 1568 pixels on its long edge. Plan sheets also return the text read off the sheet, which keeps small dimension strings legible when the image is too coarse to read them. Takes a plan_id or drawing_id from list_plans.

get_plan

Procurement status across the user's Fixture & Finish projects, in four sections: approved items with no order yet, open order lines with expected dates and late flags, lines received off-site awaiting the trip to the job, and lines marked delivered to the job site in the last 7 days. Together these answer what still needs ordering, what is late, what has arrived but is not yet on site, and what was delivered this week. This is the cross-project roll-up; per-item order detail lives in get_item_context. project_id from list_projects narrows to one project. Each section returns at most 100 rows.

get_procurement_summary

Return a room's snapshots: the crop of each of its space's floor, electrical, and framing plans that shows where the room is, which is what the app displays for that room. Each snapshot comes back as two images, the crop itself and the whole sheet with the crop outlined in red, plus the crop's box as fractions of the sheet. A plan type with no plan linked, or no crop yet, says which. Takes a project_id from list_projects and a room name.

get_room_snapshots

Read one selection from the account's library: its name, model number, reference link, description, category, category-specific attributes, price, every image (the first 4 shown, each with a download url), and the items it is an option on. Given a selection_import_id from import_selection_candidate instead, it reports the import's status and, once the scrape is done, the selection it produced, which is how to check what an import captured. Pass exactly one. Image urls are stable links that need no sign-in, like the app's own, so a script can fetch them; anyone holding one can download that image.

get_selection

Import a product from its page URL into the account's selection library and attach it to an item as an option. If the library already holds that product the existing selection is attached immediately; otherwise Fixture & Finish fetches the page in the background and the resulting selection lands on the item's ready-to-approve list. Either way it takes effect only once the user approves it in Fixture & Finish. Returns a review_url. The URL must be https, and it should be the variant-specific product page, because a finish, size, handle style, or spout height each imports as its own selection. wait_seconds (up to 20) holds the answer until a fresh scrape finishes, so a quick one comes back with its selection_id; a slower one returns queued, and get_selection with the selection_import_id picks it up later. Each waiting call holds a server connection for the whole wait, so leave it at 0 when firing several imports at once.

import_selection_candidate

List a Fixture & Finish project's architectural plan sheets and its detailed drawings, without their images. Each plan sheet carries its plan_id, sheet number, title, category, and the spaces it is linked to as a floor, electrical, or framing plan. Each detailed drawing carries its drawing_id, name, description, and the room it belongs to; archived drawings, the options a design review passed over, are left out. room_name narrows to one room's drawings and the sheets linked to its space, and include returns only plans or only drawings. Takes a project_id from list_projects.

list_plans

List the Fixture & Finish projects (homes/jobs) this user can access. Returns each project's id, name, status, and address. The id is the project_id the other Fixture & Finish tools take, so a project named "Leesburg" resolves here.

list_projects

List a Fixture & Finish project's rooms, each with its room_id, its space, how many items, detailed drawings and inspiration images it has, its item groups, and a link to it in the app. A final Whole home entry carries the items and groups filed on the project itself. The other tools take a room by the name given here, space-qualified when two rooms share a name, and an item's group by one of these group names. Takes a project_id from list_projects.

list_rooms

The selection categories items are filed under, as "Main > Sub" paths, with how many items sit in each. This is where the category argument to find_items comes from, so a whole category can be asked for by name instead of guessed at one leaf at a time. A count on a parent covers its whole branch, which is what find_items returns when given that parent. project_id from list_projects counts only that project and leaves out categories it does not use; without one, the full taxonomy comes back.

list_categories

Turn a set of images, such as a SketchUp model's elevations, framing and rendering, into one branded 11x17 PDF with a page per image, and file it as a detailed drawing. Each page carries the account's title block with the project, today's date, the revision, shared notes, and that page's own title and sheet number ("1 of 3" by default). Images come from create_upload, one upload per page, in page order. Without drawing_id it files a new drawing in the room; with one it replaces that drawing's set as its next version, keeping its id, comments and history. A revision always re-sends every page. Images are compressed to fit the drawing size limit, and a set too large even then is refused before filing, so very large photo sets are better split. The whole set renders in one call, so it takes longer the more pages it has. get_drawing_sheet_template shows the layout and the drawing area's size.

render_drawing_set

Replace a detailed drawing's PDF with a revised one, keeping the same drawing: its id, name, comments and design-review references stay, the old file moves to the drawing's version history, and the version number goes up by one. This is how a drawing is superseded, rather than uploading a second drawing and deleting the first. The PDF comes from create_upload. Takes a drawing_id from list_plans and an optional note on what changed.

replace_drawing

Search the account's selection library, meaning products already captured in Fixture & Finish, by name, model number, or description. A query like "Kohler Purist" returns each match's selection_id, name, model number, category, vendor, and reference link, and that selection_id is what add_selection_to_item takes. This covers the product library rather than the items inside a project, which find_items covers. Rows come back closest match first, so the first row is the best answer to the query and a phrase like "vanity faucet" still finds the bathroom faucets, since no product is named for the room it lands in. Returns at most 25 rows.

search_selections

Move or resize a room's snapshot: the crop of its space's floor, electrical, or framing plan that the app shows for that room. The box is given as fractions of the plan sheet, the same as get_room_snapshots and get_plan_region use. Setting the floor crop also carries it onto the electrical and framing plans through their calibration lines, as the app's crop editor does, replacing those crops even when the room sizes them separately. Setting an electrical or framing crop on its own marks the room as sizing those separately, which the app requires to edit them. The change is live and is recorded in the activity feed. Returns the new crop as an image, the whole sheet with it outlined, and every box it replaced. Sending a previous box back restores that crop; for a floor crop the other plans are carried over again rather than restored, and separate sizing stays on.

set_room_snapshot

Rename a detailed drawing in a Fixture & Finish project or change its description. Only the fields given change. Returns the drawing as it now stands and its previous values. Takes a drawing_id from list_plans.

update_detailed_drawing

Change an inspiration image's name, description or source URL in a Fixture & Finish project. Only the fields given change. Returns the image as it now stands and its previous values. Takes an inspiration_image_id from get_inspiration_images or upload_inspiration_image.

update_inspiration_image

Change an item in a Fixture & Finish project: rename it, move it to another room, recategorize it, or change its quantity or notes. Only the fields given change. An item that already has selections keeps its category, because recategorizing clears its selections and approval; that change is left to the app. group files the item under one of its room's groups by name (list_rooms lists them), and an empty string ungroups it. Returns the item as find_items describes it, with its previous values. Takes an item_id from find_items.

update_item

Correct a selection in the account's library: its name, model number, reference link or description. Only the fields given change. The library is shared across the account's projects, so the change shows wherever the selection is used; get_selection lists those items. Returns the selection as it now stands and its previous values, and records who changed what for the account's history. Takes a selection_id from search_selections or get_selection.

update_selection

File a PDF as a named detailed drawing in a room of a Fixture & Finish project. The PDF comes from create_upload: create the upload, PUT the file to its upload_url, then call this with its upload_id. Returns the new drawing_id, which get_plan and list_plans take, and a link to it in the app. Takes a project_id from list_projects and a room name from list_rooms.

upload_detailed_drawing

Add an image to a room's inspiration board in a Fixture & Finish project. The image comes from either an upload_id (create_upload, then PUT the file to its upload_url) or an image_url Fixture & Finish fetches itself; pass exactly one. Returns the new inspiration_image_id and a link to it in the app. Takes a project_id from list_projects and a room name from list_rooms.

upload_inspiration_image

Render part of one page of a plan sheet or detailed drawing at full resolution, like zooming into the PDF. The region is given as fractions of the page, so 0.5 is halfway across whatever size the page was seen at. A region wider or taller than 1568 pixels at full resolution comes back shrunk to fit, and the response says so. Takes a plan_id or drawing_id from list_plans.

get_plan_region