Movement Tracking Service
Geofence
Subscribe Device(s) to a GeofenceId
1min
PUT
http://{base_url}/core/api/v1/mts-geofences/{geofenceId}/devices
PATH PARAMETERS
geofenceId
string
*UUID of a specific geofence.
HEADER PARAMETERS
X-COREOS-TID
string
*Tenant ID.
X-COREOS-ACCESS
string
*Core-os access token.
X-COREOS-REQUEST-ID
string
*Unique RequestId.
X-COREOS-USERINFO
string
Core-os user info.
BODY PARAMETERS
body
SubscribeGeofenceConfig
*deviceId
string[]
*array of deviceIds that needs to be subscribed to a geofenceId. Min- 1, Max- 100
expiry
string
Example: 2d4h3m
Time after which the geofence-device mapping expires. Maximum allowed value is 60 days. If not provided, then geofence-device subscription will not expire. Example- 2hour -> 2h, 1day -> 1d, 50seconds -> 50s, 3hours,4mins,7s -> 3h4m7s
geofenceType
string
Example: entry
User can specify whether its an entry/exit type or both. If entry- notification will be sent out only upon entry, if exit- notification will be sent out only during exiting, if both- notification will be sent out both during entry and exit.
callback
object
*Callback details at which user will receive geofence notification
RESPONSES
200
OK - The request succeeded.
GeofenceSubscribeResponse
request
Request
error
Error
Error Information
data
SubscribeGeofenceResponse
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
*Error Information
request
Request
*data
ID
401
Unauthorized - The client's identity is unknown to the server. Verify that you are accessing the correct Tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
*Error Information
request
Request
*data
ID
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
*Error Information
request
Request
*data
ID


Updated 10 Nov 2023
Did this page help you?