Search Addresses by Address

Returns addresses that match the specified address search fields.

Search Addresses by Address Keys is equivalent to the legacy Accela GIS SOAP API getAddressBySearchKeys.

For an overview, see Addresses.

URI

POST /api/geo/v1/xapo/{agencyId}/addresses/byAddress

Request JSON Syntax

{
  "address":
  {
  "UID": "string",
  "XCoordinator": "string",
  "YCoordinator": "string",
  "addressDescription": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressStatus": "string",
  "addressTypeFlag": "string",
  "auditDate": "string",
  "auditID": "string",
  "auditStatus": "string",
  "city": "string",
  "country": "string",
  "countryCode": "string",
  "county": "string",
  "distance": "string",
  "eventID": "string",
  "fullAddress": "string",
  "houseFractionEnd": "string",
  "houseFractionStart": "string",
  "houseNumberAlphaEnd": "string",
  "houseNumberAlphaStart": "string",
  "houseNumberEnd": "string",
  "houseNumberStart": "string",
  "houseNumberEndFrom": "string",
  "houseNumberEndTo": "string",
  "houseNumberStartFrom": "string",
  "houseNumberStartTo": "string",
  "inspectionDistrict": "string",
  "inspectionDistrictPrefix": "string",
  "levelPrefix": "string",
  "levelNumberStart": "string",
  "levelNumberEnd": "string",
  "lot": "string",
  "neighborhood": "string",
  "neighborhoodPrefix": "string",
  "primaryFlag": "string",
  "refAddressType": "string",
  "secondaryRoad": "string",
  "secondaryRoadNumber": "string",
  "sourceFlag": "string",
  "state": "string",
  "streetDirection": "string",
  "streetName": "string",
  "streetPrefix": "string",
  "streetSuffix": "string",
  "streetSuffixdirection": "string",
  "subdivision": "string",
  "unitEnd": "string",
  "unitStart": "string",
  "unitType": "string",
  "zip": "string",
  "userDefinedFields": [
     {
       "fieldName":"string",
       "fieldValue":"string"
     },
     {
       "fieldName":"string",
       "fieldValue":"string"
     }
  ]
  },
  "settings":
  {
  "maxRows": "int",
  "startRow": "int",
  "orderBy": "string"
  }
}

Response JSON Syntax

{
  "result":
  [
  {
  "UID": "string",
  "XCoordinator": "string",
  "YCoordinator": "string",
  "addressDescription": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressStatus": "string",
  "addressTypeFlag": "string",
  "auditDate": "string",
  "auditID": "string",
  "auditStatus": "string",
  "city": "string",
  "country": "string",
  "countryCode": "string",
  "county": "string",
  "distance": "string",
  "eventID": "string",
  "fullAddress": "string",
  "houseFractionEnd": "string",
  "houseFractionStart": "string",
  "houseNumberAlphaEnd": "string",
  "houseNumberAlphaStart": "string",
  "houseNumberEnd": "string",
  "houseNumberStart": "string",
  "houseNumberEndFrom": "string",
  "houseNumberEndTo": "string",
  "houseNumberStartFrom": "string",
  "houseNumberStartTo": "string",
  "inspectionDistrict": "string",
  "inspectionDistrictPrefix": "string",
  "levelPrefix": "string",
  "levelNumberStart": "string",
  "levelNumberEnd": "string",
  "lot": "string",
  "neighborhood": "string",
  "neighborhoodPrefix": "string",
  "primaryFlag": "string",
  "refAddressType": "string",
  "secondaryRoad": "string",
  "secondaryRoadNumber": "string",
  "sourceFlag": "string",
  "state": "string",
  "streetDirection": "string",
  "streetName": "string",
  "streetPrefix": "string",
  "streetSuffix": "string",
  "streetSuffixdirection": "string",
  "subdivision": "string",
  "unitEnd": "string",
  "unitStart": "string",
  "unitType": "string",
  "zip": "string",
  "userDefinedFields": [
     {
       "fieldName":"string",
       "fieldValue":"string"
     },
     {
       "fieldName":"string",
       "fieldValue":"string"
     }
  ]
  },
  {
  "UID": "string",
  "XCoordinator": "string",
  "YCoordinator": "string",
  "addressDescription": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressStatus": "string",
  "addressTypeFlag": "string",
  "auditDate": "string",
  "auditID": "string",
  "auditStatus": "string",
  "city": "string",
  "country": "string",
  "countryCode": "string",
  "county": "string",
  "distance": "string",
  "eventID": "string",
  "fullAddress": "string",
  "houseFractionEnd": "string",
  "houseFractionStart": "string",
  "houseNumberAlphaEnd": "string",
  "houseNumberAlphaStart": "string",
  "houseNumberEnd": "string",
  "houseNumberStart": "string",
  "houseNumberEndFrom": "string",
  "houseNumberEndTo": "string",
  "houseNumberStartFrom": "string",
  "houseNumberStartTo": "string",
  "inspectionDistrict": "string",
  "inspectionDistrictPrefix": "string",
  "levelPrefix": "string",
  "levelNumberStart": "string",
  "levelNumberEnd": "string",
  "lot": "string",
  "neighborhood": "string",
  "neighborhoodPrefix": "string",
  "primaryFlag": "string",
  "refAddressType": "string",
  "secondaryRoad": "string",
  "secondaryRoadNumber": "string",
  "sourceFlag": "string",
  "state": "string",
  "streetDirection": "string",
  "streetName": "string",
  "streetPrefix": "string",
  "streetSuffix": "string",
  "streetSuffixdirection": "string",
  "subdivision": "string",
  "unitEnd": "string",
  "unitStart": "string",
  "unitType": "string",
  "zip": "string",
  "userDefinedFields": [
     {
       "fieldName":"string",
       "fieldValue":"string"
     },
     {
       "fieldName":"string",
       "fieldValue":"string"
     }
  ]
  }
  ],
  "totalRecords": "int"
  }

