Subscribe device(s) to a geofenceId

1min
PUT
http://{base_url}/core/api/v1/mts/geofences/{geofenceId}/devices
This endpoint is used to subsceibe device(s) to a particular geofenceId. User can use the same API to override the details if they wish to update them for a specific geofenceId and deviceId.
Path Parameters
geofenceId
string
*
Header Parameters
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-REQUEST-ID
string
*
X-COREOS-USERINFO
string
Body Parameters
body
SubscribeGeofenceConfig
*
deviceId
string[]
*
expiry
string
geofenceType
string
callback
object
*
Responses
200
OK - The request succeeded.
GeofenceSubscribeResponse
request
Request
error
Error
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
*
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
*
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
*
request
Request
*
data
ID
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'http://{base_url}/core/api/v1/mts/geofences/{geofenceId}/devices' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "deviceId": [
    ""
  ],
  "callback": {
    "url": ""
  }
}'
curl --location --globoff --request PUT 'http://{base_url}/core/api/v1/mts/geofences/{geofenceId}/devices' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "deviceId": [
    ""
  ],
  "callback": {
    "url": ""
  }
}'
Responses
200
400
401
503
// OK - The request succeeded. 
{
  "request": {
    "body": {},
    "queryString": "",
    "uri": ""
  },
  "error": {
    "additionalInfo": {},
    "code": 0,
    "description": ""
  },
  "data": {
    "message": "",
    "errorReason": {}
  }
}
// OK - The request succeeded. 
{
  "request": {
    "body": {},
    "queryString": "",
    "uri": ""
  },
  "error": {
    "additionalInfo": {},
    "code": 0,
    "description": ""
  },
  "data": {
    "message": "",
    "errorReason": {}
  }
}
﻿
﻿
Updated 20 Sep 2024
Did this page help you?
Get Geofence using externalRefId
fetch devices subscribed to geofenceId