For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Nukio API
    • Authentication
    • Device
    • User
    • Geozone
      • GETgetGeozones
      • POSTcreateGeozone
      • POSTdeleteGeozone
      • POSTupdateGeozone
      • GETgetGeozone
      • GETgetGeozones range
    • Fleets
    • Notifications
    • Routes
    • Passengers
    • Account Status
    • Nukio SDK
LogoLogo
Nukio APIGeozone

getGeozones

||View as Markdown|
GET
https://app.nukio.mx/api/v1/geozone/getgeozones/authorization
GET
/api/v1/geozone/getgeozones/authorization
$curl https://app.nukio.mx/api/v1/geozone/getgeozones/authorization \
>     -H "authorization: <apiKey>"
200Geozone_getGeozones_example
1{
2  "success": "1",
3  "geozones": [
4    {
5      "features": {
6        "cargoaccess": {
7          "states": {
8            "0": "Disallowed",
9            "1": "Allowed"
10          },
11          "displayText": "Cargo Access"
12        },
13        "enginecutoff": {
14          "states": {
15            "0": "Disabled",
16            "1": "Enabled"
17          },
18          "displayText": "Engine Cutoff"
19        }
20      },
21      "sections": {
22        "arrive": {
23          "features": {
24            "cargoaccess": {
25              "state": "1",
26              "onText": "on",
27              "offText": "off",
28              "displayName": "Cargo Access",
29              "isNegativeTriggered": false
30            },
31            "enginecutoff": {
32              "state": "1",
33              "onText": "on",
34              "offText": "off",
35              "displayName": "Engine Cutoff",
36              "isNegativeTriggered": false
37            }
38          },
39          "displayText": "Arrival"
40        },
41        "depart": {
42          "features": {
43            "cargoaccess": {
44              "state": "0",
45              "onText": "on",
46              "offText": "off",
47              "displayName": "Cargo Access",
48              "isNegativeTriggered": false
49            },
50            "enginecutoff": {
51              "state": "1",
52              "onText": "on",
53              "offText": "off",
54              "displayName": "Engine Cutoff",
55              "isNegativeTriggered": false
56            }
57          },
58          "displayText": "Departure"
59        }
60      },
61      "geozoneID": "basenorth",
62      "geozoneType": 3,
63      "geozonePoint1": "30.39918,-97.73626",
64      "geozonePoint2": "30.39880,-97.73295",
65      "geozonePoint3": "30.39594,-97.73157",
66      "geozonePoint4": "30.39308,-97.73295",
67      "geozonePoint5": "30.39270,-97.73626",
68      "geozonePoint6": "30.39308,-97.73958",
69      "geozonePoint7": "30.39594,-97.74096",
70      "geozonePoint8": "30.39880,-97.73958",
71      "geozoneRadius": 500,
72      "geozoneAlertExit": true,
73      "geozoneAlertEntry": true,
74      "geozoneDisplayName": "",
75      "geozoneArrivalEngineOn": false,
76      "geozoneArrivalCabinLock": false,
77      "geozoneArrivalCargoLock": false,
78      "geozoneArrivalEngineOff": true,
79      "geozoneDepartureEngineOn": false,
80      "geozoneArrivalCabinUnlock": true,
81      "geozoneArrivalCargoUnlock": true,
82      "geozoneDepartureCabinLock": true,
83      "geozoneDepartureCargoLock": true,
84      "geozoneDepartureEngineOff": true,
85      "geozoneDepartureCabinUnlock": false,
86      "geozoneDepartureCargoUnlock": false
87    },
88    {
89      "features": {
90        "cargoaccess": {
91          "states": {
92            "0": "Disallowed",
93            "1": "Allowed"
94          },
95          "displayText": "Cargo Access"
96        },
97        "enginecutoff": {
98          "states": {
99            "0": "Disabled",
100            "1": "Enabled"
101          },
102          "displayText": "Engine Cutoff"
103        }
104      },
105      "sections": {
106        "arrive": {
107          "features": {
108            "cargoaccess": {
109              "state": "1",
110              "onText": "on",
111              "offText": "off",
112              "displayName": "Cargo Access",
113              "isNegativeTriggered": false
114            },
115            "enginecutoff": {
116              "state": "1",
117              "onText": "on",
118              "offText": "off",
119              "displayName": "Engine Cutoff",
120              "isNegativeTriggered": false
121            }
122          },
123          "displayText": "Arrival"
124        },
125        "depart": {
126          "features": {
127            "cargoaccess": {
128              "state": "string",
129              "onText": "on",
130              "offText": "off",
131              "displayName": "Cargo Access",
132              "isNegativeTriggered": false
133            },
134            "enginecutoff": {
135              "state": "string",
136              "onText": "on",
137              "offText": "off",
138              "displayName": "Engine Cutoff",
139              "isNegativeTriggered": false
140            }
141          },
142          "displayText": "Departure"
143        }
144      },
145      "geozoneID": "fuelquest",
146      "geozoneType": 0,
147      "geozonePoint1": "29.73251,-95.43456",
148      "geozonePoint2": "0.00000,0.00000",
149      "geozonePoint3": "0.00000,0.00000",
150      "geozonePoint4": "0.00000,0.00000",
151      "geozonePoint5": "0.00000,0.00000",
152      "geozonePoint6": "0.00000,0.00000",
153      "geozonePoint7": "0.00000,0.00000",
154      "geozonePoint8": "0.00000,0.00000",
155      "geozoneRadius": 400,
156      "geozoneAlertExit": false,
157      "geozoneAlertEntry": false,
158      "geozoneDisplayName": "",
159      "geozoneArrivalEngineOn": false,
160      "geozoneArrivalCabinLock": false,
161      "geozoneArrivalCargoLock": false,
162      "geozoneArrivalEngineOff": true,
163      "geozoneDepartureEngineOn": false,
164      "geozoneArrivalCabinUnlock": false,
165      "geozoneArrivalCargoUnlock": true,
166      "geozoneDepartureCabinLock": false,
167      "geozoneDepartureCargoLock": false,
168      "geozoneDepartureEngineOff": false,
169      "geozoneDepartureCabinUnlock": false,
170      "geozoneDepartureCargoUnlock": false
171    },
172    {
173      "features": {
174        "cargoaccess": {
175          "states": {
176            "0": "Disallowed",
177            "1": "Allowed"
178          },
179          "displayText": "Cargo Access"
180        },
181        "enginecutoff": {
182          "states": {
183            "0": "Disabled",
184            "1": "Enabled"
185          },
186          "displayText": "Engine Cutoff"
187        }
188      },
189      "sections": {
190        "arrive": {
191          "features": {
192            "cargoaccess": {
193              "state": "string",
194              "onText": "on",
195              "offText": "off",
196              "displayName": "Cargo Access",
197              "isNegativeTriggered": false
198            },
199            "enginecutoff": {
200              "state": "string",
201              "onText": "on",
202              "offText": "off",
203              "displayName": "Engine Cutoff",
204              "isNegativeTriggered": false
205            }
206          },
207          "displayText": "Arrival"
208        },
209        "depart": {
210          "features": {
211            "cargoaccess": {
212              "state": "1",
213              "onText": "on",
214              "offText": "off",
215              "displayName": "Cargo Access",
216              "isNegativeTriggered": false
217            },
218            "enginecutoff": {
219              "state": "string",
220              "onText": "on",
221              "offText": "off",
222              "displayName": "Engine Cutoff",
223              "isNegativeTriggered": false
224            }
225          },
226          "displayText": "Departure"
227        }
228      },
229      "geozoneID": "geozona_de_prueba",
230      "geozoneType": 3,
231      "geozonePoint1": "25.67223,-100.30978",
232      "geozonePoint2": "25.67213,-100.30888",
233      "geozonePoint3": "25.66993,-100.30916",
234      "geozonePoint4": "25.66747,-100.30958",
235      "geozonePoint5": "25.66475,-100.31029",
236      "geozonePoint6": "25.66571,-100.31435",
237      "geozonePoint7": "25.66829,-100.31373",
238      "geozonePoint8": "25.66776,-100.31072",
239      "geozoneRadius": 500,
240      "geozoneAlertExit": false,
241      "geozoneAlertEntry": false,
242      "geozoneDisplayName": "",
243      "geozoneArrivalEngineOn": false,
244      "geozoneArrivalCabinLock": false,
245      "geozoneArrivalCargoLock": false,
246      "geozoneArrivalEngineOff": false,
247      "geozoneDepartureEngineOn": false,
248      "geozoneArrivalCabinUnlock": false,
249      "geozoneArrivalCargoUnlock": false,
250      "geozoneDepartureCabinLock": false,
251      "geozoneDepartureCargoLock": false,
252      "geozoneDepartureEngineOff": false,
253      "geozoneDepartureCabinUnlock": false,
254      "geozoneDepartureCargoUnlock": true
255    },
256    {
257      "features": {
258        "cargoaccess": {
259          "states": {
260            "0": "Disallowed",
261            "1": "Allowed"
262          },
263          "displayText": "Cargo Access"
264        },
265        "enginecutoff": {
266          "states": {
267            "0": "Disabled",
268            "1": "Enabled"
269          },
270          "displayText": "Engine Cutoff"
271        }
272      },
273      "sections": {
274        "arrive": {
275          "features": {
276            "cargoaccess": {
277              "state": "string",
278              "onText": "on",
279              "offText": "off",
280              "displayName": "Cargo Access",
281              "isNegativeTriggered": false
282            },
283            "enginecutoff": {
284              "state": "string",
285              "onText": "on",
286              "offText": "off",
287              "displayName": "Engine Cutoff",
288              "isNegativeTriggered": false
289            }
290          },
291          "displayText": "Arrival"
292        },
293        "depart": {
294          "features": {
295            "cargoaccess": {
296              "state": "1",
297              "onText": "on",
298              "offText": "off",
299              "displayName": "Cargo Access",
300              "isNegativeTriggered": false
301            },
302            "enginecutoff": {
303              "state": "1",
304              "onText": "on",
305              "offText": "off",
306              "displayName": "Engine Cutoff",
307              "isNegativeTriggered": false
308            }
309          },
310          "displayText": "Departure"
311        }
312      },
313      "geozoneID": "nuve-ati-2013",
314      "geozoneType": 3,
315      "geozonePoint1": "30.39707,-97.73583",
316      "geozonePoint2": "30.39617,-97.73387",
317      "geozonePoint3": "30.39563,-97.73378",
318      "geozonePoint4": "30.39408,-97.73462",
319      "geozonePoint5": "30.39374,-97.73538",
320      "geozonePoint6": "30.39408,-97.73645",
321      "geozonePoint7": "30.39537,-97.73712",
322      "geozonePoint8": "30.39636,-97.73683",
323      "geozoneRadius": 3000,
324      "geozoneAlertExit": false,
325      "geozoneAlertEntry": false,
326      "geozoneDisplayName": "",
327      "geozoneArrivalEngineOn": false,
328      "geozoneArrivalCabinLock": false,
329      "geozoneArrivalCargoLock": false,
330      "geozoneArrivalEngineOff": false,
331      "geozoneDepartureEngineOn": false,
332      "geozoneArrivalCabinUnlock": false,
333      "geozoneArrivalCargoUnlock": false,
334      "geozoneDepartureCabinLock": false,
335      "geozoneDepartureCargoLock": false,
336      "geozoneDepartureEngineOff": true,
337      "geozoneDepartureCabinUnlock": true,
338      "geozoneDepartureCargoUnlock": true
339    },
340    {
341      "features": {
342        "cargoaccess": {
343          "states": {
344            "0": "Disallowed",
345            "1": "Allowed"
346          },
347          "displayText": "Cargo Access"
348        },
349        "enginecutoff": {
350          "states": {
351            "0": "Disabled",
352            "1": "Enabled"
353          },
354          "displayText": "Engine Cutoff"
355        }
356      },
357      "sections": {
358        "arrive": {
359          "features": {
360            "cargoaccess": {
361              "state": "string",
362              "onText": "on",
363              "offText": "off",
364              "displayName": "Cargo Access",
365              "isNegativeTriggered": false
366            },
367            "enginecutoff": {
368              "state": "string",
369              "onText": "on",
370              "offText": "off",
371              "displayName": "Engine Cutoff",
372              "isNegativeTriggered": false
373            }
374          },
375          "displayText": "Arrival"
376        },
377        "depart": {
378          "features": {
379            "cargoaccess": {
380              "state": "string",
381              "onText": "on",
382              "offText": "off",
383              "displayName": "Cargo Access",
384              "isNegativeTriggered": false
385            },
386            "enginecutoff": {
387              "state": "string",
388              "onText": "on",
389              "offText": "off",
390              "displayName": "Engine Cutoff",
391              "isNegativeTriggered": false
392            }
393          },
394          "displayText": "Departure"
395        }
396      },
397      "geozoneID": "prueba",
398      "geozoneType": 3,
399      "geozonePoint1": "22.37620,-97.90095",
400      "geozonePoint2": "0.00000,0.00000",
401      "geozonePoint3": "0.00000,0.00000",
402      "geozonePoint4": "0.00000,0.00000",
403      "geozonePoint5": "0.00000,0.00000",
404      "geozonePoint6": "0.00000,0.00000",
405      "geozonePoint7": "0.00000,0.00000",
406      "geozonePoint8": "0.00000,0.00000",
407      "geozoneRadius": 3000,
408      "geozoneAlertExit": false,
409      "geozoneAlertEntry": false,
410      "geozoneDisplayName": "",
411      "geozoneArrivalEngineOn": false,
412      "geozoneArrivalCabinLock": false,
413      "geozoneArrivalCargoLock": false,
414      "geozoneArrivalEngineOff": false,
415      "geozoneDepartureEngineOn": false,
416      "geozoneArrivalCabinUnlock": false,
417      "geozoneArrivalCargoUnlock": false,
418      "geozoneDepartureCabinLock": false,
419      "geozoneDepartureCargoLock": false,
420      "geozoneDepartureEngineOff": false,
421      "geozoneDepartureCabinUnlock": false,
422      "geozoneDepartureCargoUnlock": false
423    },
424    {
425      "features": {
426        "cargoaccess": {
427          "states": {
428            "0": "Disallowed",
429            "1": "Allowed"
430          },
431          "displayText": "Cargo Access"
432        },
433        "enginecutoff": {
434          "states": {
435            "0": "Disabled",
436            "1": "Enabled"
437          },
438          "displayText": "Engine Cutoff"
439        }
440      },
441      "sections": {
442        "arrive": {
443          "features": {
444            "cargoaccess": {
445              "state": "0",
446              "onText": "on",
447              "offText": "off",
448              "displayName": "Cargo Access",
449              "isNegativeTriggered": false
450            },
451            "enginecutoff": {
452              "state": "string",
453              "onText": "on",
454              "offText": "off",
455              "displayName": "Engine Cutoff",
456              "isNegativeTriggered": false
457            }
458          },
459          "displayText": "Arrival"
460        },
461        "depart": {
462          "features": {
463            "cargoaccess": {
464              "state": "1",
465              "onText": "on",
466              "offText": "off",
467              "displayName": "Cargo Access",
468              "isNegativeTriggered": false
469            },
470            "enginecutoff": {
471              "state": "string",
472              "onText": "on",
473              "offText": "off",
474              "displayName": "Engine Cutoff",
475              "isNegativeTriggered": false
476            }
477          },
478          "displayText": "Departure"
479        }
480      },
481      "geozoneID": "prueba-plataforma",
482      "geozoneType": 3,
483      "geozonePoint1": "30.35406,-97.75017",
484      "geozonePoint2": "30.35379,-97.74981",
485      "geozonePoint3": "30.35336,-97.74990",
486      "geozonePoint4": "30.35298,-97.75017",
487      "geozonePoint5": "30.35300,-97.75027",
488      "geozonePoint6": "30.35308,-97.75043",
489      "geozonePoint7": "30.35317,-97.75059",
490      "geozonePoint8": "30.35324,-97.75073",
491      "geozoneRadius": 500,
492      "geozoneAlertExit": false,
493      "geozoneAlertEntry": false,
494      "geozoneDisplayName": "",
495      "geozoneArrivalEngineOn": false,
496      "geozoneArrivalCabinLock": false,
497      "geozoneArrivalCargoLock": true,
498      "geozoneArrivalEngineOff": false,
499      "geozoneDepartureEngineOn": false,
500      "geozoneArrivalCabinUnlock": false,
501      "geozoneArrivalCargoUnlock": false,
502      "geozoneDepartureCabinLock": false,
503      "geozoneDepartureCargoLock": false,
504      "geozoneDepartureEngineOff": false,
505      "geozoneDepartureCabinUnlock": false,
506      "geozoneDepartureCargoUnlock": true
507    },
508    {
509      "features": {
510        "cargoaccess": {
511          "states": {
512            "0": "Disallowed",
513            "1": "Allowed"
514          },
515          "displayText": "Cargo Access"
516        },
517        "enginecutoff": {
518          "states": {
519            "0": "Disabled",
520            "1": "Enabled"
521          },
522          "displayText": "Engine Cutoff"
523        }
524      },
525      "sections": {
526        "arrive": {
527          "features": {
528            "cargoaccess": {
529              "state": "string",
530              "onText": "on",
531              "offText": "off",
532              "displayName": "Cargo Access",
533              "isNegativeTriggered": false
534            },
535            "enginecutoff": {
536              "state": "string",
537              "onText": "on",
538              "offText": "off",
539              "displayName": "Engine Cutoff",
540              "isNegativeTriggered": false
541            }
542          },
543          "displayText": "Arrival"
544        },
545        "depart": {
546          "features": {
547            "cargoaccess": {
548              "state": "string",
549              "onText": "on",
550              "offText": "off",
551              "displayName": "Cargo Access",
552              "isNegativeTriggered": false
553            },
554            "enginecutoff": {
555              "state": "string",
556              "onText": "on",
557              "offText": "off",
558              "displayName": "Engine Cutoff",
559              "isNegativeTriggered": false
560            }
561          },
562          "displayText": "Departure"
563        }
564      },
565      "geozoneID": "pruebaplatafo",
566      "geozoneType": 3,
567      "geozonePoint1": "25.57148,-103.41874",
568      "geozonePoint2": "25.57144,-103.41857",
569      "geozonePoint3": "25.57121,-103.41823",
570      "geozonePoint4": "25.57067,-103.41872",
571      "geozonePoint5": "25.57030,-103.41911",
572      "geozonePoint6": "25.57054,-103.41943",
573      "geozonePoint7": "25.57082,-103.41956",
574      "geozonePoint8": "25.57123,-103.41905",
575      "geozoneRadius": 3000,
576      "geozoneAlertExit": true,
577      "geozoneAlertEntry": true,
578      "geozoneDisplayName": "",
579      "geozoneArrivalEngineOn": false,
580      "geozoneArrivalCabinLock": false,
581      "geozoneArrivalCargoLock": false,
582      "geozoneArrivalEngineOff": false,
583      "geozoneDepartureEngineOn": false,
584      "geozoneArrivalCabinUnlock": false,
585      "geozoneArrivalCargoUnlock": false,
586      "geozoneDepartureCabinLock": false,
587      "geozoneDepartureCargoLock": false,
588      "geozoneDepartureEngineOff": false,
589      "geozoneDepartureCabinUnlock": false,
590      "geozoneDepartureCargoUnlock": false
591    },
592    {
593      "features": {
594        "cargoaccess": {
595          "states": {
596            "0": "Disallowed",
597            "1": "Allowed"
598          },
599          "displayText": "Cargo Access"
600        },
601        "enginecutoff": {
602          "states": {
603            "0": "Disabled",
604            "1": "Enabled"
605          },
606          "displayText": "Engine Cutoff"
607        }
608      },
609      "sections": {
610        "arrive": {
611          "features": {
612            "cargoaccess": {
613              "state": "0",
614              "onText": "on",
615              "offText": "off",
616              "displayName": "Cargo Access",
617              "isNegativeTriggered": false
618            },
619            "enginecutoff": {
620              "state": "0",
621              "onText": "on",
622              "offText": "off",
623              "displayName": "Engine Cutoff",
624              "isNegativeTriggered": false
625            }
626          },
627          "displayText": "Arrival"
628        },
629        "depart": {
630          "features": {
631            "cargoaccess": {
632              "state": "0",
633              "onText": "on",
634              "offText": "off",
635              "displayName": "Cargo Access",
636              "isNegativeTriggered": false
637            },
638            "enginecutoff": {
639              "state": "0",
640              "onText": "on",
641              "offText": "off",
642              "displayName": "Engine Cutoff",
643              "isNegativeTriggered": false
644            }
645          },
646          "displayText": "Departure"
647        }
648      },
649      "geozoneID": "testzone1",
650      "geozoneType": 3,
651      "geozonePoint1": "30.39918,-97.73626",
652      "geozonePoint2": "30.39880,-97.73295",
653      "geozonePoint3": "30.39594,-97.73157",
654      "geozonePoint4": "30.39308,-97.73295",
655      "geozonePoint5": "30.39270,-97.73626",
656      "geozonePoint6": "30.39308,-97.73958",
657      "geozonePoint7": "30.39594,-97.74096",
658      "geozonePoint8": "30.39880,-97.73958",
659      "geozoneRadius": 500,
660      "geozoneAlertExit": false,
661      "geozoneAlertEntry": false,
662      "geozoneDisplayName": "Test Zone 1",
663      "geozoneArrivalEngineOn": true,
664      "geozoneArrivalCabinLock": true,
665      "geozoneArrivalCargoLock": true,
666      "geozoneArrivalEngineOff": false,
667      "geozoneDepartureEngineOn": true,
668      "geozoneArrivalCabinUnlock": false,
669      "geozoneArrivalCargoUnlock": false,
670      "geozoneDepartureCabinLock": true,
671      "geozoneDepartureCargoLock": true,
672      "geozoneDepartureEngineOff": false,
673      "geozoneDepartureCabinUnlock": false,
674      "geozoneDepartureCargoUnlock": false
675    }
676  ],
677  "status_code": "200",
678  "hasUpdateGeozonePrivileges": true
679}
Was this page helpful?
Previous

Overview

Next

createGeozone

Built with

Authentication

authorizationstring
API Key authentication via header

Response headers

pragmastring
:statusstring
expiresstring
accept-rangesstring
cache-controlstring
x-frame-optionsstring
x-xss-protectionstring
x-application-contextstring
x-content-type-optionsstring

Response

OK
successstring
geozoneslist of objects
status_codestring
hasUpdateGeozonePrivilegesboolean