Request Field Descriptions

Parameter Type Required Description
agencyId String Yes The required agency parameter. The XAPO field mapping must be configured for the requested agency on the GIS Admin site.
address address{ } No The address JSON object containing address request parameters.
address.UID String No A unique identifier for the external address
address.XCoordinator Number No The longitudinal coordinate for the address (from a GPS device)
address.YCoordinator Number No The latitudinal coordinate for the address (from a GPS device)
address.addressDescription String No An unstructured description of the address
address.addressLine1 String No The first line of the address
address.addressLine2 String No The second line of the address
address.addressStatus String No The current status of the address record, either disabled (I) or enabled (A)
address.addressTypeFlag String No A single character code indicating the address type
address.auditDate Date Yes The creation date or modification date of the address record
address.auditID String Yes The identification code of the person who created or modified the address
address.auditStatus String No A single character code indicating the audit status, either disabled (I) or enabled (A)
address.city String No The city in which the address locates
address.country String No The country in which the address locates
address.countryCode String No The two character code indicating the country. In Accela Automation, you set country codes through a standard choice.
address.county String No The county in which the address exists
address.distance Number No The distance to a landmark (used to locate the address)
address.eventID Number No The name of an event scheduled for the address
address.fullAddress String No The full address
address.houseFractionEnd String No Indicates the ending fraction of a street number, specified by the houseNumberEnd property. Used with the houseFractionStart property to locate an address.
address.houseFractionStart String No Indicates the starting fraction of a street number, specified by the houseNumberStart property. Used with the houseFractionEnd property to locate an address.
address.houseNumberAlphaEnd String No Indicates the ending street number that makes up the address. The street number can consist of alphanumeric characters. For example, if the street is 10-23A WHITESTONE, 23A is the ending street number.
address.houseNumberAlphaStart String No Indicates the beginning street number that makes up the address. The street number can consist of alphanumeric characters. For example, if the street is 10-23A WHITESTONE, 10 is the beginning street number.
address.houseNumberEnd Number No Specifies the ending house number in a range of house numbers. Used with the houseNumberStart property to specify a range of numbers to search from within when looking for an address.
address.houseNumberEndFrom String No Specifies the range search From field of Street # (End). Can only be used as a search criterion.
address.houseNumberEndTo String No Specifies the range search To field of Street # (End). Can only be used as a search criterion.
address.houseNumberStart Number No Specifies the starting house number in a range of house numbers. Used with the houseNumberEnd property to specify a range of numbers to search from within when looking for an address.
address.houseNumberStartFrom String No Specifies the range search From field of Street # (Start). Can only be used as a search criterion.
address.houseNumberStartTo String No Specifies the range search To field of Street # (Start). Can only be used as a search criterion.
address.inspectionDistrict String No The inspection district within which the address exists
address.inspectionDistrictPrefix String No The prefix for the inspection district within which the address exists
address.levelNumberEnd String No Indicates the ending level number (floor number) that makes up the address within a complex, used to identify a floor or level of a multi-story building/sub-complex.
address.levelNumberStart String No Indicates the beginning level number (floor number) that makes up the address within a complex, used to identify a floor or level of a multi-story building/sub-complex.
address.levelPrefix String No Indicates the prefix for the level numbers (floor numbers) that make up the address.
address.lot String No The name of the lot within which the address resides
address.neighborhood String No The name of the neighborhood within which the address exists
address.neighborhoodPrefix String No The prefix for the neighborhood within which the address exists
address.primaryFlag String No Indicates whether the address is the primary residence or business location associated with a record. Only one address can be the primary address.
address.refAddressType String No The name of the address type. In Accela Automation, you set address types through the REF_ADDRESS_TYPE standard choice. The available values include: Parcel Address, Street ROW Address, Asset Address, and so forth.
address.secondaryRoad String No The road name of the secondary address
address.secondaryRoadNumber Number No The number of the secondary address
address.sourceFlag String No A code indicating the Accela application (Accela Automation, Kiva, or Tidemark, for example) that stores address information
address.state String No A two letter abbreviation for the state in which the address exists
address.streetDirection String No The street direction of the primary address (N for North Broadway, for example)
address.streetName String No The street name for the primary address.
address.streetPrefix String No The street prefix for the primary address
address.streetSuffix String No The street suffix for the primary address, such as Street, Avenue, or Boulevard
address.streetSuffixdirection String No Street Suffix Direction
address.subdivision String No The name of the subdivision
address.unitEnd String No The ending unit number, in a range of units, specified in a search
address.unitStart String No The beginning unit number, in a range of units, specified in a search
address.unitType String No The type of structure for this address, for example, apartment or condo
address.zip String No The zip code for the address
address.userDefinedFields Array No Contains address template custom fields
address.userDefinedFields.fieldName String No A custom field name
address.userDefinedFields.fieldValue String No A custom field value

