Get all record parcels and related parcel information
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcelProperties
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a record parcel using the specified primary key criteria.
Finder Variables:- ParcelKey; integer; The unique identifier for a parcel.
- PrimaryKey: Finds a record parcel using the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The unique identifier for a public sector agency associated with the parcel address.
- BlockNumber; string; The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
- BookNumber; string; The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
- BoundaryDescription; string; A textual description of the property boundaries. This is not a listing of coordinates. For example, SMITH LOT - COME E 155 FT FROM SW CORNER OF LOT 206 THEN 77.5 FT N TO A LINE WHICH EXTENDS FROM A PT N 309.91 FT AND E 55.25 FT FROM BEG TO A PT E 155 FT FROM LOT 206.
- CreationDate; string; The date when the record parcel was created.
- DistrictName; string; The district name of the parcel.
- FixtureExemption; number; The exempted fixture information of the parcel.
- Fixtures; number; The fixtures associated with the parcel.
- ImprovementValue; number; The improvement value of the parcel.
- Jurisdiction; string; The name of the city, if incorporated, or the name of the county, if unincorporated.
- LandUseCode; string; The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
- LandValue; number; The land value of the parcel.
- LastUpdateDate; string; The date when the record parcel was last updated.
- Latitude; number; The geographic location of the parcel that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
- LnpRecordId; string; The unique identifier for the application record.
- LnpRecordKey; integer; The unique identifier for the record associated with the parcel.
- Longitude; number; The geographic location of the parcel that is north or south of the equator.
- LotNumber; string; The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
- MapBookPage; string; The recorded map book and page.
- MapName; string; The recorded map name. For example, Public Works.
- NetAssessedValues; number; The net assessed value of the parcel.
- OtherExemption; number; Any additional exemptions for the parcel.
- OwnerExemption; number; The exempted owner information of the parcel.
- PageNumber; string; The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
- ParcelId; integer; The unique identifier of the record parcel.
- ParcelIdEntered; string; The Assessor Parcel Number (APN) as entered by the user.
- ParcelKey; integer; The unique identifier for a parcel.
- ParcelSizeOne; number; The first parcel size.
- ParcelSizeOneUOM; string; The unit of measure for the first parcel size.
- ParcelType; string; The type of the parcel. For example, commercial, residential, or government.
- ParentParcelId; integer; The unique identifier for the parent record parcel.
- PersonalPropertyValue; number; The personal property value of the parcel.
- PrimaryFlag; boolean; Indicates the primary parcel. If the value is Y, then the parcel is the primary parcel. The default value is N.
- PrimaryParcelAddress; string; The address of the primary parcel address.
- PrimaryParcelCity; string; The city in the primary parcel address.
- PrimaryParcelState; string; The state in the primary parcel address.
- PrimaryZoningId; string; The primary zoning ID of the zoning for the parcel.
- PropertyDescription; string; The property description.
- SectionNumber; string; The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
- Srid; integer; The GIS coordinate system in use.
- Subdivision; string; The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
- UnitNumber; string; The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN).
- ZoningDescription; string; The zoning description.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorParcelProperties
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorParcelProperties-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for a public sector agency associated with the parcel address. -
BlockNumber: string
Title:
Block
Maximum Length:30
The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
BookNumber: string
Title:
Book
Maximum Length:30
The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
BoundaryDescription: string
Title:
Boundary Description
Maximum Length:480
A textual description of the property boundaries. This is not a listing of coordinates. For example, SMITH LOT - COME E 155 FT FROM SW CORNER OF LOT 206 THEN 77.5 FT N TO A LINE WHICH EXTENDS FROM A PT N 309.91 FT AND E 55.25 FT FROM BEG TO A PT E 155 FT FROM LOT 206. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record parcel was created. -
DistrictName: string
Title:
District
Maximum Length:50
The district name of the parcel. -
FixtureExemption: number
Title:
Fixture Exemption
Read Only:true
The exempted fixture information of the parcel. -
Fixtures: number
Title:
Fixtures
Read Only:true
The fixtures associated with the parcel. -
ImprovementValue: number
Title:
Improvement Value
Read Only:true
The improvement value of the parcel. -
Jurisdiction: string
Title:
Jurisdiction
Maximum Length:50
The name of the city, if incorporated, or the name of the county, if unincorporated. -
LandUseCode: string
Title:
Land Use
Maximum Length:30
The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
LandValue: number
Title:
Land Value
Read Only:true
The land value of the parcel. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record parcel was last updated. -
Latitude: number
Title:
Latitude
The geographic location of the parcel that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The unique identifier for the application record. -
LnpRecordKey: integer
(int64)
Title:
Record
The unique identifier for the record associated with the parcel. -
Longitude: number
Title:
Longitude
The geographic location of the parcel that is north or south of the equator. -
LotNumber: string
Title:
Lot
Maximum Length:30
The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
MapBookPage: string
Title:
Map Book Page
Maximum Length:50
The recorded map book and page. -
MapName: string
Title:
Map Name
Maximum Length:50
The recorded map name. For example, Public Works. -
NetAssessedValues: number
Title:
Net Assessed Value
Read Only:true
The net assessed value of the parcel. -
OtherExemption: number
Title:
Other Exemption
Read Only:true
Any additional exemptions for the parcel. -
OwnerExemption: number
Title:
Owner Exemption
Read Only:true
The exempted owner information of the parcel. -
PageNumber: string
Title:
Page
Maximum Length:30
The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
ParcelId: integer
(int64)
Title:
Parcel
The unique identifier of the record parcel. -
ParcelIdEntered: string
Title:
Parcel
Maximum Length:30
The Assessor Parcel Number (APN) as entered by the user. -
ParcelKey: integer
(int64)
Title:
Parcel Key
The unique identifier for a parcel. -
ParcelSizeOne: number
Title:
Parcel Size
Read Only:true
The first parcel size. -
ParcelSizeOneUOM: string
Read Only:
true
Maximum Length:3
The unit of measure for the first parcel size. -
ParcelType: string
Title:
Parcel Type
Maximum Length:30
The type of the parcel. For example, commercial, residential, or government. -
ParentParcelId: integer
(int64)
Title:
Parent Parcel
The unique identifier for the parent record parcel. -
PersonalPropertyValue: number
Title:
Personal Property Value
Read Only:true
The personal property value of the parcel. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates the primary parcel. If the value is Y, then the parcel is the primary parcel. The default value is N. -
PrimaryParcelAddress: string
Read Only:
true
Maximum Length:240
The address of the primary parcel address. -
PrimaryParcelCity: string
Read Only:
true
Maximum Length:60
The city in the primary parcel address. -
PrimaryParcelState: string
Read Only:
true
Maximum Length:6
The state in the primary parcel address. -
PrimaryZoningId: string
Title:
Primary Zone
Maximum Length:30
The primary zoning ID of the zoning for the parcel. -
PropertyDescription: string
Title:
Property Description
Maximum Length:240
The property description. -
SectionNumber: string
Title:
Section
Maximum Length:30
The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
Srid: integer
(int64)
Title:
SRID
The GIS coordinate system in use. -
Subdivision: string
Title:
Subdivision
Maximum Length:30
The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
UnitNumber: string
Title:
Unit
Maximum Length:30
The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
ZoningDescription: string
Title:
Zone Description
Maximum Length:240
The zoning description.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- getParcelCountInformation
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorParcelProperties/action/getParcelCountInformationGets all record parcel count using the specified parameter values.