Search Owners by Parcel
Returns owners associated with the specified parcel.
Search Owners by Parcel is equivalent to the legacy Accela GIS SOAP API getExternalOwnerByParcel.
For an overview, see Owners.
URI
POST /api/geo/v1/xapo/{agencyId}/owners/byParcel
{
"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"
}
}{
"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"
}| 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: For example: |
| 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 |
The following example searches the owner of a parcel.
http://[GISBASEURL]/agis/api/geo/v1/xapo/flagstaff/owners/byParcelSample request body:
{
"parcel":
{
"CENSUSTRACT":"6294.207"
}
}{
"result": [
{
"UID": "006433006",
"address": " ",
"eventID": "11800",
"ivrPinNumber": "006",
"ownerFirstName": "SALAND",
"ownerFullName": "SALAND",
"ownerLastName": "DAVID",
"ownerMiddleName": "K",
"phone": "43",
"taxID": "006433006"
}
],
"totalRecords": 1
}