Jump to

• Request
• Response
• Examples

Get available contraction hierarchy networks

get

https://localhost:7011/chrest/v1/configuration/networks

List all available contraction hierarchy networks and status.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Showing existed contraction hierarchy networks and status.

Body ()

Root Schema : AvailableNetworksResponse

Type: object

Show Source

• error: string
• networks: array networks

{
    "type":"object",
    "properties":{
        "networks":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AvailableNetworksResponse_networks"
            }
        },
        "error":{
            "type":"string"
        }
    }
}

Nested Schema : networks

Type: array

Show Source

• Array of: object AvailableNetworksResponse_networks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AvailableNetworksResponse_networks"
    }
}

Nested Schema : AvailableNetworksResponse_networks

Type: object

Show Source

• chName: string
  Name of generated contraction hierarchy network
• networkName: string
  Name of NDM network in database

  Example: HERE_SF_NET
• status: string
  Allowed Values: [ "Building", "Loaded", "Failed", "ReadyToLoad" ]

{
    "type":"object",
    "properties":{
        "chName":{
            "type":"string",
            "description":"Name of generated contraction hierarchy network"
        },
        "networkName":{
            "type":"string",
            "description":"Name of NDM network in database",
            "example":"HERE_SF_NET"
        },
        "status":{
            "type":"string",
            "enum":[
                "Building",
                "Loaded",
                "Failed",
                "ReadyToLoad"
            ]
        }
    }
}

Back to Top

Examples

The following example shows how to view all contraction hierarchy networks.

curl -v -X GET "https://localhost:8011/chrest/v1/configuration/networks"

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK Date: Tue, 14 Jan 2020 18:35:41 GMT Content-Type: application/json; charset=UTF-8

Example of Response Body

The following example shows the contents of the response body in JSON format.

{"networks":[{"chName":"sample","networkName":"TL_NYC_NET","status":"Loaded"},{"chName":"heresf","networkName":"HERE_SF_NET","status":"Loaded"}]}

Back to Top