AdminConsole
API reference/mGIS Analytics
GETstatefulexact public snapshot

Fetches the results of the query applied between two dataset as well as between one datset and user defimed geometry.

/dqv/catchement_query/join

User can performed both the following tasks: Non Spatial Query Spatial Query For spatial query user can perform the query between 2 datasets as well as between one dataset and user defined geometry in geojson format. Whereas Non-Spatial Query is only applicable between 2 datasets.

Build a requestGet credentials
Exact public source snapshot

This operation is retained because its version-labelled public specification differs structurally from another generation. It is comparison evidence, not a promise of current support, compatibility, entitlement, or availability.

Request target

Call the operation

GEThttps://mgis-apiv2.mappls.com/dqv/catchement_query/join?queryType=functionBased&datasetSource=geocode_ii&operator=Intersects&sourceProperty=id
Base URLhttps://mgis-apiv2.mappls.com/
Authenticationbearer
Journey roleobserve
Content typesapplication/json
Path, query, and headers

Parameters

NameLocationTypeDescriptionExample
queryTyperequired
querystring

queryType value can be basic, spatial .

functionBased
datasetSourcerequired
querystring

Source dataset name. Mandatory both in case of Spatial as well as Non-Spatial Query.

geocode_ii
datasetRef
querystring

Source dataset name. Mandatory both in case of Non-Spatial Query.

geocode_iii
operatorrequired
querystring

Mandatory both in case of Spatial as well as Non-Spatial Query. Operators allowed for queryType = 'basic' are: =, =, , <>, IN and NOT IN Operators allowed for queryType = 'spatial' are: Intersects, Disjoint, Overlaps, Equals, Touches, DWithin, Within, Contains and Crosses

Intersects
sourcePropertyrequired
querystring

Source property attributes to be queried. Mandatory both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.

id
refProperty
querystring

Reference property attributes to be queried. Mandatory in case of Non-Spatial Query.

id
selectionParamSource
querystring

Source property attributes to be reflected in the result. Optional in case of arithmetic operations, Spatial(between 2 datasets) as well as Non-Spatial Query.

id, lat
selectionParamRef
querystring

Reference property attributes to be reflected in the result. Optional both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.

osm_id, name
userGeom
querystring

Value of UserGeom will be 'true' if user wants to perform spatial filters with user-defined geometry.

true
distance
querynumber

Mandatory in case of operator DWithin, else it is not required.

10
Required body

Body schema

FieldTypeDescriptionExample
type
string

No field description in the source contract.

FeatureCollection
features
array<object>

No field description in the source contract.

example
features[].type
string

No field description in the source contract.

Feature
features[].properties
object

No field description in the source contract.

example
features[].geometry
object

No field description in the source contract.

28.612964,77.229463
features[].geometry.type
string

No field description in the source contract.

Polygon
features[].geometry.coordinates
array<string>

No field description in the source contract.

28.612964,77.229463
Request body example
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": "example",
      "geometry": {
        "type": "Polygon",
        "coordinates": []
      }
    }
  ]
}
Interactive, local, and credential-safe

Build your request in eight languages

Change source-backed examples once, validate required inputs, and copy the synchronized cURL, JavaScript, Python, Java, C#, Go, PHP, or Ruby request. Credentials remain environment references, and this page never sends a provider request.

Local request composerCode stays local · fixtures are explicit
GETRequest inputs
10 editable · 0 protected
Generated in eight languages
Environment-backed credentials
GEThttps://mgis-apiv2.mappls.com/dqv/catchement_query/join?queryType=functionBased&datasetSource=geocode_ii&datasetRef=geocode_iii&operator=Intersects&sourceProperty=id&refProperty=id&selectionParamSource=id%2C+lat&selectionParamRef=osm_id%2C+name&userGeom=true&distance=10
Credential-free sandboxExecute this contract without a provider call
How fixtures work
Generated from your inputs
curl --request GET \
  --url 'https://mgis-apiv2.mappls.com/dqv/catchement_query/join?queryType=functionBased&datasetSource=geocode_ii&datasetRef=geocode_iii&operator=Intersects&sourceProperty=id&refProperty=id&selectionParamSource=id%2C+lat&selectionParamRef=osm_id%2C+name&userGeom=true&distance=10' \
  --header "Accept: application/json" \
  --header "Authorization: Bearer ${MAPPLS_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{"type":"FeatureCollection","features":[{"type":"Feature","properties":"example","geometry":{"type":"Polygon","coordinates":[]}}]}'

Credential-safe by constructionSet MAPPLS_ACCESS_TOKEN only in your trusted runtime. Code generation stays local. Sandbox execution sends only bounded fixture inputs to this developer platform and never reads a credential or calls Mappls.

Five language quickstarts

Send a production-shaped request

Examples use environment-backed access tokens, explicit timeouts where supported, status checks, and JSON bodies derived from the source schema. Replace sample identifiers and coordinates with values from your application.

GET /dqv/catchement_query/join
curl --request GET \
  --url 'https://mgis-apiv2.mappls.com/dqv/catchement_query/join?queryType=functionBased&datasetSource=geocode_ii&operator=Intersects&sourceProperty=id' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": "example",
      "geometry": {
        "type": "Polygon",
        "coordinates": [

        ]
      }
    }
  ]
}'
Success and failure behavior

Responses

200

OK

206

Impartial Content.

400

Bad Request, User made an error while creating a valid request.

401

Unauthorized.

404

No data found in database.

405

Method not allowed.

409

Conflict in parameters passed.

422

Parameter missing

500

Internal server error.

200 response fields

FieldTypeDescriptionExample
code
string

Response code.

200
success
string

No field description in the source contract.

true
message
string

No field description in the source contract.

—
data
array<object>

No field description in the source contract.

example
data[].prop1
string

Prop1 value

example
data[].prop2
string

Prop2 value

example
data[].prop3
string

Prop3 value

example
data[].prop4
string

Prop4 value

example
data[].prop5
string

Prop5 value

example
data[].prop6
string

Prop6 value

example
data[].prop7
string

Prop7 value

example
data[].prop8
string

Prop8 value

example
Response example
{
  "code": "200",
  "success": true,
  "message": "",
  "data": [
    {
      "prop1": "example",
      "prop2": "example",
      "prop3": "example",
      "prop4": "example",
      "prop5": "example",
      "prop6": "example",
      "prop7": "example",
      "prop8": "example"
    }
  ]
}
stateful integration

Operate it safely

observe

This operation observes durable platform state. Preserve resource identifiers and account for pagination, delay, and eventual consistency.

Keep credentials and raw tokens out of source, client bundles, prompts, and logs.Record the operation ID, status, latency, retry count, and source contract version in traces.Classify 4xx responses before retrying; back off and add jitter for retryable 5xx or transport failures.Persist resource identifiers and apply commands exactly once in effect across retries and event replay.
Auditable source

Contract provenance

Source file
mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/dqv-apis.yml
SHA-256
391a57c02f461cd4b27fba7b0ef8f838096a4cc16680bb2c6df225fbcf1fe427
Normalization
Fields are parsed from OpenAPI. Operational guidance and language samples are generated and labeled separately.