Response Field Descriptions

Parameter Type Description  
addresses [ ] addresses{ } An array containing the result addresses.  
addresses.UID String A unique identifier for the external address  
addresses.XCoordinator Number The longitudinal coordinate for the address (from a GPS device)  
addresses.YCoordinator Number The latitudinal coordinate for the address (from a GPS device)  
addresses.addressDescription String An unstructured description of the address  
addresses.addressLine1 String The first line of the address  
addresses.addressLine2 String The second line of the address  
addresses.addressStatus String The current status of the address record, either disabled (I) or enabled (A)  
addresses.addressTypeFlag String A single character code indicating the address type  
addresses.auditDate Date The creation date or modification date of the address record  
addresses.auditID String The identification code of the person who created or modified the address  
addresses.auditStatus String A single character code indicating the audit status, either disabled (I) or enabled (A)  
addresses.city String The city in which the address locates  
addresses.country String The country in which the address locates  
addresses.countryCode String The two character code indicating the country. In Accela Automation, you set country codes through a standard choice.  
addresses.county String The county in which the address exists  
addresses.distance Number The distance to a landmark (used to locate the address)  
addresses.eventID Number The name of an event scheduled for the address  
addresses.fullAddress String The full address  
addresses.houseFractionEnd String Indicates the ending fraction of a street number, specified by the houseNumberEnd property. Used with the houseFractionStart property to locate an address.  
addresses.houseFractionStart String Indicates the starting fraction of a street number, specified by the houseNumberStart property. Used with the houseFractionEnd property to locate an address.  
addresses.houseNumberAlphaEnd String Indicates the ending street number that makes up the address. The street number can consist of alphanumeric characters. For example, if the street is 10-23A WHITESTONE, 23A is the ending street number.  
addresses.houseNumberAlphaStart String Indicates the beginning street number that makes up the address. The street number can consist of alphanumeric characters. For example, if the street is 10-23A WHITESTONE, 10 is the beginning street number.  
addresses.houseNumberEnd Number Specifies the ending house number in a range of house numbers. Used with the houseNumberStart property to specify a range of numbers to search from within when looking for an address.  
addresses.houseNumberEndFrom String Specifies the range search From field of Street # (End). Can only be used as a search criterion.  
addresses.houseNumberEndTo String Specifies the range search To field of Street # (End). Can only be used as a search criterion.  
addresses.houseNumberStart Number Specifies the starting house number in a range of house numbers. Used with the houseNumberEnd property to specify a range of numbers to search from within when looking for an address.  
addresses.houseNumberStartFrom String Specifies the range search From field of Street # (Start). Can only be used as a search criterion.  
addresses.houseNumberStartTo String Specifies the range search To field of Street # (Start). Can only be used as a search criterion.  
addresses.inspectionDistrict String The inspection district within which the address exists  
addresses.inspectionDistrictPrefix String The prefix for the inspection district within which the address exists  
addresses.levelNumberEnd String Indicates the ending level number (floor number) that makes up the address within a complex, used to identify a floor or level of a multi-story building/sub-complex.  
addresses.levelNumberStart String Indicates the beginning level number (floor number) that makes up the address within a complex, used to identify a floor or level of a multi-story building/sub-complex.  
addresses.levelPrefix String Indicates the prefix for the level numbers (floor numbers) that make up the address.  
addresses.lot String The name of the lot within which the address resides  
addresses.neighborhood String The name of the neighborhood within which the address exists  
addresses.neighborhoodPrefix String The prefix for the neighborhood within which the address exists  
addresses.primaryFlag String Indicates whether the address is the primary residence or business location associated with a record. Only one address can be the primary address.  
addresses.refAddressType String The name of the address type. In Accela Automation, you set address types through the REF_ADDRESS_TYPE standard choice. The available values include: Parcel Address, Street ROW Address, Asset Address, and so forth.  
addresses.secondaryRoad String The road name of the secondary address  
addresses.secondaryRoadNumber Number The number of the secondary address  
addresses.sourceFlag String A code indicating the Accela application (Accela Automation, Kiva, or Tidemark, for example) that stores address information  
addresses.state String A two letter abbreviation for the state in which the address exists  
addresses.streetDirection String The street direction of the primary address (N for North Broadway, for example)  
addresses.streetName String The street name for the primary address.  
addresses.streetPrefix String The street prefix for the primary address  
addresses.streetSuffix String The street suffix for the primary address, such as Street, Avenue, or Boulevard  
addresses.streetSuffixdirection String Street Suffix Direction  
addresses.subdivision String The name of the subdivision  
addresses.unitEnd String The ending unit number, in a range of units, specified in a search  
addresses.unitStart String The beginning unit number, in a range of units, specified in a search  
addresses.unitType String The type of structure for this address, for example, apartment or condo  
addresses.zip String The zip code for the address  
addresses.userDefinedFields Array Contains address template custom fields  
addresses.userDefinedFields.fieldName String A custom field name  
addresses.userDefinedFields.fieldValue String A custom field value  
totalRecords integer The total number of records that match the search criteria  
Parameter Type Required Description
settings settings { } No The settings object containing settings request parameters.
settings.maxRows integer No The maximum number of rows to be returned.

