Customer API

API change history

Update an existing geofence

Updates an existing geofence by its Id.

Try it

Request

Request URL

Request parameters

  • integer

    Format - int64.

  • (optional)
    boolean

    Use metric system or not.

  • (optional)
    boolean

    Should address be geocoded or not.

Request headers

  • (optional)
    integer

    CustomerAPI minor version

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "GeofenceId": 0,
  "Name": "string",
  "Type": "string",
  "Shape": 0,
  "Address": {
    "LatLon": {
      "Latitude": 0.0,
      "Longitude": 0.0
    },
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "RegionName": "string",
    "PostalCode": "string",
    "CountryCode": "string",
    "SubRegionName": "string",
    "SubRegionCode": "string",
    "RegionCode": "string"
  },
  "Radius": 0.0,
  "UseGeofenceAddress": true
}
{
  "type": "object",
  "properties": {
    "GeofenceId": {
      "format": "int64",
      "description": "Id of the Geofence of the GeofenceUpdateApiModel.",
      "type": "integer"
    },
    "Name": {
      "description": "Name of the GeofenceApiModelBase.",
      "type": "string"
    },
    "Type": {
      "description": "Type of the GeofenceApiModel.",
      "type": "string"
    },
    "Shape": {
      "format": "int32",
      "description": "Shape of the GeofenceApiModel.",
      "enum": [
        0,
        1
      ],
      "type": "integer"
    },
    "Address": {
      "type": "object",
      "properties": {
        "LatLon": {
          "type": "object",
          "properties": {
            "Latitude": {
              "format": "double",
              "type": "number"
            },
            "Longitude": {
              "format": "double",
              "type": "number"
            }
          },
          "description": "GPS Location associated with the start of this LocationApiModel."
        },
        "AddressLine1": {
          "description": "AddressLine1 of this LocationApiModel.",
          "type": "string"
        },
        "AddressLine2": {
          "description": "AddressLine1 of this LocationApiModel.",
          "type": "string"
        },
        "City": {
          "description": "City of the LocationApiModel.",
          "type": "string"
        },
        "RegionName": {
          "description": "Region Name of the LocationApiModel.",
          "type": "string"
        },
        "PostalCode": {
          "description": "Postal Code of the LocationApiModel.",
          "type": "string"
        },
        "CountryCode": {
          "description": "ISO 3166-1 alpha-2 code.",
          "type": "string"
        },
        "SubRegionName": {
          "description": "SubRegion of the LocationApiModel.",
          "type": "string"
        },
        "SubRegionCode": {
          "description": "SubRegion Code of the LocationApiModel.",
          "type": "string"
        },
        "RegionCode": {
          "description": "Region Code of the LocationApiModel.",
          "type": "string"
        }
      },
      "description": "LocationApiModel of the GeofenceApiModel."
    },
    "Radius": {
      "format": "double",
      "description": "Radius of the GeofenceApiModel.",
      "type": "number"
    },
    "UseGeofenceAddress": {
      "description": "UseGeofenceAddress of the GeofenceApiModel.",
      "type": "boolean"
    }
  }
}
{
  "GeofenceId": 0,
  "Name": "string",
  "Type": "string",
  "Shape": 0,
  "Address": {
    "LatLon": {
      "Latitude": 0.0,
      "Longitude": 0.0
    },
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "RegionName": "string",
    "PostalCode": "string",
    "CountryCode": "string",
    "SubRegionName": "string",
    "SubRegionCode": "string",
    "RegionCode": "string"
  },
  "Radius": 0.0,
  "UseGeofenceAddress": true
}
{
  "type": "object",
  "properties": {
    "GeofenceId": {
      "format": "int64",
      "description": "Id of the Geofence of the GeofenceUpdateApiModel.",
      "type": "integer"
    },
    "Name": {
      "description": "Name of the GeofenceApiModelBase.",
      "type": "string"
    },
    "Type": {
      "description": "Type of the GeofenceApiModel.",
      "type": "string"
    },
    "Shape": {
      "format": "int32",
      "description": "Shape of the GeofenceApiModel.",
      "enum": [
        0,
        1
      ],
      "type": "integer"
    },
    "Address": {
      "type": "object",
      "properties": {
        "LatLon": {
          "type": "object",
          "properties": {
            "Latitude": {
              "format": "double",
              "type": "number"
            },
            "Longitude": {
              "format": "double",
              "type": "number"
            }
          },
          "description": "GPS Location associated with the start of this LocationApiModel."
        },
        "AddressLine1": {
          "description": "AddressLine1 of this LocationApiModel.",
          "type": "string"
        },
        "AddressLine2": {
          "description": "AddressLine1 of this LocationApiModel.",
          "type": "string"
        },
        "City": {
          "description": "City of the LocationApiModel.",
          "type": "string"
        },
        "RegionName": {
          "description": "Region Name of the LocationApiModel.",
          "type": "string"
        },
        "PostalCode": {
          "description": "Postal Code of the LocationApiModel.",
          "type": "string"
        },
        "CountryCode": {
          "description": "ISO 3166-1 alpha-2 code.",
          "type": "string"
        },
        "SubRegionName": {
          "description": "SubRegion of the LocationApiModel.",
          "type": "string"
        },
        "SubRegionCode": {
          "description": "SubRegion Code of the LocationApiModel.",
          "type": "string"
        },
        "RegionCode": {
          "description": "Region Code of the LocationApiModel.",
          "type": "string"
        }
      },
      "description": "LocationApiModel of the GeofenceApiModel."
    },
    "Radius": {
      "format": "double",
      "description": "Radius of the GeofenceApiModel.",
      "type": "number"
    },
    "UseGeofenceAddress": {
      "description": "UseGeofenceAddress of the GeofenceApiModel.",
      "type": "boolean"
    }
  }
}

