Objects

In this guide, we will learn more about objects and how they are used in the Wunderite API.

Objects are Wunderite's way of organizing data for input and output. They are used to represent different types of data in the system, while also providing a consistent way to interact with them.

Objects are made up of the following properties:

Name
object
Type
string
Description
The type of object being interacted with. This property is available in all requests.
Name
uuid
Type
string
Description
The unique identifier for the object.
Name
data
Type
object
Description
The data object containing the properties for the object.
Name
meta
Type
object
Description
The meta object containing additional information about the object that cannot be modified, such as timestamps.
Name
relations
Type
object
Description
An associative array of related objects that were requested to be included in the response.

Example building object

{
  "object": "building",
  "uuid": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b",
  "data": {
    "number": 1,
    "premise": "1f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b"
  },
  "meta": {
    "created": "2021-01-01T00:00:00Z",
    "updated": "2021-01-01T00:00:00Z",
    "has_property_data": true
  },
  "relations": {
    "premise": "1f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b",
    "subjects_of_insurance": [
      "2f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b",
      "3f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b"
    ]
  }
}

List requests

GET list requests are used to retrieve a list of objects. The response will contain an array of objects that match the criteria specified in the request.

Depending on the includes provided to the request, the response may also contain hydrated related objects.

Objects in a list request have all 5 standard properties: object, uuid, data, meta, and relations.

Example

Example building object

  {
    "object": "building",
    "uuid": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b",
    "data": {
      "number": 1,
      "premise": "1f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b"
    },
    "meta": {
      "created": "2021-01-01T00:00:00Z",
      "updated": "2021-01-01T00:00:00Z",
      "has_property_data": true
    },
    "relations": {
      "premise": "1f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b",
      "subjects_of_insurance": [
        "2f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b",
        "3f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b"
      ]
    }
  }

Create requests

POST create requests are used to create one or more objects. The request body should contain an array of objects to be created, all of which must have a valid object and data property.

The response to a POST create request will contain an array of the created objects, fully hydrated with their uuid, data, meta, and relations properties. The data property will also be fully hydrated, including any fields that may have not been included in the request.

Example

Example request

POST

/api/v1/risks/{risk}/data/buildings

curl -X POST https://app.wunderite.com/api/v1/risks/{risk}/data/buildings \
-H Authorization: Bearer {token} \
-H Content-Type: application/json \
-d '{
  "data": [
    {
      "object": "building",
      "data": {
        "premise": "1f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b",
        "number": 1
      }
    },
    {
      "object": "building",
      "data": {
        "premise": "1f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b",
      }
    }
  ]
}'

Example response

{
  "data": [
    {
      "object": "building",
      "uuid": "6e98da95-ff7d-4fe7-b16c-1e413de94f65",
      "data": {
        ...
      },
      "meta": { ... },
      "relations": { ... }
    },
    {
      "object": "building",
      "uuid": "3e98da95-ff7d-4fe7-b16c-1e413de94f65",
      "data": {
        ...
      },
      "meta": { ... },
      "relations": { ... }
    }
  ]
}

In some cases, we need to reorder the objects to be able to create them in a specific order. If the order of the objects is important in the response, you can use the uuid property to specify a unique key for the object. This uuid will not be used to create the object, but will instead be used as the object-key in the response.

Example specifying UUID

Example request

POST

/api/v1/risks/{risk}/data/buildings

curl -X POST https://app.wunderite.com/api/v1/risks/{risk}/data/buildings \
-H Authorization: Bearer {token} \
-H Content-Type: application/json \
-d '{
  "data": [
    {
      "object": "building",
      "uuid": "my-building-uuid",
      "data": {
        "premise": "1f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b",
        "number": 1
      }
    },
    {
      "object": "building",
      "uuid": "my-building-uuid2",
      "data": {
        "premise": "1f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b",
      }
    }
  ]
}'

Example keyed response

{
  "data": {
    "my-building-uuid": {
      "object": "building",
      "uuid": "6e98da95-ff7d-4fe7-b16c-1e413de94f65",
      "data": {
        ...
      },
      "meta": { ... },
      "relations": { ... }
    },
    "my-building-uuid2": {
      "object": "building",
      "uuid": "3e98da95-ff7d-4fe7-b16c-1e413de94f65",
      "data": {
        ...
      },
      "meta": { ... },
      "relations": { ... }
    }
  }
}

Update requests

PATCH update requests are used to update one or more objects, of which can be a mix of different types. The request body should contain an array of objects to be updated, all of which must have a valid object, uuid, and data property.

The response to a PATCH update request will return exactly what is sent in the request. meta and relations properties will not be included in the response.

Example

Example request

PATCH

/api/v1/risks/{risk}/data

curl -X POST https://app.wunderite.com/api/v1/risks/{risk}/data \
-H Authorization: Bearer {token} \
-H Content-Type: application/json \
-d '{
  "data": [
    {
      "object": "building",
      "uuid": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b",
      "data": {
        "number": 5
      }
    },
    {
      "object": "subject_of_insurance",
      "uuid": "2f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b",
      "data": {
        "type": "b"
      }
    }
  ]
}'

Example response

{
  "data": [
    {
      "object": "building",
      "uuid": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b",
      "data": {
        "number": 5
      }
    },
    {
      "object": "subject_of_insurance",
      "uuid": "2f2c9f0a-aa6a-4ea7-9ed3-b5d013d01c5b",
      "data": {
        "type": "b"
      }
    }
  ]
}

Delete requests

Delete requests are the most simple in terms of object composition. They only require a valid object and uuid pair that you have access to delete. You can delete many different types of objects in a single request.

Similar to update requests, the response to a DELETE request will return exactly what is sent in the request. data, meta, and relations properties will not be included in the response.

Example

Example request

PATCH

/api/v1/risks/{risk}/data

curl -X POST https://app.wunderite.com/api/v1/risks/{risk}/data \
-H Authorization: Bearer {token} \
-H Content-Type: application/json \
-d '{
  "data": [
    {
      "object": "building",
      "uuid": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b"
    }
  ]
}'

Example response

{
  "data": [
    {
      "object": "building",
      "uuid": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b"
    }
  ]
}