Documentation Index

Fetch the complete documentation index at: https://www.civicplus.help/llms.txt

Use this file to discover all available pages before exploring further.

Parcel Import Using the REST API | V4

Prev Next

Overview

Community Development lets you import parcel records from an ArcGIS REST API endpoint into the Property Management module. During setup, connect to the endpoint. Get the available fields. Map the endpoint fields to Community Development fields. Then import the parcel records. Review your parcel import settings and parcel records regularly. This helps keep your system data accurate and your system working properly.

Before you begin

Ensure you have:

  • A REST API endpoint provided by your GIS administrator.

  • Access to Parcel Import in the  Tools Organizational Settings

  • The required parcel fields are available in the endpoint:

    • Parcel ID or number

    • Owner Name

    • Mailing Address

    • Physical Location, including separate:

      • City

      • State

      • ZIP Code

    • Latitude (Y): spherical coordinate, -90 to +90, up to 7 decimal places

    • Longitude (X): spherical coordinate, -180 to +180, up to 7 decimal places

    • Additional fields may be included at municipality's discretion.

    • All required attributes must be available from a single REST endpoint.

    • The REST endpoint must return polygon geometry for each parcel.

    • Shapefiles are not acceptable; the integration must consume the parcel data through the REST endpoint.


Configure the Parcel Import

  1. Sign in to your site.

  2. Navigate to Admin Tools, and select Organizational Settings:

    Admin tools menu with organizational settings highlighted for easy navigation.

  3. Locate and select Parcel Import:

    Menu options include Parcel Import, Building Import, and other management settings. The parcel import option is highlighted.

  4. Paste the ArcGIS REST API endpoint URL into the Import from REST API field:

    Configuration settings for server import with a highlighted API URL field.

    Note:

    Ensure that the URL ends in /query?. For example: HTTPS://services.arcgis.com/1A23C4K25h67z89/arcgis/rest/services/CivicPlusLayers/FeatureServer/12/query?

  5. Click Save Settings and wait for the page to reload before continuing:

    The configuration area for importing parcels with options for file upload and settings. The Save Settings button is highlighted.

  6. Click the Download CSV button:

    Settings page showing server configuration and a highlighted Download CSV button.

  7. Wait for the download to complete. The system connects to the ArcGIS REST API endpoint and retrieves the available field definitions.

    Note:

    A download status message appears at the bottom of the page during the process. It displays the following messages in order:

    • Validating Configuration displays with a loading icon:

      A loading message indicating configuration validation in a software interface.

    • Saving Configuration displays after validation is complete:

      A loading message indicating the configuration saving process in a user interface.

    When the process is complete, the page reloads.

  8. Click Save Settings again.

  9. After saving, the field mapping table is populated with the fields retrieved from the endpoint:

    A table displaying GIS data fields including OBJECTID, Mailing Address, and Location Address.

  10. Navigate to the Import Key dropdown field:

    Settings interface for importing parcel data. The Import Key field is highlighted.

  11. Set the Import Key to Parcel Number by selecting parcel_number from the dropdown field:

    The image displays a form with various data fields. The Parcel_Number field is highlighted.

    Note:

    The import key is the unique identifier used to determine whether parcel records should be created or updated during an import.

  12. Review the fields returned from the endpoint.

  13. Map each endpoint field to the parcel record field by selecting the appropriate choice from the provided dropdowns:

    A table displaying GIS link fields with highlighted options for mapping and data entry.

    Note:

    At a minimum, configure mappings for:

    • Parcel ID or number

    • Owner Name

    • Mailing Address

    • Physical Location, including separate:

      • City

      • State

      • ZIP Code

    • Latitude (Y): spherical coordinate, -90 to +90, up to 7 decimal places

    • Longitude (X): spherical coordinate, -180 to +180, up to 7 decimal places

    • Additional fields may be included at municipality's discretion.

    • All required attributes must be available from a single REST endpoint.

    • The REST endpoint must return polygon geometry for each parcel.

    • Shapefiles are not acceptable; the integration must consume the parcel data through the REST endpoint.

    If the parcel location or mailing address is split across multiple fields, such as street number, street direction, and street name, map each field as a Location or Mailing field. During the import, all mapped fields are combined into the same parcel record field. This is where you can enter an optional suffix, such as a comma, to format your mailing addresses.

  14. Click Save Settings and ensure it fully finishes.

  15. Click Import to begin importing parcel records:

    Data entry interface showing fields for shape area and length with an import button. The Import button is highlighted.

    Important Note:

    Wait for the import to finish. The import may take some time, depending on the number of parcels to check and update. It is best to start the import and let it run without using your account.


Results

After the import is complete, Community Development displays a summary showing the number of records that were added and updated. You can also review data from the last import by viewing the Parcel Import Report. To find the report, follow these steps:

  1. Navigate to Reporting, then click Custom Reports:

    The Community Development reporting interface has a highlighted Custom Reports section.

  2. Select the Parcel Import Report link:

    Custom reports section showing various report options, including a highlighted Parcel Import Report link.

  3. View the Report:

    The Parcels Import report displays total records and individual parcel details.

    • Import Status: Select an import status to filter the report

    • Query: Run the report using the selected filter

    • Clear: Clear the selected filter

    • Print: Print the report

    • Export Format: Select the file format and page orientation for the exported report

    • Summary: Displays the total number of inserted, updated, not updated, and imported records

    • Parcel Number: Displays the parcel number

    • Owner Name: Displays the property owner's name

    • Mailing: Displays the mailing address

    • Email: Displays the email address associated with the parcel

    • Phone: Displays the phone number associated with the parcel

For a new implementation, most or all records are typically added. During subsequent imports, existing parcel records are updated by matching the configured Parcel Number import key.


How to Maintain Your Parcel Data

After your data is first imported, you are responsible for maintaining the accuracy of future imports. Follow these best practices:

  • Check your Parcel Import settings regularly. Make sure the REST API URL is correct and still accessible

  • Before each import, click Download CSV and Save Settings. This downloads the latest parcel data and fields

  • Review your field mappings regularly, especially before an import. Make sure the Parcel Number import key and other key field mappings are correct

  • You can request an automated process that checks for new parcel data to import. The process can run as often as once a week. If no new data is found, the import is skipped. Contact Support to request this setup and provide your preferred frequency, date, and time

Note:

With automated checks, it is especially important to regularly review your parcel field mappings and the REST API endpoint location. This helps ensure the imported data is accurate.

Important Note:

Once a parcel record is imported, it will not be automatically deleted or removed from use based on changes to future parcel imports. If a parcel should no longer be associated with your municipality, follow our guide to retire it from use.