Search Parcel Count

Returns the count of all available parcels (without a filter criteria).

Get All Parcels is equivalent to the legacy Accela GIS SOAP API getParcelRows.

For an overview, see Parcels.

URI

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

Request JSON Syntax

{
  "settings":
  {
  "maxRows": "int",
  "startRow": "int",
  "orderBy": "string"
  }
}

Response JSON Syntax

{
  "result": 
  {
  "count": "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.
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
count integer The total number of parcels

Sample Request

The following example gets the count of all parcels.

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

Sample Response

{
  "result": {
    "count": 20130
  }
}