Geofence API is used to obtain the geofence and name for all MyGate communities which are enabled for a specific partner and can be utilized by the partner for local filtering of EARs.
As new communities are onboarded on MyGate frequently, the partner needs to call this API on a daily basis to maintain data consistency.
Base URLs API Endpoints & Summary Type Endpoint Description GET /partner/geofences Fetch geofence and society name enabled for Partner.
'x-api-key' is visible on Express Entry Dashboard.
Fetch Geofence Sample cURL Copy curl --location --request GET 'https://ecom.kappa.mgmaglev.xyz/delivery/devops-intg/partner/geofences?cityName=XxXxXx&validated=XxXxXx' \
--header 'x-api-key: XxXxXx'
Name Value Mandatory Description x-api-key XxXxXx Yes Partner access API key.
Query Parameters Name Type Mandatory Description cityName String No Fetch geofences for a particular city. validated String No Fetches only communities which have greater than 3 geo-points. Possible values are "yes" and "no.
Response Copy {
"es" : "Integer" ,
"message" : "String" ,
"data" : [
{
"geofence" : [
{
"latitude" : "Double" ,
"longitude" : "Double"
} ,
{
"latitude" : "Double" ,
"longitude" : "Double"
} ,
{
"latitude" : "Double" ,
"longitude" : "Double"
} ,
{
"latitude" : "Double" ,
"longitude" : "Double"
} ,
{
"latitude" : "Double" ,
"longitude" : "Double"
}
] ,
"societyName" : "String" ,
"cityName" : "String" ,
"gateLatLong" : [
{
"latitude" : "Double" ,
"longitude" : "Double"
}
] ,
"societyId" : "String"
}
]
}
Response Attributes Name Type Description es Integer Denotes error status. message String Success or failure message. data Array Contains list of partner enabled MyGate community geofences. geofence Array Geofence of a MyGate community in the form of a closed polygon. societyName String Name of MyGate community. cityName String City in which the MyGate community is located in. gateLatLong Array Array of the MyGate community gate locations. societyId String Unique identifier for each MyGate community. If required, need to be communicated to the team. latitude Double Latitude as part of geofence or gateLatLong array. longitude Double Longitude as part of geofence or gateLatLong array.
Possible Combinations of Error State and Message es message 1 Resource access denied. 1 Reason for exception 0 Success 0 No Society Enabled