Get all parcels
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcels
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:- AltKey: Finds a parcel that matches the specified alternate key criteria.
Finder Variables:- ParcelIdEntered; string; The unique identifier for the parcel.
- PrimaryKey: Finds a parcel that matches the specified primary key criteria.
Finder Variables:- ParcelId; integer; The unique identifier for the parcel.
- simpleSearchFinder: Finds a parcel that matches the specified value.
Finder Variables:- value; string; The unique identifier for the parcel.
- AltKey: Finds a parcel that matches the specified alternate 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:- AdditionalStructure; string; The information about additional structures located on the parcel.
- Bathrooms; string; The number of bathrooms for the building on the parcel.
- Bedrooms; string; The number of bedrooms for the building on the parcel.
- BlockNumber; string; The block number of the parcel.
- BookNumber; string; The book number of the parcel.
- BoundaryDescription; string; The boundary description of the parcel.
- CensusBlock; string; The neighbourhood information related to the location of the parcel.
- CensusTract; string; The neighbourhood information related to the location of the parcel.
- ClimateZone; string; The detailed climate zone of the parcel.
- CoordinateX; number; Indicates the x coordinate of the parcel.
- CoordinateY; number; Indicates the y coordinate of the parcel.
- DwellingUnitCount; integer; The number of dwelling units for the parcel.
- EnabledFlag; boolean; Indicates whether the parcel is available to be used. The default value is N.
- FinalParcelIdEntered; string; The final parcel number.
- FireRisk; string; The fire risk associated with the parcel.
- FloodInsRateMap; string; The flood insurance rate map related to the parcel location for floodplain management and insurance purposes.
- FloodZone; string; The detailed flood zone of the parcel.
- GeneralPlanTwo; string; The alternate land Information of the parcel.
- Jurisdiction; string; The jurisdiction of the parcel.
- LandUseCode; string; The land use code of the parcel.
- LandslideRisk; string; The landslide risk associated with the parcel.
- Latitude; number; The latitude of the parcel.
- LiquefactionRisk; string; The liquefaction risk associated with the parcel.
- Longitude; number; The longitude of the parcel.
- LotNumber; string; The lot number of the parcel.
- MapBookPage; string; Tthe map book page of the parcel.
- MapName; string; The map name of the parcel.
- PageNumber; string; The page number of the parcel.
- ParcelId; integer; The unique identifier for the parcel.
- ParcelIdEntered; string; The parcel number.
- ParcelSizeOne; number; The first parcel size.
- ParcelSizeOneUnit; string; The unit of measure for the first parcel size.
- ParcelSizeTwo; number; The second parcel size.
- ParcelSizeTwoUnit; string; The unit of measure for the second parcel size.
- ParcelStatus; string; The status of the parcel which can be either Final or Provisional.
- ParcelType; string; The type of parcel.
- ParcelUnitNumber; string; The unit number of the parcel.
- ParentParcelId; integer; The unique identifier for the parent of the parcel.
- Patio; string; The information about patios located on the parcel.
- Pool; string; The information about pools located on the parcel.
- PrimaryZoningId; string; The unique identifier for the primary zoning of the parcel.
- PropertyDescription; string; The property description of the parcel.
- ProvParcelIdEntered; string; The provisional parcel number.
- SectionNumber; string; The section number of the parcel.
- SoilType; string; The soil type associated with the parcel.
- Srid; integer; The spatial reference identifier. This is a unique coordinate identifier for a local, regional, or global system used to locate geographical or spatial entities within geographic information systems.
- StructureSizeOne; number; The first structure size.
- StructureSizeOneUnit; string; The unit of measure for the first structure size.
- StructureSizeTwo; number; The second structure size.
- StructureSizeTwoUnit; string; The unit of measure for the second structure size.
- Subdivision; string; The subdivision of the parcel.
- TaxRateArea; string; The area identifier of the parcel location for taxation purposes.
- YearBuilt; string; The year in which the building on the parcel was built.
- ZoningCodeTwo; string; The secondary code of the zoning related to the parcel.
- ZoningDescription; string; The zoning description of the parcel.
-
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(required):
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(required):
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 : publicSectorParcels
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 : publicSectorParcels-item-response
Type:
Show Source
object
-
AdditionalStructure: string
Title:
Additional Structure
Maximum Length:200
The information about additional structures located on the parcel. -
Bathrooms: string
Title:
Bathrooms
Maximum Length:20
The number of bathrooms for the building on the parcel. -
Bedrooms: string
Title:
Bedrooms
Maximum Length:20
The number of bedrooms for the building on the parcel. -
BlockNumber: string
Title:
Block Number
Maximum Length:30
The block number of the parcel. -
BookNumber: string
Title:
Book Number
Maximum Length:30
The book number of the parcel. -
BoundaryDescription: string
Title:
Boundary Description
Maximum Length:480
The boundary description of the parcel. -
CensusBlock: string
Title:
Census Block
Maximum Length:100
The neighbourhood information related to the location of the parcel. -
CensusTract: string
Title:
Census Tract
Maximum Length:100
The neighbourhood information related to the location of the parcel. -
ClimateZone: string
Title:
Climate Zone
Maximum Length:200
The detailed climate zone of the parcel. -
CoordinateX: number
Title:
X Coordinate
Indicates the x coordinate of the parcel. -
CoordinateY: number
Title:
Y Coordinate
Indicates the y coordinate of the parcel. -
DwellingUnitCount: integer
(int64)
Title:
Number of Dwelling Units
The number of dwelling units for the parcel. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the parcel is available to be used. The default value is N. -
FinalParcelIdEntered: string
Maximum Length:
30
The final parcel number. -
FireRisk: string
Title:
Fire Risk
Maximum Length:200
The fire risk associated with the parcel. -
FloodInsRateMap: string
Title:
Flood Insurance Rate Map
Maximum Length:200
The flood insurance rate map related to the parcel location for floodplain management and insurance purposes. -
FloodZone: string
Title:
Flood Zone
Maximum Length:200
The detailed flood zone of the parcel. -
GeneralPlanTwo: string
Title:
General Plan 2
Maximum Length:30
The alternate land Information of the parcel. -
Jurisdiction: string
Title:
Jurisdiction
Maximum Length:50
The jurisdiction of the parcel. -
LandslideRisk: string
Title:
Landslide Risk
Maximum Length:200
The landslide risk associated with the parcel. -
LandUseCode: string
Title:
General Plan
Maximum Length:30
The land use code of the parcel. -
Latitude: number
Title:
Latitude
The latitude of the parcel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LiquefactionRisk: string
Title:
Liquefaction Risk
Maximum Length:200
The liquefaction risk associated with the parcel. -
Longitude: number
Title:
Longitude
The longitude of the parcel. -
LotNumber: string
Title:
Lot Number
Maximum Length:30
The lot number of the parcel. -
MapBookPage: string
Title:
Map Book Page
Maximum Length:50
Tthe map book page of the parcel. -
MapName: string
Title:
Map Name
Maximum Length:50
The map name of the parcel. -
PageNumber: string
Title:
Page Number
Read Only:true
Maximum Length:30
The page number of the parcel. -
ParcelId: integer
(int64)
Title:
Parcel ID
The unique identifier for the parcel. -
ParcelIdEntered: string
Title:
Parcel Number
Maximum Length:30
The parcel number. -
ParcelSizeOne: number
Title:
Parcel Size 1
The first parcel size. -
ParcelSizeOneUnit: string
Title:
Parcel Size 1 UOM
Maximum Length:10
The unit of measure for the first parcel size. -
ParcelSizeTwo: number
Title:
Parcel Size 2
The second parcel size. -
ParcelSizeTwoUnit: string
Title:
Parcel Size 2 UOM
Maximum Length:10
The unit of measure for the second parcel size. -
ParcelStatus: string
Title:
Status
Maximum Length:20
The status of the parcel which can be either Final or Provisional. -
ParcelType: string
Title:
Parcel Type
Maximum Length:30
The type of parcel. -
ParcelUnitNumber: string
Title:
Unit Number
Maximum Length:30
The unit number of the parcel. -
ParentParcelId: integer
(int64)
Title:
Parent Parcel ID
Read Only:true
The unique identifier for the parent of the parcel. -
Patio: string
Title:
Patio
Maximum Length:200
The information about patios located on the parcel. -
Pool: string
Title:
Pool
Maximum Length:200
The information about pools located on the parcel. -
PrimaryZoningId: string
Title:
Zoning Code
Maximum Length:30
The unique identifier for the primary zoning of the parcel. -
PropertyDescription: string
Title:
Property Description
Maximum Length:240
The property description of the parcel. -
ProvParcelIdEntered: string
Maximum Length:
30
The provisional parcel number. -
SectionNumber: string
Title:
Section Number
Maximum Length:30
The section number of the parcel. -
SoilType: string
Title:
Soil Type
Maximum Length:200
The soil type associated with the parcel. -
Srid: integer
(int64)
Read Only:
true
The spatial reference identifier. This is a unique coordinate identifier for a local, regional, or global system used to locate geographical or spatial entities within geographic information systems. -
StructureSizeOne: number
Title:
Structure Size 1
The first structure size. -
StructureSizeOneUnit: string
Title:
Structure Size 1 UOM
Maximum Length:10
The unit of measure for the first structure size. -
StructureSizeTwo: number
Title:
Structure Size 2
The second structure size. -
StructureSizeTwoUnit: string
Title:
Structure Size 2 UOM
Maximum Length:10
The unit of measure for the second structure size. -
Subdivision: string
Title:
Subdivision
Maximum Length:30
The subdivision of the parcel. -
TaxRateArea: string
Title:
Tax Rate Area
Maximum Length:100
The area identifier of the parcel location for taxation purposes. -
YearBuilt: string
Title:
Year Built
Maximum Length:4
The year in which the building on the parcel was built. -
ZoningCodeTwo: string
Title:
Zoning Code 2
Maximum Length:30
The secondary code of the zoning related to the parcel. -
ZoningDescription: string
Title:
Zoning Description
Maximum Length:240
The zoning description of the parcel.
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.