Skip to content
Bottle

Add a work report job type

POST
/work-report/job-types
curl --request POST \
  --url https://example.com/work-report/job-types \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "name": "example", "rule": "install" }'

A business can have up to 50 job types in use.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 60 characters
rule
required

Install: a cylinder is delivered and none is collected. refill: a cylinder is delivered and one is collected. return: a cylinder is collected and none is delivered. service: the driver services equipment. manual: only chosen by hand.

string
Allowed values: install refill return service manual

Responses

Section titled “Responses”

201

Section titled “201”

Added

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
name
required
string
rule
required

Install: a cylinder is delivered and none is collected. refill: a cylinder is delivered and one is collected. return: a cylinder is collected and none is delivered. service: the driver services equipment. manual: only chosen by hand.

string
Allowed values: install refill return service manual
position
required
integer

Example 

{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "name": "Refill",
  "rule": "install"
}

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"
    }
  ]
}