Circuit fault location

28 Oct 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Circuit fault location

Updated on 28 Oct 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/circuitFaultLocation/

NOTE: This API is provided by a separate service.

This API endpoint makes a trace for specified distance from certain circuit section (and possibly port id) and using either logical or physical reservations finds the component of network affected by fault.

Available from product version 3.6.0.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Header parameters

Accept-Language

string

Two-letter language code to use for interface translation. Example: Accept-Language=en

Query parameters

sectionId

integerRequired

circuit section to be traced

portId

integer

port (cross-connection point) to be traced

distance

number (float) Required

optical distance for locating the fault

reservation

stringRequired

specifies if logical or physical reservations of the circuit section are used for locating the fault

Valid values[ "logical", "physical" ]

srs

string

Coordinate system to transform location to.

Example: srs=epsg:4326

Responses

200

List of circuit fault locations

{
  "Results": [
    {
      "distance": 970.8,
      "location": "SRID=3067;LINESTRING Z (457538.3626 6702607.0894 0, 457537.72 6702606.7262 0, 457536.0735 6702605.9402 0, 457528.297 6702602.7515 0, 457520.4161 6702598.7193 0, 457515.2844 6702597.1614 0, 457504.1045 6702592.0296 0, 457491.092 6702585.7064 0, 457484.2191 6702581.8575 0, 457478.7209 6702577.5504 0, 457476.155 6702575.0762 0, 457477.8529 6702570.8236 0, 457483.4378 6702561.1318 0, 457484.4602 6702559.2614 0)",
      "objectId": 32150,
      "objectType": "threaddetail",
      "routeEndReached": false,
      "routeLocation": "SRID=3067;LINESTRING Z (457015.2901 6702153.8663 0, 457460.8464 6702567.1192 0, 457460.5929 6702567.0222 0, 457439.0234 6702556.3249 0, 457438.8753 6702556.2515 0, 457438.5041 6702556.0673 0, 457432.8701 6702552.903 0, 457432.7266 6702552.8224 0, 457428.99 6702550.7237 0, 457380.8117 6702525.8032 0, 457380.549 6702525.6673 0, 457379.8553 6702525.3085 0, 457373.9216 6702522.2255 0, 457373.8022 6702522.1635 0, 457357.4035 6702513.6433 0, 457357.1502 6702513.5117 0, 457356.5262 6702513.1875 0, 457351.5084 6702511.3628 0, 457335.8036 6702502.9562 0, 457320.1639 6702494.68 0, 457319.7389 6702494.453 0, 457319.9684 6702490.6398 0, 457320.0434 6702489.5757 0, 457318.8281 6702489.1817 0, 457316.9383 6702488.0087 0, 457281.6839 6702466.6991 0, 457279.8593 6702461.0297 0, 457273.0821 6702456.7939 0, 457250.9259 6702445.52 0, 457240.0274 6702449.1788 0, 457231.0434 6702444.8305 0, 457224.3266 6702441.9372 0, 457214.5067 6702437.3571 0, 457200.8625 6702430.5348 0, 457198.4863 6702429.5383 0, 457192.8906 6702427.2386 0, 457190.3227 6702426.0122 0, 457144.3502 6702402.4025 0, 457103.2067 6702381.1691 0, 457099.1578 6702379.167 0, 457098.9265 6702378.9837 0, 457085.0719 6702369.1839 0, 457084.796 6702368.9943 0, 457080.7466 6702366.2115 0, 457075.4031 6702362.4319 0, 457072.5358 6702360.7375 0, 457061.5881 6702352.2659 0, 457058.0691 6702350.0502 0, 457055.9773 6702348.4965 0, 457055.794 6702348.364 0, 457041.7452 6702339.8435 0, 457037.3792 6702337.4323 0, 457034.7074 6702335.8683 0, 457032.8828 6702334.4998 0, 457032.6843 6702334.3434 0, 457024.0855 6702327.5677 0, 457020.9575 6702325.6779 0, 457018.2858 6702324.179 0, 456987.2671 6702309.0603 0, 456981.0764 6702306.0626 0, 456981.5977 6702304.0425 0, 456983.2269 6702301.11 0, 456998.9972 6702273.0238 0, 457006.6217 6702259.7301 0, 457007.4037 6702252.3012 0, 457010.4994 6702212.7702 0, 457011.0531 6702205.5273 0, 457011.0554 6702205.3983 0, 457012.5197 6702203.4515 0, 457014.7353 6702200.1281 0, 457017.2768 6702195.6317 0, 457017.7981 6702194.6542 0, 457034.8067 6702156.0111 0, 457037.0795 6702150.5952 0, 457020.2111 6702142.55 0, 457015.932 6702152.3842 0, 457015.2896 6702153.8605 0, 457461.2856 6702567.3658 0, 457462.5501 6702567.9929 0, 457465.9387 6702570.1434 0, 457476.155 6702575.0762 0, 457477.8529 6702570.7719 0, 457484.1439 6702559.7753 0, 457484.5195 6702558.9452 0, 457484.5175 6702558.9534 0, 457538.3626 6702607.0894 0, 457537.72 6702606.7262 0, 457536.0735 6702605.9402 0, 457528.297 6702602.7515 0, 457520.4161 6702598.7193 0, 457515.2844 6702597.1614 0, 457504.1045 6702592.0296 0, 457491.092 6702585.7064 0, 457484.2191 6702581.8575 0, 457478.7209 6702577.5504 0, 457477.8529 6702570.8236 0, 457483.4378 6702561.1318 0, 457484.4602 6702559.2614 0)"
    }
  ]
}

Expand All

Results

Array of object (CircuitFaultLocation)

object

distance

number (float)

calculated distance from all objects along the route found (cross-connections, device internal connections, cable total lengths)

location

string (ewkt)

calculated location of the fault, taking into account possible loops and coils along the route

objectId

integer

id of object affected by fault

objectType

string

type of object affected by fault

Valid values[ "threaddetail", "crossconnectionpoint" ]

routeEndReached

boolean

is route end reached or route ended preliminary

routeLocation

string (ewkt)

route from start of trace to object affected by fault (including object affected by fault)

401

Authentication credentials are missing or invalid

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

object

details

string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Create circuit fault location