geo31 ops

Geo API

Regions, zones, geocoding, and reverse geocoding.

Queries

QUERY

addressSearch

#

Arguments

  • queryString!

    Search query (address, place name, or landmark)

  • countryCodeString

    Optional country code to limit search (ISO 3166-1 alpha-2)

  • limitInt

    Maximum number of results (default: 10)

  • bias

    Coordinates to bias result ranking toward (searcher's position)

  • languageString

    Language tag for localized result labels (e.g., "fa", "en")

Returns[!]!
QUERY

adminCountryLookups

#

Countries people have asked about, most-asked-about first. Counts only. Join against paymentGatewayCoverage, smsProviderCoverage and any other coverage query to decide which of these we can serve — that answer belongs to whichever service owns the rail, and it changes on every deploy. Unpaginated because the table cannot exceed 676 rows.

Returns[!]!
QUERY

adminGeoEngineCities

#

Cities whose routes and addresses our own map engines may answer, by name (PlatformAdmin only). Unpaginated: the list is the handful of cities we host data for. Each city comes with the workspaces operating in it.

Returns[!]!
QUERY

adminGeoEngineStatus

#

Whether the self-hosted map engines are configured and answering (PlatformAdmin only).

Returns!
QUERY

adminTenantRegions

#

List the operational regions of a specific tenant (PlatformAdmin only). Mirrors tenantRegions but takes the target tenant from the argument instead of the request context, so platform admins can inspect a tenant they're not impersonating. Used by the admin tenant detail page.

Arguments

  • tenantId!
  • input!

    Default

    {
      "filter": null,
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      }
    }
Returns!
QUERY

getAddressDetails

#

Get detailed address information for form prefilling Retrieves comprehensive address components including: - Street name and number - Unit/apartment number - Building name - Neighborhood/district - City, region, postal code - Country code - Coordinates and geohash - Address types and verification level Either place_id OR both latitude and longitude must be provided.

Arguments

  • input!
Returns!
QUERY

listCountries

#

Arguments

  • searchString

    Optional search term to filter countries

Returns[!]!
QUERY

reverseGeocode

#

Arguments

  • coordinates!

    Coordinates

Returns!
QUERY

tenantRegion

#

Get one of the caller's tenant regions by ID. Another tenant's region resolves to null, as if it did not exist.

Arguments

  • id!
Returns
QUERY

tenantRegions

#

List tenant regions with filtering and pagination.

Arguments

  • input!

    Default

    {
      "filter": null,
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      }
    }
Returns!
QUERY

zone

#

Get one of the caller's tenant zones by ID. Another tenant's zone resolves to null, as if it did not exist.

Arguments

  • id!
Returns
QUERY

zoneGroupAdmin

#

Arguments

  • id!
Returns
QUERY

zoneGroupsAdmin

#

Zone groups, with their member zones named; by name unless sort asks otherwise.

Arguments

  • input!

    Default

    {
      "regionId": null,
      "app": null,
      "includeInactive": false,
      "sort": null,
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      }
    }
Returns!
QUERY

zones

#

List zones with filtering and pagination

Arguments

  • input!

    Default

    {
      "filter": null,
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      }
    }
Returns!

Mutations

MUTATION

adminAddGeoEngineCity

#

Put a city on the list (PlatformAdmin only). The city starts with its map data requested and every capability off. Without radiusMeters the coverage radius is sized from the city's population, the same way an auto-created region is.

Arguments

  • cityId!
  • radiusMetersInt

    Coverage radius around the city centre, 1000 to 100000 metres.

Returns!
MUTATION

adminRemoveGeoEngineCity

#

Take a city off the list (PlatformAdmin only). Allowed only when all three capabilities are off. Returns false when the city was not on the list.

Arguments

  • cityId!
ReturnsBoolean!
MUTATION

adminRequestGeoEngineCityRefresh

#

Ask for a city's map data to be rebuilt (PlatformAdmin only). Capabilities stay as they are: the data already loaded keeps serving until the rebuilt data replaces it.

Arguments

  • cityId!
Returns!
MUTATION

adminRunGeoEngineCityCheck

#

Compare our routing engine against Google for a city, and store the result (PlatformAdmin only). A check that PASSED also sets the trip-time factor it implies, unless the factor was set by hand or learned from completed trips. Each test trip is one billed Google route request.

Arguments

  • cityId!
  • sampleSizeInt

    Test trips to compare: 10 to 100, default 30.

Returns!
MUTATION

adminSetGeoEngineCityCapabilities

#

Switch a city's capabilities on or off (PlatformAdmin only). A capability can be switched on only once the city's map data is READY. Routing additionally needs a check that PASSED, unless force is set. Switching anything off is always allowed.

Arguments

  • cityId!
  • input!
Returns!
MUTATION

adminSetGeoEngineCityDurationFactor

#

Set a city's trip-time factor by hand (PlatformAdmin only).

Arguments

  • cityId!
  • factorFloat!

    Multiplier for our routing engine's durations, 0.25 to 5.

Returns!
MUTATION

createTenantRegion

#

Create a new tenant region.

Arguments

  • input!
Returns!
MUTATION

createZone

#

Create a new zone

Arguments

  • input!
Returns!
MUTATION

createZoneGroup

#

Arguments

  • input!
Returns!
MUTATION

deleteTenantRegion

#

Delete (deactivate) a tenant region.

Arguments

  • id!
ReturnsBoolean!
MUTATION

deleteZone

#

Delete (deactivate) a zone

Arguments

  • id!
ReturnsBoolean!
MUTATION

deleteZoneGroup

#

Delete a group. Refused while group flat fares use it.

Arguments

  • id!
ReturnsBoolean!
MUTATION

recordCountryLookup

#

Record that someone asked whether we cover a country. Public and unauthenticated — see the module header. Returns false rather than erroring for a code that is not two ASCII letters, so a malformed value cannot turn a marketing page into an error state.

Arguments

  • countryCodeString!

    ISO 3166-1 alpha-2 country code (e.g. "RS", "GE").

ReturnsBoolean!
MUTATION

updateTenantRegion

#

Update an existing tenant region.

Arguments

  • input!
Returns!
MUTATION

updateZone

#

Update an existing zone

Arguments

  • input!
Returns!
MUTATION

updateZoneBoundaries

#

Update zone boundaries (polygon)

Arguments

  • input!
Returns!
MUTATION

updateZoneGroup

#

Arguments

  • input!
Returns!