Creates Geofence

1min
POST
http://{base_url}/core/api/v1/mts/geofences/
This endpoint is used to create a new geofence entry in the database for which the notification is to be sent when the GPS device approaches the location.
Header Parameters
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-REQUEST-ID
string
*
X-COREOS-USERINFO
string
Body Parameters
body
CreateGeofenceRequest
*
All Of
GeofenceConfig  +
name
string
*
geojson
object
*
description
string
externalRefId
string
expiry
string
Responses
201
OK - The request succeeded.
GeofenceCreationResponse
request
Request
error
Error
data
GeofenceID
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 'http://{base_url}/core/api/v1/mts/geofences/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "",
  "geojson": {}
}'
curl --location --globoff 'http://{base_url}/core/api/v1/mts/geofences/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "",
  "geojson": {}
}'
Responses
201
400
401
503
// OK - The request succeeded. 
{
  "request": {
    "body": {},
    "queryString": "",
    "uri": ""
  },
  "error": {
    "additionalInfo": {},
    "code": 0,
    "description": ""
  },
  "data": {
    "geofenceId": "3e3d63c5-9db4-11eb-9534-f80dac4a6ad0"
  }
}
// OK - The request succeeded. 
{
  "request": {
    "body": {},
    "queryString": "",
    "uri": ""
  },
  "error": {
    "additionalInfo": {},
    "code": 0,
    "description": ""
  },
  "data": {
    "geofenceId": "3e3d63c5-9db4-11eb-9534-f80dac4a6ad0"
  }
}
﻿
﻿
Updated 20 Sep 2024
Did this page help you?
unsubscribe device subscribed to geofenceId
Deactivate/reactivate geofence