Get Geofence using externalRefId

1min
GET
http://{base_url}/core/api/v1/mts/geofences/{externalRefId}
This endpoint is used to get a specific geofence (using a unique externalRefId).
Path Parameters
externalRefId
string
*
Header Parameters
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-REQUEST-ID
string
*
X-COREOS-USERINFO
string
Responses
200
OK - The request succeeded.
GeofenceDetailsResponse
request
Request
error
Error
data
GetGeofenceData
All Of
GeofenceConfig  +
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
404
Not found - The server can not find the requested resource.
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/{externalRefId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'http://{base_url}/core/api/v1/mts/geofences/{externalRefId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
503
// OK - The request succeeded. 
{
  "request": {
    "body": {},
    "queryString": "",
    "uri": ""
  },
  "error": {
    "additionalInfo": {},
    "code": 0,
    "description": ""
  },
  "data": {}
}
// OK - The request succeeded. 
{
  "request": {
    "body": {},
    "queryString": "",
    "uri": ""
  },
  "error": {
    "additionalInfo": {},
    "code": 0,
    "description": ""
  },
  "data": {}
}
﻿
﻿
Updated 20 Sep 2024
Did this page help you?
Get Geofence
Subscribe device(s) to a geofenceId