Search Parcels by Multiple
Returns parcels associated with the specified address, parcel, and/or owner objects. Specify at least one request object.
Note: This API performs combinations of spatial queries per query object specified in the
request body. The performance is dependent on the combinations of request objects and amount
of data. If your application searches parcels based on either an address, parcel, or object,
call Search Parcels by Parcel,
Search Parcels by Owner, or
Search Parcels by Address
instead.
Search Parcels by Multiple Objects is equivalent to the legacy Accela GIS SOAP API getParcelsByMultipleModels.
For an overview, see Parcels.
URI
POST /api/geo/v1/xapo/{agencyId}/parcels/byMultiple
{
"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"
}
]
},
"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"
}
]
},
"owner" :
{
"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"
}
]
},
"settings":
{
"maxRows": "int",
"startRow": "int",
"orderBy": "string"
}
}{
"result": [
{
"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"
}
]
},
{
"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"
}
]
}
],
"totalRecords": "int"
}| 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 |
|---|---|---|---|
| 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 |
|---|---|---|---|
| agencyId | String | Yes | The required agency parameter. The XAPO field mapping must be configured for the requested agency on the GIS Admin site. |
| owner | owner { } | Yes | The owner JSON object containing owner request parameters. |
| owner.UID | String | No | A unique identifier for the external owner |
| owner.address | String | No | The Address field from the Reference Owner List |
| owner.address1 | String | No | The first line of the owner's address |
| owner.address2 | String | No | The second line of the owner's address |
| owner.address3 | String | No | The third line of the owner's address |
| owner.auditDate | Date | Yes | The creation date or modification date of the owner record |
| owner.auditID | String | Yes | The identification code of the person who created or modified the owner record |
| owner.auditStatus | String | No | A single character code representing audit status |
| owner.city | String | No | The city in which the owner lives |
| owner.country | String | No | The country in which the owner lives |
| owner.email | String | No | The owner’s email address |
| owner.eventID | String | No | Any event scheduled for this owner |
| owner.fax | String | No | The owner’s fax number |
| owner.faxCountryCode | String | No | 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. |
| owner.isPrimary | String | No | Is Primary |
| owner.ivrPinNumber | No | The user’s IVR Pin Number | |
| owner.ivrUserNumber | No | The automatically generated IVR user number | |
| owner.mailAddress | No | ||
| owner.mailAddress1 | String | No | The first line of the owner’s mailing address |
| owner.mailAddress2 | String | No | The second line of the owner’s mailing address |
| owner.mailAddress3 | String | No | The third line of the owner’s mailing address |
| owner.mailCity | String | No | The city of the owner’s mailing address |
| owner.mailCountry | String | No | The country of the owner’s mailing address |
| owner.mailState | String | No | The state of the owner’s mailing address |
| owner.mailZip | String | No | The zip code of the owner’s mailing address |
| owner.ownerFirstName | String | No | The owner’s first name |
| owner.ownerFullName | String | No | The owner’s full name |
| owner.ownerLastName | String | No | The owner’s last name |
| owner.ownerMiddleName | String | No | The owner’s middle name |
| owner.ownerStatus | String | No | The status of the owner, either disabled (I) or enabled (A) |
| owner.ownerTitle | String | No | The owner’s title |
| owner.phone | String | No | The owner's daytime telephone number |
| owner.phoneCountryCode | String | No | 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. |
| owner.sourceSeqNumber | NA | No | The ID number that you use to identify the owner in the external APO database |
| owner.state | String | No | The configured state name in which the address exists |
| owner.taxID | String | No | The owner’s tax ID |
| owner.zip | String | No | The zip code for the owner’s address |
| owner.userDefinedFields | Array | No | Contains owner template custom fields |
| owner.userDefinedFields.fieldName | String | No | A custom field name |
| owner.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: For example: |
| Parameter | Type | Description | |
|---|---|---|---|
| parcels [ ] | parcels{ } | An array containing the result parcels. | |
| parcels.UID | String | A unique identifier for the external parcel | |
| parcels.auditDate | String | The creation date or modification date of the parcel record | |
| parcels.auditID | String | The identification code of the person who created or modified the parcel record | |
| parcels.auditStatus | String | A single character code representing audit status | |
| parcels.block | String | 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. | |
| parcels.book | String | A reference to the physical location of this parcel from the County Assessor or other responsible department | |
| parcels.censusTract | String | The unique number, assigned by the Census Bureau, that identifies the tract to which this parcel belongs | |
| parcels.councilDistrict | String | The council district to which the parcel belongs | |
| parcels.eventID | Number | Any event scheduled for this parcel | |
| parcels.exemptValue | String | The total value of tax exemptions that apply to land within the parcel | |
| parcels.improvedValue | String | The total value of improvements to land within the parcel | |
| parcels.inspectionDistrict | String | The inspection district to which the parcel belongs | |
| parcels.landValue | String | The total value of land within the parcel | |
| parcels.legalDesc | String | The legal description of the parcel, the parcel bounds, parcel characteristics, or a reference to official documents that contain the legal description | |
| parcels.lot | String | The name or boundaries of the lot associated with the parcel record | |
| parcels.mapNo | String | The unique map number that identifies the map for this parcel | |
| parcels.mapRef | String | The reference to map location for this parcel, such as a map book | |
| parcels.page | String | 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. | |
| parcels.parcel | String | 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. | |
| parcels.parcelArea | String | The total area of the parcel in the unit of measure configured for your agency | |
| parcels.parcelNumber | String | The parcel number, determined by the county assessor or determined by another responsible department | |
| parcels.parcelStatus | String | Indicates availability of parcel information in Accela Automation. Mark as enable (A), disable (I), or pending (P). | |
| parcels.planArea | String | The plan area in which the parcel belongs | |
| parcels.primaryParcelFlag | String | When a record has more than one parcel associated with it, designate one of the parcels as the primary parcels. Mark as the primary parcel (Y) or not the primary parcel (N). | |
| parcels.range | String | A number assigned to a range of parcels. | |
| parcels.section | Number | A number assigned to a section of parcels, 78 for example | |
| parcels.sourceSeqNumber | String | The ID number that you use to identify the parcel in the external APO database | |
| parcels.subdivision | String | The name of the subdivision | |
| parcels.supervisorDistrict | String | The supervisor district to which the parcel belongs | |
| parcels.township | String | The name of the township | |
| parcels.tract | String | The tract name associated with the parcel | |
| parcels.userDefinedFields | Array | Contains parcel template custom fields | |
| parcels.userDefinedFields.fieldName | String | A custom field name | |
| parcels.userDefinedFields.fieldValue | String | A custom field value | |
| totalRecords | integer | The total number of records that match the search criteria |
The following example searches parcels for an owner and address.
http://[GISBASEURL]/agis/api/geo/v1/xapo/flagstaff/parcels/byMultipleSample request body:
{
"owner" : {
"ownerfullname":"Saland",
"ownerlastname":"David",
"ownermiddlename":"K"
},
"address": {
"streetName": "Graylawn",
"houseNumberStart": "25",
"secondaryRoad": "Ave",
"city": "Petaluma",
"zip": "94952"
},
"settings":
{
"maxRows": "3",
"startRow": "1"
}
}{
"result": [
{
"UID": "006433006",
"censusTract": "6294.207",
"exemptValue": "6065",
"landValue": "006#43",
"parcel": "006433006",
"parcelNumber": "006433006",
"planArea": "0",
"section": "11668",
"subdivision": "006",
"township": "6065"
}
],
"totalRecords": 1
}