Responses

200 OK

OK

Representations

{}
{
  "type": "object"
}
{}
{
  "type": "object"
}
<GeofencesV1GeofencesIdPut200ApplicationXmlResponse />
{
  "type": "object"
}
<GeofencesV1GeofencesIdPut200TextXmlResponse />
{
  "type": "object"
}

204 No Content

Geofence has been updated.

400 Bad Request

Invalid request from the client. Example: missing required parameter for GET method (which is not part of resource name, the latter will result in 404 error). 400 error should be accompanied by error code returned in the body (see format below).

Representations

[
  {
    "Code": 1,
    "Message": "Geofence name is not unique."
  },
  {
    "Code": 2,
    "Message": "Geofence is already deleted."
  },
  {
    "Code": 3,
    "Message": "Geofence type is not found."
  },
  {
    "Code": 4,
    "Message": "Unsupported shape type."
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}
[
  {
    "Code": 0,
    "Message": "string"
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}
<CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-98>
  <Code>0</Code>
  <Message>string</Message>
</CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-98>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}
<CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-99>
  <Code>0</Code>
  <Message>string</Message>
</CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-99>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}

401 Unauthorized

Unauthorized request.

404 Not Found

Geofence not found.

Representations

[
  {
    "Code": 1,
    "Message": "Geofence name is not unique."
  },
  {
    "Code": 2,
    "Message": "Geofence is already deleted."
  },
  {
    "Code": 3,
    "Message": "Geofence type is not found."
  },
  {
    "Code": 4,
    "Message": "Unsupported shape type."
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}
[
  {
    "Code": 0,
    "Message": "string"
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}
<CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-102>
  <Code>0</Code>
  <Message>string</Message>
</CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-102>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}
<CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-103>
  <Code>0</Code>
  <Message>string</Message>
</CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-103>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}

422 Unprocessable Entity

Not all methods will return code 422. Please see description of common patterns to see if 422 status code is expected (GET single item, GET lists, GET polling triggers, POST entity, PUT entity, DELETE entity, custom actions). 422 error should be accompanied by error code returned in the body (see format below).

Representations

[
  {
    "Code": 1,
    "Message": "Geofence name is not unique."
  },
  {
    "Code": 2,
    "Message": "Geofence is already deleted."
  },
  {
    "Code": 3,
    "Message": "Geofence type is not found."
  },
  {
    "Code": 4,
    "Message": "Unsupported shape type."
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}
[
  {
    "Code": 0,
    "Message": "string"
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}
<CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-106>
  <Code>0</Code>
  <Message>string</Message>
</CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-106>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}
<CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-107>
  <Code>0</Code>
  <Message>string</Message>
</CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-107>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}

500 Internal Server Error

This error is always an indication of a bug on the server side, it possibly due to an unhandled exception.

503 Service Unavailable

Service temporarily unavailable, because other services are temporarily unavailable (such as Azure service, required 3rd party service like Google API).

Code samples

@ECHO OFF

curl -v -X PUT "https://customerapi-encore.actsoft.com/geofences/v1/geofences/{id}?useMetric={boolean}&geocode={boolean}"
-H "X-API-Version: "
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("X-API-Version", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["useMetric"] = "{boolean}";
            queryString["geocode"] = "{boolean}";
            var uri = "https://customerapi-encore.actsoft.com/geofences/v1/geofences/{id}?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
                content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
                response = await client.PutAsync(uri, content);
            }
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://customerapi-encore.actsoft.com/geofences/v1/geofences/{id}");

            builder.setParameter("useMetric", "{boolean}");
            builder.setParameter("geocode", "{boolean}");

            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("X-API-Version", "");
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "useMetric": "{boolean}",
            "geocode": "{boolean}",
        };
      
        $.ajax({
            url: "https://customerapi-encore.actsoft.com/geofences/v1/geofences/{id}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("X-API-Version","");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://customerapi-encore.actsoft.com/geofences/v1/geofences/{id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"useMetric={boolean}",
                         @"geocode={boolean}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PUT"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"X-API-Version"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://customerapi-encore.actsoft.com/geofences/v1/geofences/{id}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'X-API-Version' => '',
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'useMetric' => '{boolean}',
    'geocode' => '{boolean}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_PUT);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'X-API-Version': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'useMetric': '{boolean}',
    'geocode': '{boolean}',
})

try:
    conn = httplib.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("PUT", "/geofences/v1/geofences/{id}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'X-API-Version': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'useMetric': '{boolean}',
    'geocode': '{boolean}',
})

try:
    conn = http.client.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("PUT", "/geofences/v1/geofences/{id}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://customerapi-encore.actsoft.com/geofences/v1/geofences/{id}')

query = URI.encode_www_form({
    # Request parameters
    'useMetric' => '{boolean}',
    'geocode' => '{boolean}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['X-API-Version'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body