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

getGeozone

||View as Markdown|
GET
https://app.nukio.mx/api/v1/geozone/getgeozone/:geozoneID/authorization
GET
/api/v1/geozone/getgeozone/:geozoneID/authorization
$curl https://app.nukio.mx/api/v1/geozone/getgeozone/basenorth/authorization \
>     -H "authorization: <apiKey>"
200Geozone_getGeozone_example
1{
2  "success": "1",
3  "features": {
4    "cargoaccess": {
5      "states": {
6        "0": "Disallowed",
7        "1": "Allowed"
8      },
9      "displayText": "Cargo Access"
10    },
11    "enginecutoff": {
12      "states": {
13        "0": "Disabled",
14        "1": "Enabled"
15      },
16      "displayText": "Engine Cutoff"
17    }
18  },
19  "sections": {
20    "arrive": {
21      "features": {
22        "cargoaccess": {
23          "state": "1",
24          "onText": "on",
25          "offText": "off",
26          "displayName": "Cargo Access",
27          "isNegativeTriggered": false
28        },
29        "enginecutoff": {
30          "state": "1",
31          "onText": "on",
32          "offText": "off",
33          "displayName": "Engine Cutoff",
34          "isNegativeTriggered": false
35        }
36      },
37      "displayText": "Arrival"
38    },
39    "depart": {
40      "features": {
41        "cargoaccess": {
42          "state": "0",
43          "onText": "on",
44          "offText": "off",
45          "displayName": "Cargo Access",
46          "isNegativeTriggered": false
47        },
48        "enginecutoff": {
49          "state": "1",
50          "onText": "on",
51          "offText": "off",
52          "displayName": "Engine Cutoff",
53          "isNegativeTriggered": false
54        }
55      },
56      "displayText": "Departure"
57    }
58  },
59  "geozoneID": "basenorth",
60  "geozoneType": 3,
61  "status_code": "200",
62  "geozonePoint1": "30.39918,-97.73626",
63  "geozonePoint2": "30.39880,-97.73295",
64  "geozonePoint3": "30.39594,-97.73157",
65  "geozonePoint4": "30.39308,-97.73295",
66  "geozonePoint5": "30.39270,-97.73626",
67  "geozonePoint6": "30.39308,-97.73958",
68  "geozonePoint7": "30.39594,-97.74096",
69  "geozonePoint8": "30.39880,-97.73958",
70  "geozoneRadius": 500,
71  "geozoneAlertExit": true,
72  "geozoneAlertEntry": true,
73  "geozoneDisplayName": "",
74  "geozoneArrivalEngineOn": false,
75  "geozoneArrivalCabinLock": false,
76  "geozoneArrivalCargoLock": false,
77  "geozoneArrivalEngineOff": true,
78  "geozoneDepartureEngineOn": false,
79  "geozoneArrivalCabinUnlock": true,
80  "geozoneArrivalCargoUnlock": true,
81  "geozoneDepartureCabinLock": true,
82  "geozoneDepartureCargoLock": true,
83  "geozoneDepartureEngineOff": true,
84  "hasUpdateGeozonePrivileges": true,
85  "geozoneDepartureCabinUnlock": false,
86  "geozoneDepartureCargoUnlock": false
87}
Was this page helpful?
Previous

updateGeozone

Next

getGeozones range

Built with

Authentication

authorizationstring
API Key authentication via header

Path parameters

geozoneIDstringRequired
Geozone ID name

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
featuresobject
sectionsobject
geozoneIDstring
geozoneTypeinteger
status_codestring
geozonePoint1string
geozonePoint2string
geozonePoint3string
geozonePoint4string
geozonePoint5string
geozonePoint6string
geozonePoint7string
geozonePoint8string
geozoneRadiusinteger
geozoneAlertExitboolean
geozoneAlertEntryboolean
geozoneDisplayNamestring
geozoneArrivalEngineOnboolean
geozoneArrivalCabinLockboolean
geozoneArrivalCargoLockboolean
geozoneArrivalEngineOffboolean
geozoneDepartureEngineOnboolean
geozoneArrivalCabinUnlockboolean
geozoneArrivalCargoUnlockboolean
geozoneDepartureCabinLockboolean
geozoneDepartureCargoLockboolean
geozoneDepartureEngineOffboolean
hasUpdateGeozonePrivilegesboolean
geozoneDepartureCabinUnlockboolean
geozoneDepartureCargoUnlockboolean