FRAMES | NO FRAMES

 

B U S I N E S S   A N A L Y S T   10.0   R E S T   A P I   C U S T O M E R / S T O R E    S E T U P    T A S K

Create Record Set by Addresses Endpoint

Creates store or customer records by their postal addresses.

 

Availability: Business Analyst Server.

 

URL Example

http://localhost/ArcGIS/baserver/REST/services/DefaultMap/BAServer/CreateRecordSetByAddresses/execute

Parameters

Parameter

Description

RecordSetByAddressArray (required)

Array of address records. Type array of RecordSetByAddress.

FolderType (required)

Records type. Type esriFolderType.

f (optional)

Response format. Type string. Available formats: HTML, JSON, PJSON, XML.

Default: HTML.

token

Authentication token. This parameter is required if your Business Analyst Server is secured. Type string.

Returns

Variable of type TaskResultOutput whose RecordSet parameter contains records with address attributes. This record set can be used as an input for Customer/Store Setup by Geocode Table and Profile by Table Geocoding endpoints.

Remarks

The FolderType parameter specifies the record set type:

 

esriFolderStoreLayers means store records (StoreID property of a record specifies a record ID, but CustomerID property is ignored);

esriFolderCustomerLayers means customer records (CustomerID property of a record specifies a record ID and StoreID property specifies an ID of associated store).

Example Usage

The example below creates an address record set of 6 store locations.

 

Request

http://localhost/ArcGIS/baserver/REST/services/DefaultMap/BAServer/CreateRecordSetByAddresses/execute?
RecordSetByAddressArray=[
  { "StoreID":"1",
    "Name":"pizza1",
    "Description":"Rush Street Store",
    "Address":"730 N. Rush St.",
    "City":"Chicago",
    "State":"IL",
    "ZIP":"60611"
  },
  { "StoreID":"2",
    "Name":"pizza2",
    "Description":"Clark Street Store",
    "Address":"2121 N. Clark St.",
    "City":"Chicago",
    "State":"IL",
    "ZIP":"60614"
  },
  { "StoreID":"3",
    "Name":"pizza3",
    "Description":"31st Street Store",
    "Address":"4254 W. 31st St.",
    "City":"Chicago",
    "State":"IL",
    "ZIP":"60623"
  },
  { "StoreID":"4",
    "Name":"pizza4",
    "Description":"Wells Street Store",
    "Address":"439 N. Wells St.",
    "City":"Chicago",
    "State":"IL",
    "ZIP":"60610"
  },
  { "StoreID":"5",
    "Name":"pizza5",
    "Description":"Ohio Street Store",
    "Address":"29 E. Ohio St.",
    "City":"Chicago",
    "State":"IL",
    "ZIP":"60611"
  },
  { "StoreID":"6",
    "Name":"pizza6",
    "Description":"North Avenue Store",
    "Address":"1927 North Ave.",
    "City":"Chicago",
    "State":"IL",
    "ZIP":"60622"
}]&
FolderType=esriFolderStoreLayers&
f=PJSON

 

Response

{
  "results":
  [
    {
      "paramName":"OutputFeatureClass",
      "dataType":"GPFeatureRecordSetLayer",
      "value":
      {
        "features":
        [
          {
            "geometry":
            {
            },
            "attributes":
            {
              "OBJECTID":1,
              "STORE_ID":"1",
              "NAME":"pizza1",
              "DESCR":"Rush Street Store",
              "ADDRESS":"730 N. Rush St.",
              "CITY":"Chicago",
              "STATE":"IL",
              "ZIP":"60611"
            }
          },
          ...
          {
            "geometry":
            {
            },
            "attributes":
            {
              "OBJECTID":6,
              "STORE_ID":"6",
              "NAME":"pizza6",
              "DESCR":"North Avenue Store",
              "ADDRESS":"1927 North Ave.",
              "CITY":"Chicago",
              "STATE":"IL",
              "ZIP":"60622"
            }
          }
        ]
      }
    }
  ],
  "messages":
  [
  ]
}

 

NOTE: The response has been abbreviated where "..." is noted.

 

See Also

RecordSetByAddress Type

Customer/Store Setup by Geocode Table Endpoint

Profile by Table Geocoding Endpoint

Business Analyst Server REST API Reference