1NCE Device Locator API is one of 22 APIs that 1NCE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Device Locator. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.
This API exposes
8 operations
across 5 paths,
and defines 39 schemas.
It is described by OpenAPI 3.0.1, at version v2.1.1.
Requests are made against a single base URL, https://api.1nce.com/management-api.
8 operations5 paths39 schemas1 DELETE5 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
1NCE Device Locator API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuthentication).
BasicAuthentication — Basic authentication used for obtaining the Bearer Authentication Token. The Bearer Token can then be used to make any further API calls towards the 1NCE API.
Paths & Operations 8
Across 5 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Device Locator 8
Get device positions and manage geofences
GET
/v1/locate/devices/{deviceId}/positions
Get Device Positions
8 params→ 200400401403500
GET
/v1/locate/positions/latest
Get Latest Devices Positions
11 params→ 200400401403500
GET
/v1/locate/devices/{deviceId}/activity
Get Device Celltower location resolutions
3 params→ 200400401403500
GET
/v1/locate/geofences
Get all geofences
5 params→ 200400500
POST
/v1/locate/geofences
Create geofence
body→ 201400401403500
DELETE
/v1/locate/geofences/{geofenceId}
Delete geofence
1 param→ 204404500
GET
/v1/locate/geofences/{geofenceId}
Get a geofence
1 param→ 200404500
PATCH
/v1/locate/geofences/{geofenceId}
Patch a geofence
1 parambody→ 200400404500
Schemas 39
The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are patchGeofenceResponseschema_oneOf_1 (10 properties), CircleGeofenceData (10 properties), patchGeofenceResponseschema_oneOf (9 properties), PolygonGeofenceData (9 properties). Each schema is shown below with its type and property counts.
EventTypes
array
The event types to register to. Defaults to [ENTER, EXIT]
Radius
number
Circle geofence radius in meters
getGeofenceResponseschema
Response to get geofence request.
postGeofenceResponseschema
Response to post geofence request.
patchGeofenceResponseschema
Patch request geofence response.
DeviceId
The device for which this Geofence is bound to
getResponseschema_8_coordinates_inner
object
4 properties3 required
postschema_5
object
Request to create a geofence.
Coordinates
array
The polygon geofence coordinates
patchschema_1
object
Request to update a geofence.
3 properties
GenericGeofenceData
object
6 properties6 required
CreateCircleGeofence
object
7 properties3 required
getResponseschema_8
object
Get positions of a specific device.
3 properties3 required
patchGeofenceResponseschema_oneOf
object
9 properties8 required
CircleGeofenceData
object
10 properties10 required
getResponseschema_9_items_inner_towerLocation
object
Coordinates of the specific celltower
2 properties
unauthorizedRequestResponse
object
An API error response in case of an HTTP Unauthorized Request.
3 properties
notFoundResponse
object
An API error response when a resource is Not Found.
3 properties
getLatestResponseschema
object
Get latest positions of customer devices.
3 properties3 required
getAllGeofenceResponseschema
object
Response to get all geofences request.
3 properties3 required
EventSources
array
The sources of coordinates to evaluate towards geofence. Defaults to [GPS, CellTower]
CreatePolygonGeofence
object
6 properties3 required
getResponseschema_9
object
Get Cell location resolutions for one device (maximum of last 7 days).
1 property1 required
getResponseschema_9_items_inner
object
8 properties5 required
Updated
string
When the Geofence was last updated
PolygonGeofenceData
object
9 properties9 required
Type
string
The type of Geofence
getResponseschema_9_items_inner_towerMetadata
object
Identifier attributes of the tower
4 properties
patchGeofenceResponseschema_oneOf_1
object
10 properties9 required
Name
string
The name of the geofence
serverErrorResponse
object
An API error response in case of a Server Side Error.
2 properties
getLatestResponseschema_coordinates_inner
object
5 properties4 required
Id
string
Identifier of the geofence
postGeofenceResponseschema_oneOf
object
7 properties7 required
Created
string
When the Geofence was created
postGeofenceResponseschema_oneOf_1
object
8 properties8 required
Center
array
The coordinates of the center of the geofence (long, lat)
badRequestResponse
object
An API error response in case of an HTTP Bad Request.
3 properties
forbiddenResponse
object
An API error response in case of an HTTP Forbidden Request.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
