Jump to

• Request
• Response
• Examples

Get available contraction hierarchies networks

get

/chrest/v1/configuration/networks

List all available contraction hierarchies networks and status.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Showing existed contraction hierarchies networks and status.

Body ()

Root Schema : AvailableNetworksResponse

Type: object

Show Source

• error(optional): string
• networks(optional): array networks

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

Nested Schema : networks

Type: array

Show Source

• Array of: object AvailableNetworksResponse_networks

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

Nested Schema : AvailableNetworksResponse_networks

Type: object

Show Source

• chName(optional): string
  Name of generated contraction hierarchies network
• networkName(optional): string
  Name of NDM network in database

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

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

Back to Top

Examples

The following example shows how to view all contraction hierarchies 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":"OSM_NY","status":"Loaded"},{"chName":"heresf","networkName":"HERE_SF_NET","status":"Loaded"}]}

Back to Top