Estated v0.1.0 Estated.Response View Source

The top-level response from the Estated v4 API.

Successful responses include a property record, metadata, and a list of warnings. Warning responses include metadata, one or more warnings, and maybe a property record. Error responses include an error and metadata.

In the event of multiple properties found for a given request, the API will return a warning code of "PW02", multiple properties found. The metadata of the warning will include a list of APN and FIPS codes that can be used for subsequent property requests.

Link to this section Summary

Types

t()

Top-level response.

Link to this section Types

Link to this type

t()

View Source (since 0.1.0)
t() :: %Estated.Response{
  data: Estated.Property.t() | nil,
  error: Estated.Error.t() | nil,
  metadata: Estated.ResponseMetadata.t() | nil,
  warnings: [Estated.Warning.t()]
}

Top-level response.