Search Parcels by Owner

Returns parcels associated with the specified owner.

Get Parcels by Owner is equivalent to the legacy Accela GIS SOAP API getExternalParcelByOwner.

For an overview, see Parcels.

URI

POST /api/geo/v1/xapo/{agencyId}/parcels/byOwner

Request JSON Syntax

{
  "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"
  }
  }

Response JSON Syntax

{
  "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"
  }

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.
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: <field1> <order>, <fieldN> <order>

For example: "streetName ASC,houseNumberStart DESC"

Response Field Descriptions

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  

Sample Request

The following example searches parcels with the same owner.

http://[GISBASEURL]/agis/api/geo/v1/xapo/flagstaff/parcels/byOwner

Sample request body:

{
 "owner" :
 {
	"ownerfullname":"Saland",	
	"ownerlastname":"David",	
	"ownermiddlename":"K"	
 }
}

Sample Response

{
  "result": [
    {
      "UID": "006423031",
      "censusTract": "6724.61615",
      "exemptValue": "5792",
      "landValue": "006#42",
      "parcel": "006423031",
      "parcelNumber": "006423031",
      "planArea": "0",
      "section": "10642",
      "subdivision": "006",
      "township": "5792"
    },
    {
      "UID": "006433008",
      "censusTract": "5704.10715",
      "exemptValue": "6110",
      "landValue": "006#43",
      "parcel": "006433008",
      "parcelNumber": "006433008",
      "planArea": "0",
      "section": "11598",
      "subdivision": "006",
      "township": "6110"
    },
    {
      "UID": "006433006",
      "censusTract": "6294.207",
      "exemptValue": "6065",
      "landValue": "006#43",
      "parcel": "006433006",
      "parcelNumber": "006433006",
      "planArea": "0",
      "section": "11668",
      "subdivision": "006",
      "township": "6065"
    }
  ],
  "totalRecords": 4
}