Project files

A build programme from a project's labour hours: tasks by trade, stage and level, working days, CSV and calendar

Stateless: the project comes as a state token, a My Project file, takeoffs or a drawing. Durations are the labour hours over the crew and working day given; no dates without a start date; hours and days only.

post/programme

Request

  • Base URL: https://api.craftquantities.com/v1
  • URL: https://api.craftquantities.com/v1/programme
  • Auth: none declared

Query parameters

detail'full' | 'summary'

full (the default): the whole answer. summary: the result lines, the citation line and the page only — fewer tokens to read.

summary: the result lines, the citation and the page only (fewer tokens); full, the default: the whole answer. A POST body may carry detail instead.

format'json' | 'md'

md: the engine's Markdown report as text/markdown (or send Accept: text/markdown); json, the default.

Request body

tokenstring

A project state token (cqp1.…) from a project-file answer or an update: the project whose lines are put in order.

fileobject

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.

system'metric' | 'imperial'

The unit system inputs left out open in, and the one the page link opens in. The answer comes in both.

market'US' | 'CA' | 'UK' | 'AU' | 'INTL'

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.

crewinteger

People in each trade's crew, unless named in crews.

crewsobject

People in a trade's crew, by trade id (carpentry, drywall, electrical, roofing …).

hoursPerDaynumber

Working hours in a crew's day.

startDatestring

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.

workDaysinteger[]

The days of the week worked, 1 Monday to 7 Sunday.

daysOffstring[]

Dates not worked (holidays, a shutdown), YYYY-MM-DD.

namestring

The project's name, for the files.

Response

The tasks, totals and files.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.