Subscribe to isolines
Due to its complexity, the generation of isolines is not instantaneous, so it is recommended to use a graphQL subscription. Get the isoline id from the createIsoline mutation and start an isoline subscription.
There are three possible statuses: pending, done, and error.
Subscription
To start the isoline subscription, it is required to provide an isoline id. Fetch the id through the createIsoline mutation. The subscription gives updates regarding the status. When the status changes from pending to done, the isoline has finished generating and can be queried. If there is an error when generating the isoline, the status will return error.
Arguments
id • ID
• Required
Frequently used fields
polygons • FeatureMultiPolygon
Shape of the isoline consisting in a list of multipolygons.
Other fields
id • ID
Isoline id.
status • IsolineStatus
Isoline status.
Show IsolineStatus enum values
ferries • FeatureLineString
List of the ferries uniting islands formed by the isoline.
request_input • IsolineRequestInput
The inputted request data for the isoline used to compute it.
Response
A response can either contain a data or an
errors object. The response header will always return
200 as a status code.
Data object
When successful, a data object will be returned with the
requested fields. If there are no fields present the
data object will return the operation name with the
appropriate return type. If the operation was a query, this output
will be an object of the schema’s query root type; if the operation
was a mutation, this output will be an object of the schema’s mutation
root type.
Error object
If unsuccessful, an errors object will be returned with
more details in the extensions object. The error object
can contain any of the following objects.
Error
ISOLINE_NOT_FOUND
No isoline label was found with the provided ID.
Error
OPERATION_NOT_ALLOWED
You are not allowed to execute this operation. Enable it for the current application in the dashboard or reach out to customer support.