Skip to content

Add an item type

POST
/service-item-types
curl --request POST \
--url https://example.com/service-item-types \
--header 'Content-Type: application/json' \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
--data '{ "name": "example", "fields": [] }'

A text detail with a pattern must match it in full, like a cylinder detail. A pattern that does not compile, or has a repeat or a choice inside a repeat, is refused.

Media typeapplication/json
object
name
required
string
>= 1 characters <= 80 characters
fields
Array<object>
default: <= 20 items
object
id

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f
name
required
string
>= 1 characters <= 60 characters
valueType
required
string
Allowed values: text date
required
boolean
unique
boolean
pattern
string | null
<= 200 characters
hint
string | null
<= 200 characters

Added

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
name
required
string
fields
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
valueType
required
string
Allowed values: text date
required
required
boolean
unique
required
boolean
pattern
required
string | null
hint
required
string | null
itemCount
required
integer

Example

{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"name": "Regulator",
"fields": [
{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"name": "Serial number",
"valueType": "text"
}
]
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

Not an owner or admin, missing scope, or the plan does not open Equipment servicing

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

Not found, or Equipment servicing is not available to this business

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

Equipment servicing is switched off, other equipment already has that detail, or the cylinder already has servicing set up

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

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