Search Addresses by Parcel

Returns addresses associated with the specified parcel.

Get Addresses by Parcel is equivalent to the legacy Accela GIS SOAP API getExternalAddressByParcel.

For an overview, see Addresses.

URI

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

Request JSON Syntax

{
  "parcel":
  {
  "UID": "string",
  "auditDate": "string",
  "auditID": "string",
  "auditStatus": "string",
  "block": "string",
  "book": "string",
  "censusTract": "string",
  "councilDistrict": "string",
  "eventID": "string",
  "exemptValue": "string",
  "improvedValue": "string",
  "inspectionDistrict": "string",
  "landValue": "string",
  "legalDesc": "string",
  "lot": "string",
  "mapNo": "string",
  "mapRef": "string",
  "page": "string",
  "parcel": "string",
  "parcelArea": "string",
  "parcelNumber": "string",
  "parcelStatus": "string",
  "planArea": "string",
  "primaryParcelFlag": "string",
  "range": "string",
  "section": "string",
  "sourceSeqNumber": "string",
  "subdivision": "string",
  "supervisorDistrict": "string",
  "township": "string",
  "tract": "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.
parcel parcel { } Yes The parcel JSON object containing parcel request parameters.
parcel.UID String No A unique identifier for the external parcel
parcel.auditDate String Yes The creation date or modification date of the parcel record
parcel.auditID String Yes The identification code of the person who created or modified the parcel record
parcel.auditStatus String No A single character code representing audit status
parcel.block String No The block name or block street number (a rectangular space, usually surrounded by streets) associated with the parcel record. A parcel can contain one or more blocks.
parcel.book String No A reference to the physical location of this parcel from the County Assessor or other responsible department
parcel.censusTract String No The unique number, assigned by the Census Bureau, that identifies the tract to which this parcel belongs
parcel.councilDistrict String No The council district to which the parcel belongs
parcel.eventID Number No Any event scheduled for this parcel
parcel.exemptValue String No The total value of tax exemptions that apply to land within the parcel
parcel.improvedValue String No The total value of improvements to land within the parcel
parcel.inspectionDistrict String No The inspection district to which the parcel belongs
parcel.landValue String No The total value of land within the parcel
parcel.legalDesc String No The legal description of the parcel, the parcel bounds, parcel characteristics, or a reference to official documents that contain the legal description
parcel.lot String No The name or boundaries of the lot associated with the parcel record
parcel.mapNo String No The unique map number that identifies the map for this parcel
parcel.mapRef String No The reference to map location for this parcel, such as a map book
parcel.page String No A reference to the physical location of this parcel from the County Assessor or other responsible department. Used to record the physical location of the parcel description.
parcel.parcel String No A reference to the physical location of this parcel from the County Assessor or other responsible department. Used to record the physical location of the parcel description.
parcel.parcelArea String No The total area of the parcel in the unit of measure configured for your agency
parcel.parcelNumber String No The parcel number, determined by the county assessor or determined by another responsible department
parcel.parcelStatus String No Indicates availability of parcel information in Accela Automation. Mark as enable (A), disable (I), or pending (P).
parcel.planArea String No The plan area in which the parcel belongs
parcel.primaryParcelFlag String No When a record has more than one parcel associated with it, designate one of the parcels as the primary parcel. Mark as the primary parcel (Y) or not the primary parcel (N).
parcel.range String No A number assigned to a range of parcels.
parcel.section Number No A number assigned to a section of parcels, 78 for example
parcel.sourceSeqNumber String No The ID number that you use to identify the parcel in the external APO database
parcel.subdivision String No The name of the subdivision
parcel.supervisorDistrict String No The supervisor district to which the parcel belongs
parcel.township String No The name of the township
parcel.tract String No The tract name associated with the parcel
parcel.userDefinedFields Array No Contains parcel template custom fields
parcel.userDefinedFields.fieldName String No A custom field name
parcel.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  
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  

Sample Request

The following example searches the address of a parcel.

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

Sample request body:

{
   "parcel": {
        "UID": "006383016"
   }
}

Sample Response

{
  "result": [
    {
      "UID": "006383016",
      "addressLine1": "700",
      "city": "PETALUMA",
      "eventID": "756",
      "houseNumberStart": "700",
      "secondaryRoad": "WAY",
      "state": "CA",
      "streetDirection": " ",
      "streetName": "OAK TERRACE",
      "streetSuffix": " ",
      "zip": "94952"
    }
  ],
  "totalRecords": 1
}