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

Compare a branch observation against the nearest sewer branch

Prev Next
Post
/tv-observation-branch-comparison/

Operation is used to compare a TV (CCTV) branch observation - a connection code such as GR - with the nearest sewer branch to where the observation places one, so a user can tell a branch drawn in the wrong place from one that was never documented.

The observation is placed by its own coordinates (MaaltX/YStart) when it has them, otherwise by its station measured along the inspection's linked duct, counted from the end the inspection started at. point_source says which. Without coordinates, a linked duct, a station on that duct and a known inspection direction the observation cannot be placed, and is not compared.

The nearest branch within tolerance that the user may open is compared: its position, its distance from the node and its connection clock position. A value the observation left empty never differs. The branch's data origin and heights are returned for context and never differ: a TV observation records no heights.

status: disabled_from_update when a user disabled the observation; not_compared when it cannot be placed; no_branch when no branch is within tolerance; needs_attention when any field differs; and all_good otherwise.

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters
object
tolerance
number (float)

Maximum distance in meters between the observation's point and the branch. Defaults to 0.5; at most 5.0.

tv_observation_id
integer Required

Id of the branch observation to compare

Responses
200

Comparison result

Expand All
object
distance_m
number (float) | null

Distance in meters between the observation's point and the matched branch.

fields
Array of object (ComparisonField)

x, y, dk_afstand_fra_knude and dk_tilslutning_urref are compared; x_y_origin ({id, label}), z_coord1, z_coord2 and terrain_height are context.

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_snsewerbranch_id
integer | null

Id of the sewer branch compared against, the nearest within tolerance. Null if none.

point_source
string | null

How the observation was placed. Null if it could not be.

Valid values[ "measured", "station" ]
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 graph colours the observation by

Valid values[ "disabled_from_update", "not_compared", "no_branch", "needs_attention", "all_good" ]
tv_observation_id
integer
400

There was an error in request, or the observation records no branch.

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 branches it is compared against.

404

Object was not found

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

Standard error response payload

details
string

Detailed description of error