Subscribe to isolines
After you receive your isoline ID
through the isoline mutation, you can start an isoline subscription. The isoline will contain polygons with the coordinates to render each layer. Because isolines take some time to finish, you can use a GraphQL subscription as described in the introduction.
Subscription
To subscription service needs to be initiated with an isoline ID
. From there on it will start calculating and, based on your interval, provide you with an isoline status.
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
origin • FeatureMultiPolygonPoint
Origin point of the request
vehicle_id • ID
Vehicle id
polygon_count • Int
Number of Isolines to be generated representing SoC (default: 1, maximum: 20)
season • RouteSeason
Season to be taken into account when generating the isoline. Default: current
Show RouteSeason enum values
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.
ISOLINE_NOT_FOUND
No isoline label was found with the provided ID
ISOLINE_NOT_FOUND
No isoline label was found with the provided ID