Skip to content
Bottle

Change work report settings

PUT
/work-report/settings
curl --request PUT \
  --url https://example.com/work-report/settings \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "enabled": true, "emailTo": "main_contact", "sendAfter": "tracked", "nextNumber": 1, "acknowledgement": [ "example" ], "mustRecord": { "cylinderDetails": true, "allChecks": true, "customerSignature": true, "driverSignature": true, "purchaseOrder": true } }'

Fields left out keep their value. Blank acknowledgement lines are dropped. The next report number must be higher than the highest report already issued; a lower one is refused with 422.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
enabled
boolean
emailTo

Main_contact: the customer’s main contact. everyone: every contact on the account. ask_driver: the driver picks at the stop.

string
Allowed values: main_contact everyone ask_driver
sendAfter

Tracked: stops where a tracked cylinder is delivered or collected. every: every stop.

string
Allowed values: tracked every
nextNumber
integer
>= 1 <= 99999999
acknowledgement
Array<string>
<= 10 items
mustRecord
object
cylinderDetails
boolean
allChecks
boolean
customerSignature
boolean
driverSignature
boolean
purchaseOrder
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Saved

Media typeapplication/json
object
enabled
required
boolean
emailTo
required

Main_contact: the customer’s main contact. everyone: every contact on the account. ask_driver: the driver picks at the stop.

string
Allowed values: main_contact everyone ask_driver
sendAfter
required

Tracked: stops where a tracked cylinder is delivered or collected. every: every stop.

string
Allowed values: tracked every
nextNumber
required
integer
>= 1
acknowledgement
required
Array<string>
mustRecord
required
object
cylinderDetails
required
boolean
allChecks
required
boolean
customerSignature
required
boolean
driverSignature
required
boolean
purchaseOrder
required
boolean

Example 

{
  "emailTo": "main_contact",
  "sendAfter": "tracked"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not an owner or admin, or the plan does not open Assets

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found, or Assets is not available to this business

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

Assets is switched off, or the business already has 50 job types or checks

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}