Equipment
On this page, we'll dive into the different equipment endpoints you can use to manage them programmatically.
The Equipment object
Equipment objects represent a single equipment in a commercial or personal risk profile. They contain the following properties and relationships:
Global Properties
These properties are available for all risk profile types.- Name
number
- Type
- int
- Filterable
- Sortable
- Description
The equipment number
- Name
make
- Type
- nullable string
- Filterable
- Sortable
- Description
The manufacturer of the equipment
- Name
model
- Type
- nullable string
- Filterable
- Sortable
- Description
The model of the equipment
- Name
year
- Type
- nullable string
- Filterable
- Sortable
- Description
The year the equipment was manufactured
- Name
serial_number
- Type
- nullable string
- Sortable
- Description
The corresponding serial number of the equipment
- Name
description
- Type
- nullable string
- Sortable
- Description
A description of the equipment
- Name
cost_new
- Type
- nullable float
- Filterable
- Sortable
- Description
The cost of the equipment at the time of purchase
- Name
actual_cash_value
- Type
- nullable float
- Filterable
- Sortable
- Description
The actual cash value of the equipment
- Name
notes
- Type
- nullable string
- Description
Any additional notes or comments about the equipment
- Name
image
- Type
- nullable string
- Description
The URL of the equipment's image, if uploaded via the Wunderite UI
Commercial-only Properties
These properties are available only for commercial risk profiles.- Name
premise
- Type
- nullable string
- Filterable
- Description
The UUID of the premise to which the equipment is associated
Personal-only Properties
These properties are available only for personal risk profiles.- Name
home
- Type
- nullable string
- Filterable
- Description
The UUID of the home to which the equipment is associated
Meta
- Name
created
- Type
- timestamp
- Filterable
- Sortable
- Description
An ISO-8601 timestamp (UTC) indicating when the equipment was created
- Name
updated
- Type
- timestamp
- Filterable
- Sortable
- Description
An ISO-8601 timestamp (UTC) indicating when the equipment was last updated
Global Relations
Learn more about including relations.- Name
attachments
- Type
- Attachment[]
- Name
attachments.uploader
- Type
- User
- Description
The user who uploaded the attachment
Commercial-only Relations
Learn more about including relations.- Name
premise
- Type
- Premise
- Filterable
- Name
premise.address
- Type
- Address
- Filterable
- Sortable
Personal-only Relations
Learn more about including relations.- Name
home
- Type
- Home
- Filterable
- Name
home.address
- Type
- Address
- Filterable
- Sortable
List all equipment
This endpoint allows you to retrieve a paginated list of all equipment in the corresponding commercial or personal risk profile.
Parameters
See the equipment object for a list of all available filters and sorts.
Searchable
You can search for equipment by providing a search query in the filter[search]
parameter.
The search query will be matched against its number, year, make, model, description, or serial number.
For commercial equipment, the search query will also be matched against its premise's address or description.
For personal equipment, the search query will also be matched against its location's address or description.
Request
curl -G https://app.wunderite.com/api/v1/risks/{risk}/data/equipment \
-H "Authorization: Bearer {token}" \
-d filter[search]=Location \
-d per_page=50
Response
{ "data": [ { "object": "equipment", "uuid": "056fc504-e377-4528-aa5a-ee0a6f0f3acf", "data": { "premise": "22ea0a8c-a712-4620-9428-9d6c4b04f346", "number": 1, "make": "Kubota", "model": "R430",
Create equipment
This endpoint allows you to create new equipment in the corresponding commercial or personal risk profile.
At least one equipment object must be provided in the request body.
Optional global properties
See all available properties in the equipment properties section.
- Name
number
- Type
- nullable int
- Description
The equipment's number. When this property is not provided, or uses a
null
value, the equipment will be assigned a number automatically.
Request
curl -X POST "https://app.wunderite.com/api/v1/risks/{risk}/data/equipment" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
{
"object": "equipment",
"data": {
"premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8",
"make": "Liebherr",
"model": "R 936",
"year": "2017",
"serial_number": "LIE343536",
"description": "Liebherr Crawler Excavator",
"cost_new": "180000.00",
"actual_cash_value": "140000.00",
"notes": null
}
}
]
}'
Response
{ "data": [ { "object": "equipment", "uuid": "d7abb5d1-fc15-4856-81af-8d518e7c153b", "data": { "premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8", "number": 43, "make": "Liebherr", "model": "R 936",
Update equipment
This endpoint allows you to perform bulk updates on equipment.
At least one equipment object must be provided in the request body. Each object must contain at least one property from the equipment properties section.
Properties that are not provided will not be updated.
To clear a property, provide a null
value.
Request
curl -X PATCH "https://app.wunderite.com/api/v1/risks/{risk}/data" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
{
"object": "equipment",
"uuid": "211f2848-a169-48bc-80b0-9083f16e36b0",
"data": {
"premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8",
"number": 25,
"make": "Liebherr",
"model": "R 936",
"year": "2017",
"serial_number": "LIE343536",
"description": "Liebherr Crawler Excavator",
"cost_new": 180000,
"actual_cash_value": 140000,
"notes": null,
"image": null
}
}
]
}'
Response
{ "data": [ { "object": "equipment", "uuid": "211f2848-a169-48bc-80b0-9083f16e36b0", "data": { "premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8", "number": 25, "make": "Liebherr", "model": "R 936",
Delete equipment
This endpoint allows you to bulk delete risk data, including equipment.
At least one equipment object must be provided in the request body to delete the corresponding equipment.
Required properties
- Name
object
- Type
- string
- Description
The object type of the data to delete. Must be
equipment
in this case
- Name
uuid
- Type
- string
- Description
The UUID of the equipment to delete
Request
curl -X DELETE "https://app.wunderite.com/api/v1/risks/{risk}/data" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
{
"object": "equipment",
"uuid": "211f2848-a169-48bc-80b0-9083f16e36b0"
}
]
}'
Response
{
"data": [
{
"object": "equipment",
"uuid": "211f2848-a169-48bc-80b0-9083f16e36b0",
"profile_type": "commercial"
}
]
}