0151 355 4555



Creates a new, empty reference file ready to add records to. The following details are required:

  • Name - provides a unique name to refer to this stop file in later method calls
  • Residential - indicates whether this stop file will contain residential or business addresses. This affects the matching logic used when searching the stop file with the SearchRecord method.

In addition to these required details, extra fields can be added to stop file records by including StopFileMetaDataDetail records in the request. By default a stop file holds only name and address details, but these additional fields can be used to hold your application-specific data as well.

View all Stop Files (contact us for more information about this service) methods

Code Samples

<!-- Import the Integr8 Ajax API -->
<!-- NOTE: Get your own API key to use in the following script tag from: -->
<!-- http://www.data-8.co.uk/integr8/Admin/Ajax.aspx -->
<script src="https://webservices.data-8.co.uk/Javascript/Loader.ashx?key=your-api-key" type="text/javascript">

<script type="text/javascript">

function loadIntegr8() {
  // Load the StopFiles Integr8 service

function CreateStopFile(stopFile) {
  /// <param name="stopFile">data8.stopfiledetails. Set up the Name, Residential, MetaDataFields properties before calling this method.</param>
  var stopfiles = new data8.stopfiles();

function showCreateStopFileResult(result) {
  // Check that the call succeeded, and show the error message if there was a problem.
  if (!result.Status.Success) {
    alert('Error: ' + result.Status.ErrorMessage);
  else {
    // TODO: Process method results here.
    // Results can be extracted from the following fields: