Profile by Table Geocoding Endpoint

Creates a new Tapestry segmentation profile from a table of address records.

Availability: Business Analyst Server.

URL Example

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/ProfileByTableGeocoding/execute

Specific Parameters

Parameter	Description
GeocodeData (required)	Table containing address records. Type GeocodeData.
SegmentationBase (required)	Segmentation base. Use the GetSegBases lookup operation to query available segmentation bases. Type string.
WeightField (optional)	The attribute field in the GeocodeData table which contains weight value (e.g. sales) for each address record. Type string.

Other Parameters

Parameter	Description
ActiveDatasetID (optional)	ID of the active dataset. Type string. Default: ID of the first available dataset.
compatibility (optional)	Business Analyst Server version the JSON output is compatible with. Type string.
f (optional)	Response format. Type string. Available formats: HTML, JSON, PJSON, XML. Default: HTML.
IsFullErrorMessage (optional)	Mode for composing error messages. Type boolean. Default: false.
OutputItem (optional)	Configuration options for storing the output profile in the repository. This will enable viewing and working with the output result in subsequent tasks. Type esriFolderItem.
token	Authentication token. This parameter is required if your Business Analyst Server is secured. Type string.

Returns

Variable of type string containing XML serialized segmentation profile. In the case of JSON and PJSON response types, the response format depends on the compatibility parameter value.

Remarks

Use the Profile by Table Geocoding endpoint when you want to create a segmentation profile based on address data.

For example, suppose you have records with addresses of your customers. Using this method, you can create the Tapestry segmentation profile for your customers. This profile will be used as the target segmentation profile for comparison with the base segmentation profile created by the Profile by Area Summation endpoint in such analysis as Game Plan Chart, Market Analysis Report, and so on.

The table below illustrates how an address table might look. Using the address information from your table, Business Analyst can append a Tapestry segment to each matched address.

Usage Tips

• Only matched address records will be taken into account in the output segmentation profile.

Example Usage

The example below creates a weighted market segmentation profile from an external table of addresses and sales.

This example requires a prerequisite "customers" table uploaded to the Custom Data folder in the Default Project of the Default Workspace of the repository.

NOTE: CUST_ID, NAME, ADDRESS, CITY, STATE, ZIP, and STORE_ID fields must be of type "Text". The SALES field must NOT be of type "Text".

Optionally, this table can be programmatically uploaded using SOAP. See the SOAP Upload Table method for more information.

Request

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/ProfileByTableGeocoding/execute?
GeocodeData={
  "Table":{"Item":{
    "WorkspaceName":"Default Workspace",
    "ProjectName":"San Francisco Tutorial Project",
    "folderType":"esriFolderCustomData",
    "itemName":"customers"
  }}
}&
SegmentationBase=Total Households&
ActiveDatasetID=USA_ESRI_2011&
WeightField=SALES&
f=PJSON

Response

{
  "results":
  [
    {
      "paramName":"ProfileData",
      "dataType":"GPString",
      "value":"<ProfileData
        xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
        xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"
        Base=\"Total Households\"
      >
        <Cluster
          ID=\"1\"
          Name=\"Top Rung\"
          Count=\"0\"
          Weight=\"0.000000\"
          VolumeInfo=\"0.000000\"
        />
        ...
        <Cluster
          ID=\"8\"
          Name=\"Laptops and Lattes\"
          Count=\"4\"
          Weight=\"89.696983\"
          VolumeInfo=\"41353.000000\"
        />
        <Cluster
          ID=\"9\"
          Name=\"Urban Chic\"
          Count=\"0\"
          Weight=\"0.000000\"
          VolumeInfo=\"0.000000\"
        />
        ...
        <Cluster
          ID=\"23\"
          Name=\"Trendsetters\"
          Count=\"1\"
          Weight=\"10.303017\"
          VolumeInfo=\"4750.000000\"
        />
        <Cluster
          ID=\"24\"
          Name=\"Main Street, USA\"
          Count=\"0\"
          Weight=\"0.000000\"
          VolumeInfo=\"0.000000\"
        />
        ...
        <Cluster
          ID=\"66\"
          Name=\"Unclassified\"
          Count=\"0\"
          Weight=\"0.000000\"
          VolumeInfo=\"0.000000\"
        />
      </ProfileData>"
    }
  ],
  "messages":
  [
  ]
}

NOTE: The XML string value in the response is split in lines for easy reading. The response has been abbreviated where "..." is noted.