Match Level Summary Report Endpoint

Creates a report that assigns customer records to one of five match levels based on the geographic code assigned to each customer while geocoding.

Availability: Business Analyst Server.

URL Example

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

Specific Parameters

Parameter	Description
CustomerLayer (required)	The customer layer to calculate match level summary. Type PointLayer.
CustomerDescription (optional)	Description or alias for the term customer. For example, this could be patients, subscribers, customers, and so on. Type string. Default: customers.

Parameter

Description

CustomerLayer (required)

The customer layer to calculate match level summary. Type PointLayer.

CustomerDescription (optional)

Description or alias for the term customer. For example, this could be patients, subscribers, customers, and so on. Type string.

Default: customers.

Other Parameters

Parameter	Description
OutputType (required)	Array of task output options. Options for this method include creating a report (GetReport). Type array of TaskOutputType.
StandardReportOptions (required)	Report parameters. Type ReportOptions. The TemplateName parameter is ignored.
ActiveDatasetID (optional)	ID of the active dataset. Type string. Default: ID of the first available dataset.
f (optional)	Response format. Type string. Available formats: HTML, JSON, XML. Default: HTML.
IsFullErrorMessage (optional)	Mode for composing error messages. Type boolean. Default: false.
OutputReportItem (optional)	Configuration options for storing the output report in the repository. This will enable viewing and working with the output result in subsequent tasks. Type esriFolderItem.
token	Authentication token. In Business Analyst Server, this parameter is required if your Business Analyst Server is secured. Type string.

Returns

Variable of type TaskResultOutput

Remarks

The CustomerLayer parameter should specify a point layer generated by geocoding your customer records. It should be specified with a RecordSet or FolderItem property and should contain the "Loc_name" attribute field whose value contains the match level of customer addresses geocoding.

Example Usage

The example below generates a report for two customer points.

Request

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/MatchLevelSummaryReport/execute?
CustomerLayer={"Recordset":{
  "geometryType":"esriGeometryPoint",
  "spatialReference":{"wkid":4269},
  "features":[
    {
      "geometry":{
        "x":-117.194149469738,
        "y":34.057165902665,
        "spatialReference":{"wkid":4269}
      },
      "attributes":{
        "OID":1,
        "Loc_name":"Address_Points",
        "Status":"M",
        "Score":100,
        "Side":"L",
        "X":-117.194149469738,
        "Y":34.057165902665,
        "Match_addr":"380 NEW YORK ST, REDLANDS, CA, 92373",
        "Block":"060710081002007",
        "BlockL":"",
        "BlockR":"",
        "STORE_ID":"1",
        "NAME":"store1",
        "DESCR":"Redlands Office",
        "ADDRESS":"380 New York St.",
        "CITY":"Redlands",
        "STATE":"CA",
        "ZIP":"92373",
        "ST_DESC":""
      }
    },
    {
      "geometry":{
        "x":-117.232604479711,
        "y":32.8708971934764,
        "spatialReference":{"wkid":4269}
      },
      "attributes":{
        "OID":2,
        "Loc_name":"Address_Points",
        "Status":"M",
        "Score":100,
        "Side":"L",
        "X":-117.232604479711,
        "Y":32.8708971934763,
        "Match_addr":"3252 HOLIDAY CT, LA JOLLA, CA, 92037",
        "Block":"060730083151000",
        "BlockL":"",
        "BlockR":"",
        "STORE_ID":"2",
        "NAME":"store2",
        "DESCR":"La Jolla Office",
        "ADDRESS":"3252 Holiday Court",
        "CITY":"La Jolla",
        "STATE":"CA",
        "ZIP":"92037",
        "ST_DESC":""
      }
    }
  ]
}}&OutputType=GetReport&
StandardReportOptions={"ReportFormat":"PDF"}&
f=PJSON

Response

{
  "results":
  [
    {
      "paramName":"Match Level Summary Report.PDF",
      "dataType":"GPDataFile",
      "value":
      {
        "url":"http://localhost/arcgisoutput/_ags_T2ED149CA448F19153961BCF137325.pdf"
      }
    }
  ],
  "messages":
  [
  ]
}