Facility Network Map | Genlogs API Docs

Authentication

Include the following headers in your requests:

Permissions

Make sure that your api user is created with a role that has external-api-shipper-network-map permission

Endpoint

Response

Response Body

When the request succeeds, the endpoint returns a GeoJSON FeatureCollection whose structure follows FacilityNetworkMapSchema:

Each feature has:

Request example

curl --location 'https://api.genlogs.io/facility/0x4Y4CTmYr6kauPugLT9k4zg/network-map' \
--header 'Content-Type: application/json' \
--header 'access-token: <access-token>' \
--header 'x-api-key: <x-api-key>'

Retrieve the GeoJSON network map for a facility

get https://api.genlogs.io/facility/{facility_id}/network-map

Returns the GeoJSON network map associated with the specified facility.

Path parameters

Responses

Generic FeatureCollection layout

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "<Point|LineString|Polygon>",
        "coordinates": [
          "..."
        ]
      },
      "properties": {
        "analysis_window": "<pre|post|all>",
        "history_window": "<90|180|360|all>",
        "direction": "<network|hub_spoke>",
        "additional_metadata": "..."
      }
    }
  ]
}