Note: If the search results are greater than the feature count limit configured on GIS Administration > XAPO Configuration, the API returns an error indicating the exceeded feature count limit. In this case, the API caller should re-submit the query with a narrower criteria or set the maxRows page setting to a number less than the feature count limit.
settings.startRow integer No The 1-based row index of the first record to be returned.
settings.orderBy String No The returned rows will be sorted by the specified field(s) in the specified order. The format is <field> <order>, where <order> is either ASC for ascending or DESC for descending order. The default order is ascending.

To specify multiple fields, use the format: <field1> <order>, <fieldN> <order>

For example: "streetName ASC,houseNumberStart DESC"

Sample Request

The following example searches an address.

http://[GISBASEURL]/agis/api/geo/v1/xapo/flagstaff/addresses/byaddress

Sample request body:

{
   "address":    {
      "streetName": "Graylawn",
      "houseNumberStart": "25",
      "secondaryRoad": "Ave",
      "city": "Petaluma",
      "zip": "94952"
   }
}

Sample Response

{
  "result": [
    {
      "UID": "006433006",
      "addressLine1": "25",
      "city": "PETALUMA",
      "eventID": "11800",
      "houseNumberStart": "25",
      "secondaryRoad": "AVE",
      "state": "CA",
      "streetDirection": " ",
      "streetName": "GRAYLAWN",
      "streetSuffix": " ",
      "zip": "94952"
    }
  ],
  "totalRecords": 1
}