International Code Council (ICC) Integration

Prev Next

Community Development has an integration with ICC’s Code Connect API, which allows you to search for relevant codes and attach them to records.

Preview

When you are in an area that allows code lookup, such as a violation or inspection, you can search by book by using the category selector:

A dropdown menu displaying various violation reasons within a local database.

You can provide a search term and then click "Search". Your results will be shown in the table that follows:

A search interface for Code of Ordinances with a highlighted search button and results.

To add a code to a record, select one or more corresponding checkboxes and then select "Add selected codes and laws to current record":

A search interface for ordinances with a highlighted option to add selected laws.

Set Up the Integration

Who can use this feature?

Container Administrators

  1. Navigate to Admin Tools and select Organizational Settings: Admin tools menu with organizational settings highlighted for easy navigation.

  2. Expand Integrations-External:A menu displaying various organizational settings with 'Integrations-External' highlighted.

  3. In the ICC Digital Codes box, input the following: A form for ICC Digital Codes with fields for client ID, secret, and licensing type.

    • Icc client id: Provided by ICC

    • Icc client secret: Provided by ICC

    • Icc grant type: client_credentials

    • Icc scope: content-read

    • Retrieve live codes: Check the box

    • Licensing Type: Select either user-based licensing or population-based licensing based on your subscription with ICC

  4. Click Save Settings:A button to save settings in a user interface, indicating action completion.

  5. Click Test ICC Integration:A form for ICC Digital Codes with highlighted integration test button and licensing options.

  6. You should get a pop-up that states that Community Development can successfully communicate with ICC: A notification from qa.civicgov4.com confirming ICC integration is functioning correctly.

  7. Click Import ICC Title List:A form for ICC Digital Codes with highlighted import button and licensing options.

    Note:

    This step creates all the titles and code books that you see in your category dropdown list. If you add or remove books from your subscription, you will need to reimport your titles using this button:A message from qa.civicgov4.com indicating successful import of ICC titles.