Matrix Partial Response and Warnings - web_services - 23.1

spectrum-inline

Product type
Software
Portfolio
Enrich
Integrate
Locate
Verify
Product family
Spectrum
Product
Spectrum > Geocoding > Enterprise Tax
Spectrum > GeoEnrichment
Spectrum > Web Services
Spectrum > Spatial > Spectrum Spatial
Spectrum > Spectrum Platform
Spectrum > Data Integration
Spectrum > Quality > Addressing
Spectrum > Quality > Spectrum Quality
Spectrum > Discovery
Spectrum > Dataflow Designer
Spectrum > Quality > Context Graph
Version
23.1
Language
English
Product name
Precisely Spectrum
Title
spectrum-inline
First publish date
2007
ft:lastEdition
2023-06-02
ft:lastPublication
2023-06-02T09:54:39.526000

The Matrix request excludes problematic points from the calculation to process the request. Any problematic points are, therefore, excluded from the response.

A response, which contains time and distance between points, also includes a warnings section with information about problematic points in the request that were excluded from the calculation. Warnings list the problematic points. Each object in the list contains the error code for that point and an error description.

The warning message is available in REST version 2, SOAP services introduced in version 2020.1 and later, SDK(GRS), and stages introduced in version 2020.1 and later.

Request

Example start points HTTP POST payload.

http://www.precisely.com/rest/Spatial/erm/databases/usroutedatabase.json?
q=routeCostMatrix&startPoints=-74.015547,40.756962,-73.46565,40.4545,
epsg:4326&endPoints=-73.47565,40.4645,epsg:4326&version=2

Response

{
    "matrix": [
        {
            "distanceUnit": "m",
            "distance": 30771.0,
            "timeUnit": "min",
            "time": 89.93,
            "startPoint": {
                "type": "Point",
                "coordinates": [
                    -73.46565,
                    40.4545
                ]
            },
            "endPoint": {
                "type": "Point",
                "coordinates": [
                    -73.47565,
                    40.4645
                ]
            }
        }
    ],
    "warnings": [
        {
            "code": 6002,
"message": "Path could not be calculated between start point (-74.015547,40.756962,0) and end point (-73.47565,40.4645,0)."
        }
    ]
}