Skip to content

Get geo zone

GET/geo-zones/{id}

Auth: X-API-Key headerhttps://warpdrive.staging.transferz.com/transfercompanies

Retrieves a geo zone by its identifier

Returns a geo zone, the area a fare applies to, as a polygon. The id is in a journey's fareSummary.geoZoneId.

Path parameters

  • idinteger · int64required

    The id of the geo zone to retrieve

Headers

  • X-Request-IDstring

    The optional (ideally unique) request identifier used for later analysis or diagnostics

Responses

OK

  • idinteger · int64
  • namestring
  • polygonarray of objects

Errors this endpoint can return

  • When: The zone is not available to your company.

    What to do: Check that the id belongs to your company and that you use the key of the right user. Ask Transferz to check the account's permissions if the id is correct.

Was this helpful?