Salesforce Maps Apex Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Overview
Requirements
Apex Methods
Assign Records to Owners Using an Assignment Plan
Create a Route
Create Routes for Specific Users
Create Routes from Visit Plan
Get a Route
Get the Boundary Information
Get the Distance Matrix
Get the Geographical Coordinates of an Address
Get the Geographical Coordinates of Addresses in Batch
Permanently Delete Datasets and Alignments
Retrieve Data That Salesforce Maps Hosts
Retrieve the Geographical Data of Country-Specific Shapes
Retrieve the Geographical Data of Polygons
Retrieve the Territories in Which the Records Reside
PDF

Get the Boundary Information

The GetBoundaryInformation() Apex method returns geographical IDs of locations that fit the specified search criteria.

Salesforce Maps works with data providers that supply property data. Periodically, these providers update their data, which can affect custom code. If the providers change their data formats, update your custom code accordingly. Salesforce Maps can update, replace, or remove property data at any time.

Signature

Map<String, Object> maps.API.GetBoundaryInformation(String parameters)
Where,
  • maps is the namespace of the Salesforce Maps package. It’s automatically available when the package is installed.
  • API is the class that contains the global methods exposed to developers.
  • GetBoundaryInformation() is the method.

Sample Code

This code finds the geographical IDs of states in the USA beginning with “A”.

If you invoke methods within a flow, process builder, or trigger, avoid uncommitted work errors when you perform one of the following.

  • Call the methods through a future method
  • Call the methods as queueable

Different processes refresh the token, such as plotting a route or schedule. The refresh process is almost immediate after each qualifying action occurs.

Warning

Example

// Create the search criteria in JSON format.
String parameters = '{"overlay":"USA","level":"1","filters":[{"field_id":"label","operator":"starts with","values":["A"]}]}';

// Call the GetBoundaryInformation() method with the search criteria.
Map<String, Object> response= maps.API.GetBoundaryInformation(parameters);

// Log the resulting Geo IDs.
system.debug(response);

Sample Response

Although the return value is an Apex Map<String, Object> object, this JSON response illustrates the essential data you receive in the resulting map.

{
  "endPoint": "https://internal.na.sfmapsapi.com/boundary/search/1",
  "limitInfo": {
    "QueryRows": "12 / 50000",
    "Queries": "8 / 100",
    "HeapSize": "71096 / 6000000",
    "CPUTime": "133 / 10000"
  },
  "request": "{\"overlay\":\"USA\",\"level\":\"1\",\"filters\":[{\"field_id\":\"label\",\"operator\":\"starts with\",\"values\":[\"A\"]}]}",
  "params": {
    "filters": [
      {
        "values": [
          "A"
        ],
        "operator": "starts with",
        "field_id": "label"
      }
    ],
    "level": "1",
    "overlay": "USA"
  },
  "success": true,
  "data": {
    "geoids": [
      {
        "label": "Alabama",
        "value": "USA-01"
      },
      {
        "label": "Alaska",
        "value": "USA-02"
      },
      {
        "label": "Arizona",
        "value": "USA-04"
      },
      {
        "label": "Arkansas",
        "value": "USA-05"
      }
    ]
  }
}