Search Parcels by Parcel

Returns parcels that match the specified parcel fields.

Get Parcels by Parcel Keys is equivalent to the legacy Accela GIS SOAP API getParcelBySearchKeys.

For an overview, see Parcels.

URI

POST /api/geo/v1/xapo/{agencyId}/parcels/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",
  "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.
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  
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 a parcel on a census tract.

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

Sample request body:

{
   "parcel": {
        "CENSUSTRACT":"6294.207"
   }
}

Sample Response

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