2026-10-23 12.00 UTC - There are currently no active events. All systems operational.

Compare a TV observation against its snsewerduct

Prev Next
Post
/tv-observation-comparison/

Operation is used to compare a TV (CCTV) observation's duct-attribute fields against a snsewerduct object: the duct confirmed for the observation's inspection when there is one, otherwise the nearest snsewerduct within tolerance, auto-matched by GIS proximity. The confirmed link wins because it is the duct the apply endpoint writes to.

Form, material and dimension are compared, matched the way /tv-inspection/apply-duct-diff/ resolves them: the form against the duct's DuctProfile text, material and dimension against its duct type. The other fields have no counterpart on the duct, so their keyaqua_value is null and they never differ. A field the inspection left empty never differs either: there is nothing to apply from it.

A confirmed link to a duct that has since been deleted compares against nothing: the apply endpoint refuses it, so a nearby duct would only invite a write that cannot happen.

status is what a duct graph colours the observation by: disabled_from_update when a user disabled it (whatever the comparison says); not_compared when no duct matched, or the observation records none of form, material and dimension (most defect observations); needs_attention when any field differs - also after a "Not update" review, which records a decision rather than a match; and all_good otherwise.

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters
object
tolerance
number (float)

Maximum auto-match distance in meters. Defaults to 0.2 (20 cm).

tv_observation_id
integer Required

Id of the TV observation to compare

Responses
200

Comparison result

Expand All
object
fields
Array of object (ComparisonField)
object
differs
boolean

Whether the two values disagree. Null when no verdict can be reached - the inspector recorded nothing, or the comparison returns a placeholder - so "not comparable" is never rendered as agreement.

field
string

Field name being compared

inspection_value
object

Value from the inspection record. FK fields are shown as a nested {id, txt} object.

keyaqua_value
object

Value from the matched KeyAqua network object. The connection comparison returns the duct's own value here; the inspection and observation comparisons still return a placeholder null.

matched_snsewerduct_id
integer

Id of the snsewerduct compared against - the inspection's confirmed duct, else the nearest within tolerance. Null if none.

review_state
string | null

The observation's review state. Null if nobody has judged it.

Valid values[ "updated", "reviewed", "disabled_from_update" ]
status
string

What a duct graph colours the observation by

Valid values[ "disabled_from_update", "not_compared", "needs_attention", "all_good" ]
400

There was an error in request. Usually field validation failed.

object

Fields which failed validation

property*
Array additionalProperties

List of validation errors for this fieldname

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object

Standard error response payload

details
string

Detailed description of error

403

The user may not view this TV inspection or the sewer ducts it is compared against.

404

Object was not found

{
  "details": "Not found."
}
object

Standard error response payload

details
string

Detailed description of error