> ## Documentation Index > Fetch the complete documentation index at: https://support.keypro.fi/llms.txt > Use this file to discover all available pages before exploring further. # Circuit fault location > 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. ## OpenAPI ````json GET /circuitFaultLocation/ { "openapi": "3.0.4", "info": { "title": "KeyCom REST API", "termsOfService": "https://www.keypro.fi/en/terms-of-service", "contact": { "name": "Keypro Oy", "url": "https://keypro.fi/", "email": "keypro@keypro.fi" }, "license": { "name": "Copyright (C) Keypro Oy. All rights reserved.", "url": "https://www.keypro.fi/" }, "version": "2.0.0" }, "servers": [ { "url": "/api/v2" } ], "tags": [ { "name": "Plan", "description": "Plan related operations." }, { "name": "FreeArea", "description": "FreeArea related operations." }, { "name": "FreeLine", "description": "FreeLine related operations." }, { "name": "FreeText", "description": "FreeText related operations." }, { "name": "FreeTextComponent", "description": "FreeText component related operations." }, { "name": "Address", "description": "Building address related operations." }, { "name": "Apartment", "description": "Building apartments related operations." }, { "name": "Extra Attribute", "description": "Extra attributes related operations." }, { "name": "Extra Value", "description": "Extra attribute values related operations." }, { "name": "EAV Enum", "description": "EAV Enum value related operations." }, { "name": "EAV Enum Group", "description": "EAV Enum group related operations." }, { "name": "External Document", "description": "External documents related operations." }, { "name": "Attached Document", "description": "Attached Documents related operations." }, { "name": "Collections", "description": "Collection related operations." }, { "name": "Source system apartment", "description": "External source system derived apartment related operations." }, { "name": "Source system address", "description": "External source system derived address related operations." }, { "name": "Address alias", "description": "Address aliases related operations" }, { "name": "TxtConstant", "description": "TxtConstants related operations." }, { "name": "Point", "description": "Point objects related operations." }, { "name": "Survey Constant", "description": "Survey Constants related operations." }, { "name": "Survey Point", "description": "Survey Points related operations." }, { "name": "Survey Line String", "description": "Survey Line Strings related operations." }, { "name": "Template Catalog", "description": "Template Catalog related operations." }, { "name": "Route Following", "description": "Route following related operations." }, { "name": "Contact Person", "description": "Contact person related operations." }, { "name": "Contact Person Connection", "description": "Contact person connection related operations." }, { "name": "Telecom premises", "description": "Telecom premises related operations." }, { "name": "Device", "description": "Device related operations." }, { "name": "Device Group", "description": "Device Group related operations." }, { "name": "Splice", "description": "Telecom Splice related operations." }, { "name": "Telecom Conduit", "description": "Telecom Conduit related operations." }, { "name": "Telecom Conduit Link", "description": "Operations related to putting Telecom Cables and Ducts into Conduits." }, { "name": "Telecom Duct", "description": "Telecom Duct related operations." }, { "name": "Telecom Duct Link", "description": "Operations related to putting Telecom Cables into Ducts." }, { "name": "Telecom Conduit Connection", "description": "Operations related to connecting Conduits and endpoints." }, { "name": "Telecom Cable Connection", "description": "Operations related to connecting Cables and endpoints" }, { "name": "Telecom Thread/Port Connection", "description": "Operations related to connecting and disconnecting telecom cable threads and device ports" }, { "name": "Telecom Duct Connection", "description": "Operations related to connecting Telecom Ducts to Telecom Premises or Manhole." }, { "name": "Manhole", "description": "Telecom Manhole related operations." }, { "name": "Cable", "description": "Telecom Cable related operations." }, { "name": "Cable Appendix", "description": "Cable Appendix operations for connecting Cables to loops. Manages the relationship between Cables and loops, automatically adjusting Cable extra_length when appendixes are created, updated, or deleted." }, { "name": "Supercable", "description": "Telecom Supercable related operations." }, { "name": "Cross connection point", "description": "Cross connection point related operations." }, { "name": "Service Area", "description": "Service Area related operations." }, { "name": "Exchange Area", "description": "Exchange Area related operations." }, { "name": "Telecom Area", "description": "Telecom Area related operations." }, { "name": "Routefollower", "description": "Routefollower related operations." }, { "name": "Circuit", "description": "Circuit related operations." }, { "name": "Circuit Location", "description": "Circuit installation location related operations." }, { "name": "Circuit Section", "description": "Circuit section related operations." }, { "name": "Circuit Reservation Data", "description": "Circuit reservation data view and search operations." }, { "name": "Customer", "description": "Customer data related operations." }, { "name": "Passed Services", "description": "Passed Services related operations." }, { "name": "Circuit Connection", "description": "Circuit logical reservations related operations." }, { "name": "Circuit Physical Reservation", "description": "Circuit physical reservations related operations." }, { "name": "Create connections", "description": "Operation used to create new connections." }, { "name": "Terminal type", "description": "Terminal types related operations." }, { "name": "Logical connections", "description": "Logical connections related operations." }, { "name": "Circuit Services", "description": "Operations provided by micro services." }, { "name": "Contract", "description": "Contract related operations." }, { "name": "Contract Link", "description": "Contract link related operations." }, { "name": "Pole", "description": "Pole related operations." }, { "name": "Circuit faults", "description": "Circuit faults related operations." }, { "name": "Duct groups", "description": "Duct groups related operations." }, { "name": "Duct group rows", "description": "Duct group rows related operations." }, { "name": "Threads", "description": "Cable thread related operations." }, { "name": "Task", "description": "Task related operations." }, { "name": "Subregion", "description": "Subregion related operations." }, { "name": "SAttribute", "description": "SAttribute related operations." }, { "name": "Fault", "description": "Fault related operations." }, { "name": "Maintenance history", "description": "Maintenance history related operations." }, { "name": "Deflection", "description": "Deflection related operations." }, { "name": "Fault Component", "description": "Fault Component related operations." }, { "name": "Task Comment", "description": "Task comment related operations." }, { "name": "FaultComponentFault", "description": "FaultComponentFault related operations." } ], "paths": { "/circuitFaultLocation/": { "get": { "tags": [ "Circuit Services" ], "summary": "Circuit fault location", "description": "NOTE: This API is provided by a separate service.\n\nThis API endpoint makes a trace for specified distance from certain circuit section (and possibly port id)\nand using either logical or physical reservations finds the component of network affected by fault.\n\nAvailable from product version 3.6.0.\n", "operationId": "circuitFaultLocation", "parameters": [ { "name": "sectionId", "in": "query", "description": "circuit section to be traced", "required": true, "schema": { "type": "integer" } }, { "name": "portId", "in": "query", "description": "port (cross-connection point) to be traced", "schema": { "type": "integer" } }, { "name": "distance", "in": "query", "description": "optical distance for locating the fault", "required": true, "schema": { "type": "number", "format": "float" } }, { "name": "reservation", "in": "query", "description": "specifies if logical or physical reservations of the circuit section are used for locating the fault", "required": true, "schema": { "enum": [ "logical", "physical" ], "type": "string" } }, { "$ref": "#/components/parameters/srsParam" }, { "$ref": "#/components/parameters/langParam" } ], "responses": { "200": { "description": "List of circuit fault locations", "content": { "application/json": { "schema": { "properties": { "Results": { "type": "array", "items": { "$ref": "#/components/schemas/CircuitFaultLocation" } } } }, "example": { "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)" } ] } } } }, "401": { "$ref": "#/components/responses/Http401" }, "404": { "$ref": "#/components/responses/Http404" } }, "security": [ { "Token": [] } ] } } }, "components": { "parameters": { "srsParam": { "name": "srs", "in": "query", "description": "Coordinate system used to transform location fields in API responses.\nThis parameter does not apply to locations sent in request query parameters or request bodies.\n\nFor locations in requests, use EWKT with SRID.\nIf EWKT is provided without SRID, the system default SRID will be used.\n\n**Example:** `srs=epsg:4326`\n", "schema": { "type": "string" } }, "langParam": { "name": "Accept-Language", "in": "header", "description": "Two-letter language code to use for interface translation.\n**Example:** `Accept-Language=en`\n", "schema": { "type": "string" } } }, "schemas": { "CircuitFaultLocation": { "type": "object", "properties": { "distance": { "type": "number", "description": "calculated distance from all objects along the route found (cross-connections, device internal connections, cable total lengths)", "format": "float" }, "location": { "type": "string", "description": "calculated location of the fault, taking into account possible loops and coils along the route", "format": "ewkt" }, "objectId": { "type": "integer", "description": "id of object affected by fault" }, "objectType": { "enum": [ "threaddetail", "crossconnectionpoint" ], "type": "string", "description": "type of object affected by fault" }, "routeEndReached": { "type": "boolean", "description": "is route end reached or route ended preliminary" }, "routeLocation": { "type": "string", "description": "route from start of trace to object affected by fault (including object affected by fault)", "format": "ewkt" } } }, "ErrorDetailsResponse": { "required": [ "details" ], "type": "object", "properties": { "details": { "type": "string", "description": "Detailed description of error" } }, "description": "Standard error response payload" } }, "responses": { "Http401": { "description": "Authentication credentials are missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDetailsResponse" }, "example": { "details": "Authentication credentials were not provided" } } } }, "Http404": { "description": "Object was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDetailsResponse" }, "example": { "details": "Not found." } } } } }, "securitySchemes": { "Token": { "type": "apiKey", "description": "Token issued for API consumer.", "name": "Authorization", "in": "header" } } } } ````