fa3DNetworkDataName


URI

<facilityAnalyst3D_uri>/{networkDataName}[.<format>]

Supported methods

GET, HEAD

Parent resource

facilityAnalyst3D

Child resources

sinks, sources, traceDownResult, traceUpResult, upstreamCirticalFaclilities

Introduction

fa3DNetworkDataName resource represents the 3D network data used in 3D facility network analysis. Through implementing GET on  fa3DNetworkDataName resource, you can get description of 3D network dataset, such as projection, identify arc ID field, identify node ID field, flow field number and all supported 3D facility network analysis functions.

Supported Methods:

Supported output formats: RJSON, JSON, XML, HTML, JSONP

Resource hierarchy

HTTP request methods

Implement the HTTP request on the following URI, where supermapiserver is the server name, with rjson being the output format.

http://supermapiserver:8090/iserver/services/networkAnalyst3D-Pipe3D/rest/facilityanalyst3d/Network@Pipe3D.rjson

GET request

Gets the description of this 3D network dataset, and all supported 3D facility network analysis function.

Response structure

Implement GET request on the fa3DNetworkDataName resource. In the response body, the 3D network dataset description is in it, and all supported 3D facility network analysis functions. Detailed descriptive structure is as follows:

Field Type Description
barrierEdges int[] Barrier arc.
barrierNodes int[] The barrier point.
directionField String The flow field of 3D network dataset.
edgeIDField String The ID field of identify arc in the 3D network dataset.
fNodeIDfield String The field that identifies the ID of the start node in the 3D network dataset.
nodeIDField String The ID field of identify node in the 3D network dataset.
prjCoordSys PrjCoordSys The projected information of 3D network data.
tNodeIDField String The field that identifies the ID of the end node in the 3D network dataset.
tolerance int The distance tolerance between the point and the edge.
weightFieldInfos WeightFieldInfo3D[] The WeightFieldInfos object.

Response example

The rjson format representation of implementing the GET request on the fa3DNetworkDataName resource http://localhost:8090/iserver/services/networkAnalyst3D-Pipe3D/rest/facilityanalyst3d/Network@Pipe3D.rjson will be as follows:

{

    "barrierEdges": null,

    "barrierNodes": null,

    "directionField": null,

    "edgeIDField": "SMEDGEID",

    "fNodeIDfield": "SMFNODE",

    "nodeIDField": "SMNODEID",

    "prjCoordSys": {

        "coordSystem": {

            "datum": {

                "name": "D_WGS_1984",

                "spheroid": {

                    "axis": 6378137,

                    "flatten": 0.00335281066474748,

                    "name": "WGS_1984",

                    "type": "SPHEROID_WGS_1984"

                },

                "type": "DATUM_WGS_1984"

            },

            "name": "GCS_WGS_1984",

            "primeMeridian": {

                "longitudeValue": 0,

                "name": "Greenwich",

                "type": "PRIMEMERIDIAN_GREENWICH"

            },

            "spatialRefType": "SPATIALREF_EARTH_LONGITUDE_LATITUDE",

            "type": "GCS_WGS_1984",

            "unit": "DEGREE"

        },

        "coordUnit": "DEGREE",

        "distanceUnit": "METER",

        "epsgCode": 4326,

        "name": "Longitude / Latitude Coordinate System---GCS_WGS_1984",

        "projection": null,

        "projectionParam": null,

        "type": "PCS_EARTH_LONGITUDE_LATITUDE"

    },

    "tNodeIDField": "SMTNODE",

    "tolerance": 0,

    "weightFieldInfos": [{

        "ftWeightField": "SMLENGTH",

        "name": "SMLENGTH",

        "tfWeightField": "SMLENGTH"

    }]

}

HEAD request

Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.

HEAD request can be used to check if the fa3DNetworkDataName resource exists, or if the fa3DNetworkDataName resource can be accessed by clients. It can also determine if the fa3DNetworkDataName resource supports an output format <format> if performed on a URI with .<format> included.

See