Search Owners by Address

Returns owners associated with the specified address.

Get Owners by Address is equivalent to the legacy Accela GIS SOAP API getExternalOwnerByAddress.

For an overview, see Owners.

URI

POST /api/geo/v1/xapo/{agencyId}/owners/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",
 "address": "string",
 "address1": "string",
 "address2": "string",
 "address3": "string",
 "auditDate": "string",
 "auditID": "string",
 "auditStatus": "string",
 "city": "string",
 "country": "string",
 "email": "string",
 "eventID": "string",
 "fax": "string",
 "faxCountryCode": "string",
 "isPrimary": "string",
 "ivrPinNumber": "string",
 "ivrUserNumber": "string",
 "mailAddress": "string",
 "mailAddress1": "string",
 "mailAddress2": "string",
 "mailAddress3": "string",
 "mailCity": "string",
 "mailCountry": "string",
 "mailState": "string",
 "mailZip": "string",
 "ownerFirstName": "string",
 "ownerFullName": "string",
 "ownerLastName": "string",
 "ownerMiddleName": "string",
 "ownerStatus": "string",
 "ownerTitle": "string",
 "phone": "string",
 "phoneCountryCode": "string",
 "sourceSeqNumber": "string",
 "state": "string",
 "taxID": "string",
 "zip": "string",
  "userDefinedFields": [
     {
       "fieldName":"string",
       "fieldValue":"string"
     },
     {
       "fieldName":"string",
       "fieldValue":"string"
     }
  ]
 },
 {
 "UID": "string",
 "address": "string",
 "address1": "string",
 "address2": "string",
 "address3": "string",
 "auditDate": "string",
 "auditID": "string",
 "auditStatus": "string",
 "city": "string",
 "country": "string",
 "email": "string",
 "eventID": "string",
 "fax": "string",
 "faxCountryCode": "string",
 "isPrimary": "string",
 "ivrPinNumber": "string",
 "ivrUserNumber": "string",
 "mailAddress": "string",
 "mailAddress1": "string",
 "mailAddress2": "string",
 "mailAddress3": "string",
 "mailCity": "string",
 "mailCountry": "string",
 "mailState": "string",
 "mailZip": "string",
 "ownerFirstName": "string",
 "ownerFullName": "string",
 "ownerLastName": "string",
 "ownerMiddleName": "string",
 "ownerStatus": "string",
 "ownerTitle": "string",
 "phone": "string",
 "phoneCountryCode": "string",
 "sourceSeqNumber": "string",
 "state": "string",
 "taxID": "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
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"

Response Field Descriptions

Parameter Type Description  
owners [ ] owners{ } An array containing the result owners.  
owners.UID String A unique identifier for the external owner  
owners.address String The Address field from the Reference Owner List  
owners.address1 String The first line of the owner's address  
owners.address2 String The second line of the owner's address  
owners.address3 String The third line of the owner's address  
owners.auditDate Date The creation date or modification date of the owner record  
owners.auditID String The identification code of the person who created or modified the owner record  
owners.auditStatus String A single character code representing audit status  
owners.city String The city in which the owner lives  
owners.country String The country in which the owner lives  
owners.email String The owner’s email address  
owners.eventID String Any event scheduled for this owner  
owners.fax String The owner’s fax number  
owners.faxCountryCode String The three character code indicating the fax country. In Accela Automation, you enable the fax country codes through the PHONE_NUMBER_IDD_ENABLE standard choice.  
owners.isPrimary String Is Primary  
owners.ivrPinNumber String The user’s IVR Pin Number  
owners.ivrUserNumber String The automatically generated IVR user number  
owners.mailAddress String The mailing address  
owners.mailAddress1 String The first line of the owner’s mailing address  
owners.mailAddress2 String The second line of the owner’s mailing address  
owners.mailAddress3 String The third line of the owner’s mailing address  
owners.mailCity String The city of the owner’s mailing address  
owners.mailCountry String The country of the owner’s mailing address  
owners.mailState String The state of the owner’s mailing address  
owners.mailZip String The zip code of the owner’s mailing address  
owners.ownerFirstName String The owner’s first name  
owners.ownerFullName String The owner’s full name  
owners.ownerLastName String The owner’s last name  
owners.ownerMiddleName String The owner’s middle name  
owners.ownerStatus String The status of the owner, either disabled (I) or enabled (A)  
owners.ownerTitle String The owner’s title  
owners.phone String The owner's daytime telephone number  
owners.phoneCountryCode String The three character code indicating the phone country. In Accela Automation, you enable the phone country codes through the PHONE_NUMBER_IDD_ENABLE standard choice.  
owners.sourceSeqNumber NA The ID number that you use to identify the owner in the external APO database  
owners.state String The configured state name in which the address exists  
owners.taxID String The owner’s tax ID  
owners.zip String The zip code for the owner’s address  
owners.userDefinedFields Array Contains owner template custom fields  
owners.userDefinedFields.fieldName String A custom field name  
owners.userDefinedFields.fieldValue String A custom field value  
totalRecords integer The total number of records that match the search criteria  

Sample Request

The following example searches the owner of an address.

http://[GISBASEURL]/agis/api/geo/v1/xapo/flagstaff/owners/byAddress

Sample request body:

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

Sample Response

{
  "result": [
    {
      "UID": "006433006",
      "address": " ",
      "eventID": "11800",
      "ivrPinNumber": "006",
      "ownerFirstName": "SALAND",
      "ownerFullName": "SALAND",
      "ownerLastName": "DAVID",
      "ownerMiddleName": "K",
      "phone": "43",
      "taxID": "006433006"
    }
  ],
  "totalRecords": 1
}