Skip to content
DezfilDocsv0.1.0

API and agentsAPI reference

SearchResults

object

The grouped map-search answer. places is present only when asked for, refusedLayers only when a layer's values were refused.

  • layersarrayrequired

    Visible layers whose names match.

    • (each item)object

      • layerIdstringrequired

      • namestringrequired

      • vizstringrequired

        The layer's visualization type.

  • valuesarrayrequired

    Matching features, one row each, at most 20. Point features carry point; lines and polygons carry an interior anchor and bounds [minLng, minLat, maxLng, maxLat].

    • (each item)object

      • layerIdstringrequired

      • layerNamestringrequired

      • fieldstringrequired

      • valuestringrequired

      • pointarray of number

      • anchorarray of number

      • boundsarray of number

  • refusedLayersarray

    Visible layers whose matching values were refused: one of them is longer than 2,097,152 bytes (2 MiB) as a JSON string, the ceiling for one value. Such a layer answers no value rows; the others answer as usual. Each entry carries the error and errorCode a failed widget carries (query_result_too_large). Other layer failures contribute nothing and are not listed.

    • (each item)object

      • layerIdstringrequired

      • layerNamestringrequired

      • errorstringrequired

      • errorCodestringrequired

        One of the documented error codes.

  • coordinatesarrayrequired

    Every plausible reading of a pasted decimal pair — both when both are valid.

    • (each item)object

      • readingstringrequired

        One of latlon, lonlat

      • latnumberrequired

      • lngnumberrequired

  • placesobject

    The places group's answer: ok with results and the provider's attribution, unconfigured, or failed with a sanitized message (never the provider URL).

    • statestringrequired

      One of ok, unconfigured, failed

    • attributionstringor null

    • messagestring

    • resultsarray

      • (each item)object

        • namestringrequired

        • contextstringor null

        • lngnumberrequired

        • latnumberrequired

        • boundsarray of number

Dezfil · Apache-2.0docs from 7439201b