Get keylight routefollower results

29 Aug 2023
3 Minutes to read
Contributors

Print
Dark
Light
PDF

Get keylight routefollower results

Updated on 29 Aug 2023
3 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/el_routefollower/

Operation is used to retrieve details of a route and it's components with given parameters. Required parameters are 1. source_ids and object_name or 2.

Available from product version 3.4.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Query parameters

source_id

integer Required

Primary keys (id) of the threads or connectors to follow. Can be multiple, comma separated

ctid

integer

ContentType id for the cable or terminal used, use /api/v2/object-types/ endpoint to get these

logical_dir

integer

Logical direction to follow. 1 for ascending, 2 for descending. For both directions default is -1.

Valid values[1,2,-1]

Default"-1"

distance

number

Numeric length to stop following route

Default"infinite"

pass_node

boolean

Pass through the next node

Default"False"

only_closed_switches

boolean

Pass only when El Premises switch is closed

Default"True"

Responses

200

List of routes

{
  "Results": [
    {
      "components": [
        {
          "connectionObject": "Start point",
          "ctid": 7465,
          "identification": "AAA",
          "location": "SRID=3067;POINT Z (456522.01195571 6700731.858811 0)",
          "object_id": 428401,
          "order": 0,
          "path": 1,
          "routeObject": "http://keycom.example.com/api/v2/el_premises/428401/",
          "route_length": 0
        },
        {
          "connectionObject": "http://keycom.example.com/api/v2/el_cable_connections/98001/",
          "ctid": 7458,
          "identification": "route_test",
          "location": "SRID=3067;LINESTRING Z (456522.01195571 6700731.858811 0, 456623.61190084 6700733.9754765 0)",
          "object_id": 376410,
          "order": 1,
          "path": 1,
          "routeObject": "http://keycom.example.com/api/v2/el_cable/376410/",
          "route_length": 101.6
        },
        {
          "connectionObject": "http://keycom.example.com/api/v2/el_cable_connections/98051/",
          "ctid": 7465,
          "identification": "AAA2",
          "location": "SRID=3067;POINT Z (456623.61190084 6700733.9754765 0)",
          "object_id": 428411,
          "order": 2,
          "path": 1,
          "routeObject": "http://keycom.example.com/api/v2/el_premises/428411/",
          "route_length": 101.6
        },
        {
          "connectionObject": "http://keycom.example.com/api/v2/el_cable_connections/98011/",
          "ctid": 7458,
          "identification": "route_test",
          "location": "SRID=3067;LINESTRING Z (456623.61190084 6700733.9754765 0, 456690.28686484 6700687.9380014 0)",
          "object_id": 376420,
          "order": 3,
          "path": 1,
          "routeObject": "http://keycom.example.com/api/v2/el_cable/376420/",
          "route_length": 182.6
        },
        {
          "connectionObject": null,
          "ctid": "",
          "identification": "Trace end 150.0",
          "location": "SRID=3067;LINESTRING Z (456623.61190084 6700733.9754765 0, 456690.28686484 6700687.9380014 0)",
          "object_id": 1,
          "order": 4,
          "path": 1,
          "routeObject": null,
          "route_length": 182.6
        }
      ],
      "endpoint": {
        "connectionObject": null,
        "ctid": "",
        "identification": "Reitti 1: Premise AAA -> Trace end Trace end 150.0",
        "location": "SRID=3067;LINESTRING Z (456623.61190084 6700733.9754765 0, 456690.28686484 6700687.9380014 0)",
        "object_id": 1,
        "order": 4,
        "path": 1,
        "routeObject": null,
        "route_length": 182.6
      }
    },
    {
      "components": [
        {
          "connectionObject": "Start point",
          "ctid": 7465,
          "identification": "AAA",
          "location": "SRID=3067;POINT Z (456522.01195571 6700731.858811 0)",
          "object_id": 428401,
          "order": 0,
          "path": 2,
          "routeObject": "http://keycom.example.com/api/v2/el_premises/428401/",
          "route_length": 0
        },
        {
          "connectionObject": "http://keycom.example.com/api/v2/el_cable_connections/98001/",
          "ctid": 7458,
          "identification": "route_test",
          "location": "SRID=3067;LINESTRING Z (456522.01195571 6700731.858811 0, 456623.61190084 6700733.9754765 0)",
          "object_id": 376410,
          "order": 1,
          "path": 2,
          "routeObject": "http://keycom.example.com/api/v2/el_cable/376410/",
          "route_length": 101.6
        },
        {
          "connectionObject": "http://keycom.example.com/api/v2/el_cable_connections/98051/",
          "ctid": 7465,
          "identification": "AAA2",
          "location": "SRID=3067;POINT Z (456623.61190084 6700733.9754765 0)",
          "object_id": 428411,
          "order": 2,
          "path": 2,
          "routeObject": "http://keycom.example.com/api/v2/el_premises/428411/",
          "route_length": 101.6
        },
        {
          "connectionObject": "http://keycom.example.com/api/v2/el_cable_connections/98031/",
          "ctid": 7458,
          "identification": "route_test",
          "location": "SRID=3067;LINESTRING Z (456623.61190084 6700733.9754765 0, 456684.99520103 6700801.1796069 0)",
          "object_id": 376430,
          "order": 3,
          "path": 2,
          "routeObject": "http://keycom.example.com/api/v2/el_cable/376430/",
          "route_length": 192.6
        },
        {
          "connectionObject": null,
          "ctid": "",
          "identification": "Trace end 150.0",
          "location": "SRID=3067;LINESTRING Z (456623.61190084 6700733.9754765 0, 456684.99520103 6700801.1796069 0)",
          "object_id": 1,
          "order": 4,
          "path": 2,
          "routeObject": null,
          "route_length": 192.6
        }
      ],
      "endpoint": {
        "connectionObject": null,
        "ctid": "",
        "identification": "Reitti 2: Premise AAA -> Trace end Trace end 150.0",
        "location": "SRID=3067;LINESTRING Z (456623.61190084 6700733.9754765 0, 456684.99520103 6700801.1796069 0)",
        "object_id": 1,
        "order": 4,
        "path": 2,
        "routeObject": null,
        "route_length": 192.6
      }
    }
  ]
}

Array of object

object

components

Array of object

object

connectionObject

string

Link to the API endpoint of the connection used to get to the route object or 'Start object' if start point or null if trace end.

ctid

integer

Content type ID of the route object.

identification

string

Name/identification of the route object.

location

string

Geographical location.

objectId

integer

Primary key of the route object.

order

integer

The order of which the route object belongs to.

path

integer

The path number the route object belongs to.

routeObject

string

Link to the API endpoint of the route object or null if trace end.

route_length

number

The running total length of the route up until the route object.

endpoint

object

connectionObject

string

Link to the API endpoint of the connection used for the endpointobject or null if trace end.

ctid

integer

Content type ID of the endpoint object.

identification

string

Name/identification of the current route.

location

string

Geographical location.

objectId

integer

Primary key of endpoint object.

order

integer

The order of which the endpoint object belongs to.

path

integer

The path number the endpoint object belongs to.

routeObject

string

Link to the API endpoint of the endpoint object or null if trace end.

route_length

number

The running total length of the route up until the endpoint object.

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

Get list of Electric Splices