Input schema (JSON)
{
"type": "object",
"required": [],
"properties": {
"crew": {
"type": "integer",
"default": 2,
"maximum": 50,
"minimum": 1,
"description": "People in each trade's crew, unless named in crews."
},
"file": {
"type": "object",
"description": "A My Project file (the backup a project-file answer returns, or one the reader exported): its active project's lines and any hours typed on them."
},
"name": {
"type": "string",
"maxLength": 120,
"description": "The project's name, for the files."
},
"crews": {
"type": "object",
"description": "People in a trade's crew, by trade id (carpentry, drywall, electrical, roofing …).",
"additionalProperties": {
"type": "integer",
"maximum": 50,
"minimum": 1
}
},
"token": {
"type": "string",
"maxLength": 16384,
"minLength": 8,
"description": "A project state token (cqp1.…) from a project-file answer or an update: the project whose lines are put in order."
},
"detail": {
"enum": [
"full",
"summary"
],
"type": "string",
"default": "full",
"description": "full (the default): the whole answer. summary: the result lines, the citation line and the page only — fewer tokens to read."
},
"market": {
"enum": [
"US",
"CA",
"UK",
"AU",
"INTL"
],
"type": "string",
"description": "Optional. A market whose own opening choice some inputs take (a UK reader's code, an IEC motor), and whose currency symbol prints the caller's own money figures."
},
"system": {
"enum": [
"metric",
"imperial"
],
"type": "string",
"default": "metric",
"description": "The unit system inputs left out open in, and the one the page link opens in. The answer comes in both."
},
"daysOff": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"maxItems": 400,
"description": "Dates not worked (holidays, a shutdown), YYYY-MM-DD."
},
"drawing": {
"type": "object",
"properties": {
"house": {
"type": "object",
"properties": {
"pitch": {
"enum": [
"4",
"6",
"8",
"10",
"12"
],
"type": "string",
"description": "Roof pitch, rise in 12."
},
"family": {
"enum": [
"wall.framed-exterior",
"wall.masonry",
"wall.sip"
],
"type": "string"
},
"values": {
"type": "object",
"description": "The form's figures, each length with its unit: length, width, storeyHeight, eaveOverhang, rakeOverhang, slabThickness, footingWidth, footingDepth, trenchDepth, windowWidth, windowHeight, doorWidth, doorHeight (\"12 m\", \"40 ft\"); and the counts partitions, windows, outsideDoors, interiorDoors, iceDamEaves. Any left out opens where the page opens it.",
"maxProperties": 30,
"additionalProperties": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
}
},
"example": {
"type": "string",
"maxLength": 120,
"description": "Start from one of the site's example houses (its slug) in place of the estimator's opening house."
},
"storeys": {
"enum": [
1,
2
],
"type": "integer"
},
"selection": {
"type": "object",
"description": "The exterior wall's build-up choices.",
"maxProperties": 20,
"additionalProperties": {
"type": "string",
"maxLength": 80
}
},
"roofFamily": {
"enum": [
"roof.asphalt-shingle",
"roof.tile-slate"
],
"type": "string"
},
"roofSelection": {
"type": "object",
"maxProperties": 20,
"additionalProperties": {
"type": "string",
"maxLength": 80
}
}
},
"description": "The House Estimator's form: the house drawn as the estimator draws it.",
"additionalProperties": false
},
"layout": {
"type": "object",
"required": [
"rooms"
],
"properties": {
"grid": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "The grid every figure is snapped to (default 10 mm, or 1/2 in in US units). Each snap that changed a figure is reported."
},
"doors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"room": {
"type": "string",
"maxLength": 60,
"description": "The room it is in, by name."
},
"side": {
"enum": [
"south",
"east",
"north",
"west"
],
"description": "The side of that room."
},
"width": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "The opening's width; left out, the canvas's default."
},
"offset": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "Its centre along the side from the side's start (walls counter-clockwise from the south-west corner); left out, the middle."
},
"between": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60
},
"maxItems": 2,
"minItems": 2,
"description": "A door only: the two rooms it joins, on the wall they share."
}
},
"additionalProperties": false
},
"maxItems": 60,
"description": "Each between two rooms, or in a room's side (an outside door where that side is an exterior wall)."
},
"rooms": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"width",
"depth"
],
"properties": {
"at": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
},
"y": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
}
},
"description": "Its south-west corner. The first room without at or against is at the origin.",
"additionalProperties": false
},
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Unique in the layout; openings and later rooms refer to it."
},
"depth": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "Along y (north), wall centre to wall centre."
},
"width": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "Along x (east), wall centre to wall centre."
},
"against": {
"type": "object",
"required": [
"room",
"side"
],
"properties": {
"room": {
"type": "string",
"maxLength": 60
},
"side": {
"enum": [
"south",
"east",
"north",
"west"
]
},
"align": {
"enum": [
"start",
"centre",
"end"
],
"description": "Along that side: flush with its west or south end (start, the default), centred, or flush with the other end."
},
"offset": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
}
},
"description": "Beside a side of an earlier room, sharing that wall.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 30,
"minItems": 1
},
"windows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"room": {
"type": "string",
"maxLength": 60,
"description": "The room it is in, by name."
},
"side": {
"enum": [
"south",
"east",
"north",
"west"
],
"description": "The side of that room."
},
"width": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "The opening's width; left out, the canvas's default."
},
"offset": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "Its centre along the side from the side's start (walls counter-clockwise from the south-west corner); left out, the middle."
},
"between": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60
},
"maxItems": 2,
"minItems": 2,
"description": "A door only: the two rooms it joins, on the wall they share."
}
},
"additionalProperties": false
},
"maxItems": 60,
"description": "Each in a room's side, on an exterior wall."
}
},
"description": "Rooms by name, size and which room each stands against, laid out on a grid: shared walls drawn once as partitions, every snap or move reported, and each room checked to close.",
"additionalProperties": false
},
"shapes": {
"type": "array",
"items": {
"type": "object",
"required": [
"shape"
],
"properties": {
"p": {
"type": "object",
"description": "The component's own properties: a fence's heightMm, a bed's mulchDepthMm, each length with its unit.",
"maxProperties": 20
},
"at": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
},
"y": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
}
},
"description": "The south-west corner (a path's or a fence's start). Left out: the origin.",
"additionalProperties": false
},
"ref": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,40}$",
"description": "A name a later shape's against uses."
},
"legs": {
"type": "array",
"items": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
},
"maxItems": 20,
"minItems": 1,
"description": "A fence's straight runs, in order."
},
"name": {
"type": "string",
"maxLength": 60,
"description": "A room's name."
},
"build": {
"enum": [
"pavers",
"concrete"
],
"description": "A patio's or path's build: a patio is concrete unless pavers; a path is pavers unless concrete."
},
"depth": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "Along y (north); for a deck or patio against a side, out from it."
},
"doors": {
"type": "array",
"items": {
"type": "object",
"required": [
"side",
"offset"
],
"properties": {
"side": {
"enum": [
"south",
"east",
"north",
"west"
]
},
"offset": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "Along the wall from its start: walls run counter-clockwise from the south-west corner."
},
"exterior": {
"type": "boolean",
"description": "A door: an outside door (the default) or an inside one."
}
},
"additionalProperties": false
},
"maxItems": 20
},
"gates": {
"type": "array",
"items": {
"type": "object",
"required": [
"leg",
"offset",
"width"
],
"properties": {
"leg": {
"type": "integer",
"minimum": 1
},
"width": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
},
"offset": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"maxItems": 20,
"description": "Gate openings, by leg (from 1) and offset along it; taken out of the run, the gate itself not counted."
},
"scope": {
"type": "object",
"maxProperties": 30,
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
},
"shape": {
"enum": [
"room",
"deck",
"patio",
"bed",
"path",
"fence"
],
"description": "room: four exterior walls with doors and windows; deck, patio, bed (planted): a rectangle; path: a paved strip; fence: legs and 90° turns. Anything else is refused."
},
"turns": {
"type": "array",
"items": {
"enum": [
"left",
"right"
]
},
"maxItems": 19,
"description": "A 90° turn between each two legs."
},
"width": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "Along x (east): a room's, deck's, patio's or bed's; a path's width across it."
},
"length": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "A path's length."
},
"against": {
"type": "object",
"required": [
"shape",
"side"
],
"properties": {
"side": {
"enum": [
"south",
"east",
"north",
"west"
]
},
"shape": {
"type": "string"
},
"offset": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
}
},
"description": "A deck, patio or bed against a side of an earlier room or rectangle: centred on it, or from its west or south end by offset.",
"additionalProperties": false
},
"heading": {
"enum": [
"south",
"east",
"north",
"west"
],
"description": "The way a path or a fence's first leg runs (default east)."
},
"windows": {
"type": "array",
"items": {
"type": "object",
"required": [
"side",
"offset"
],
"properties": {
"side": {
"enum": [
"south",
"east",
"north",
"west"
]
},
"offset": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "Along the wall from its start: walls run counter-clockwise from the south-west corner."
},
"exterior": {
"type": "boolean",
"description": "A door: an outside door (the default) or an inside one."
}
},
"additionalProperties": false
},
"maxItems": 20
},
"finishes": {
"type": "object",
"maxProperties": 10,
"additionalProperties": {
"type": "string",
"maxLength": 80
}
}
},
"additionalProperties": false
},
"maxItems": 40,
"minItems": 1,
"description": "Simple shapes the assistant has read from the reader's words — a room, a deck, a patio, a bed, a path, a fence of legs and turns — compiled into the canvas's own commands. Every length with its unit."
},
"variant": {
"type": "string",
"pattern": "^[a-z0-9-]{1,40}$",
"description": "With template: one of its two \"what changes if\" variants, by id; a wrong one is refused with the template's own list."
},
"commands": {
"type": "array",
"items": {
"type": "object",
"required": [
"op"
],
"properties": {
"c": {
"type": "string",
"maxLength": 40,
"description": "outline: slab, roof, floor, driveway, patio, deck, landscaping; path: footing, cable, pipe, duct, fence, retaining-wall; point: column, pier, outlet, switch, light, panel, fixture, drain, radiator, register."
},
"p": {
"type": "object",
"description": "The component's own properties by id (components/properties.ts): a length with its unit (widthMm, heightMm, sillMm …), a choice's option id, a count, true or false.",
"maxProperties": 20
},
"at": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
},
"y": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
}
},
"description": "A point on plan, each coordinate a length with its unit.",
"additionalProperties": false
},
"op": {
"enum": [
"level",
"type",
"wall",
"opening",
"room",
"outline",
"path",
"point",
"beam",
"stair"
]
},
"to": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
},
"y": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
}
},
"description": "A point on plan, each coordinate a length with its unit.",
"additionalProperties": false
},
"ref": {
"type": "string",
"maxLength": 60,
"description": "A name by which later commands refer to what this one makes."
},
"from": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
},
"y": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
}
},
"description": "A point on plan, each coordinate a length with its unit.",
"additionalProperties": false
},
"kind": {
"enum": [
"door",
"window"
]
},
"name": {
"type": "string",
"maxLength": 60,
"description": "A level's, a type's or a room's name."
},
"type": {
"type": "string",
"maxLength": 60,
"description": "A ref given to an earlier command, or the name of a level or type (the blank drawing has the level \"ground\" and the types EW-1, IW-1, WN-1, DR-1)."
},
"wall": {
"type": "string",
"maxLength": 60,
"description": "The wall an opening goes in: its ref."
},
"level": {
"type": "string",
"maxLength": 60,
"description": "A ref given to an earlier command, or the name of a level or type (the blank drawing has the level \"ground\" and the types EW-1, IW-1, WN-1, DR-1)."
},
"scope": {
"type": "object",
"description": "Its scope question name → answer, by the planner's ids.",
"maxProperties": 30,
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
},
"closed": {
"type": "boolean"
},
"height": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
},
"offset": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
],
"description": "An opening's centre, measured along its wall from the wall's start."
},
"points": {
"type": "array",
"items": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
},
"y": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
}
},
"description": "A point on plan, each coordinate a length with its unit.",
"additionalProperties": false
},
"maxItems": 500,
"minItems": 2
},
"assembly": {
"type": "string",
"maxLength": 80,
"description": "A type's build-up: a canvas assembly id (wall.framed-exterior, roof.asphalt-shingle, slab.on-grade …)."
},
"finishes": {
"type": "object",
"description": "A room's, or a driveway's, patio's, deck's, fence's or retaining wall's surface role → finish id, by the planner's ids.",
"maxProperties": 10,
"additionalProperties": {
"type": "string",
"maxLength": 80
}
},
"elevation": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
},
"selection": {
"type": "object",
"maxProperties": 20,
"additionalProperties": {
"type": "string",
"maxLength": 80
}
},
"thickness": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
},
"wastePercent": {
"type": "number",
"maximum": 100,
"minimum": 0
}
}
},
"maxItems": 500,
"minItems": 1,
"description": "Drawing commands, in order, on the canvas's blank drawing (one storey; the wall, partition, window and door types). The whole request is at most 64 KiB."
},
"document": {
"type": "object",
"description": "A Construction Canvas document (schema 1 to the canvas's current), opened and checked by the canvas's own opener."
},
"template": {
"type": "string",
"pattern": "^[a-z0-9-]{1,60}$",
"description": "A Construction Canvas template's slug (the template index lists them: single-room, deck, two-car-garage …): the drawing its page shows, in the reader's system, with a link that opens it."
},
"inputUnits": {
"enum": [
"base"
],
"type": "string",
"description": "Send \"base\" to pass bare numbers on dimensioned inputs in base units (m, m², L, kg …), as the published test vectors are written. Without it a length, area or volume must carry its unit."
}
},
"description": "A Construction Canvas drawing (a template, a house form, shapes, drawing commands or a canvas document), as a project file takes it; its levels set the level-by-level order.",
"additionalProperties": false
},
"takeoffs": {
"type": "array",
"items": {
"type": "object",
"required": [
"takeoff"
],
"properties": {
"takeoff": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{1,119}$"
},
"leaveOut": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120
},
"maxItems": 100,
"description": "Rows the reader leaves out of the job: still worked and shown, not put in the project or counted in labour."
},
"selection": {
"type": "object",
"description": "Build-up choice id → option id, the takeoff's own (a stud size, an insulation, a cladding). Choices left out take the page's own for the system.",
"maxProperties": 20,
"additionalProperties": {
"type": "string",
"maxLength": 80
}
},
"allowances": {
"type": "object",
"description": "Row → an allowance the reader sets: a percentage (cutting waste, overlap), or the option an allowance follows (a lay pattern). Row names are the takeoff's steps (the calculator slug, or the step key where one runs twice).",
"maxProperties": 50,
"additionalProperties": {
"anyOf": [
{
"type": "number",
"maximum": 100,
"minimum": 0
},
{
"type": "string",
"maxLength": 80
}
]
}
},
"inputUnits": {
"enum": [
"base"
],
"type": "string",
"description": "Send \"base\" to pass bare numbers on dimensioned inputs in base units (m, m², L, kg …), as the published test vectors are written. Without it a length, area or volume must carry its unit."
},
"measurements": {
"type": "object",
"description": "Measurement id → value, each length, area or volume with its unit (\"12 ft\", {\"value\": 3.6, \"unit\": \"m\"}); counts as numbers. Ids are those of the takeoff; any left out opens at the page's own figure.",
"maxProperties": 50,
"additionalProperties": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 200
},
{
"type": "object",
"required": [
"value"
],
"properties": {
"unit": {
"type": "string",
"maxLength": 40
},
"value": {
"type": "number"
}
},
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
},
"maxItems": 10,
"minItems": 1,
"description": "Whole-job takeoffs, each an id and its measurements, as a project file takes them."
},
"workDays": {
"type": "array",
"items": {
"type": "integer",
"maximum": 7,
"minimum": 1
},
"default": [
1,
2,
3,
4,
5
],
"maxItems": 7,
"minItems": 1,
"description": "The days of the week worked, 1 Monday to 7 Sunday.",
"uniqueItems": true
},
"startDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Optional first day (YYYY-MM-DD): the working days are then given dates and a calendar file is returned. No date is assumed without it."
},
"hoursPerDay": {
"type": "number",
"default": 8,
"maximum": 24,
"minimum": 1,
"description": "Working hours in a crew's day."
}
},
"additionalProperties": false
}