The component exposes some public actions, with the following signatures :

FrenchAddressAPI > FrenchAddress_Search

• Input Parameters
  • Address - Address to search
  • Latitude - GPS coordinate to narrow down the search results
  • Longitude - GPS coordinate to narrow down the search results
  • PostalCode - Postal Code to narrow down the search results
  • AddressType - Address Type to narrow down the search results, with the following possible values :
    • "house","street","district","city","county","state","country","locality"
  • MaxRecords - Maximum number of records to be returned by the API
  • Autocomplete - Instructs the API to return the results in continuous mode (possible values: 0 or 1)
• Output Parameters
  • Addresses - List of addresses found, with the following attributes :
    • Id - Address identifier (interoperability key)
    • Type - Type of result found ("housenumber": number "on the plate", "street": position "on the road", placed approximately in the center of it, "locality": place-name, "municipality": number "on the commune")
    • Score - Value from 0 to 1 indicating the relevance of the result
    • Housenumber - Number with possible repetition index (bis, ter, A, B)
    • Street - Name of the road
    • Name - Possible number and name of road or place
    • Postcode - Postal code
    • Citycode - INSEE code of the municipality
    • City - Name of the municipality
    • District - Name of the district (Paris/Lyon/Marseille)
    • Oldcitycode - INSEE code of the former municipality (if applicable)
    • Oldcity - Name of the former municipality (if applicable)
    • Context - Department number, department and region name
    • Label - Full address wording
    • X - Geographic coordinates in legal projection
    • Y - Geographic coordinates in legal projection
    • Importance - Importance indicator (technical field)
    • Latitude - GPS coordinate of the address
    • Longitude - GPS coordinate of the address
  • Return - Result of the action execution
    • WasSuccessful - Returns true if no errors were detected
    • Message - Returns empty if no errors were detected, or an error message in case of errors

FrenchAddressAPI > FrenchAddress_SearchReverse

• Input Parameters
  • Latitude - GPS coordinate to searcg
  • Longitude - GPS coordinate to search
  • AddressType - Address Type to narrow down the search results, with the following possible values :
    • "house","street","district","city","county","state","country","locality"
  • MaxRecords - Maximum number of records to be returned by the API
• Output Parameters
  • Addresses - List of addresses found, with the following attributes :
    • Id - Address identifier (interoperability key)
    • Type - Type of result found ("housenumber": number "on the plate", "street": position "on the road", placed approximately in the center of it, "locality": place-name, "municipality": number "on the commune")
    • Score - Value from 0 to 1 indicating the relevance of the result
    • Housenumber - Number with possible repetition index (bis, ter, A, B)
    • Street - Name of the road
    • Name - Possible number and name of road or place
    • Postcode - Postal code
    • Citycode - INSEE code of the municipality
    • City - Name of the municipality
    • District - Name of the district (Paris/Lyon/Marseille)
    • Oldcitycode - INSEE code of the former municipality (if applicable)
    • Oldcity - Name of the former municipality (if applicable)
    • Context - Department number, department and region name
    • Label - Full address wording
    • X - Geographic coordinates in legal projection
    • Y - Geographic coordinates in legal projection
    • Importance - Importance indicator (technical field)
    • Latitude - GPS coordinate of the address
    • Longitude - GPS coordinate of the address
  • Return - Result of the action execution
    • WasSuccessful - Returns true if no errors were detected
    • Message - Returns empty if no errors were detected, or an error message in case of errors

Utilities > GetAddressTypes (this action is available both as Client and Server)

• Input Parameters
  • (none)
• Output Parameters
  • AddressTypes - Address Types list, with the following attributes :
    • Value
    • Label

Drag and drop the server actions into the flow of a server, service or data action, set the Input Parameters accordingly, and handle the results.