Get all record parcels and related parcel information
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcelProperties
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorParcelProperties
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorParcelProperties-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The unique identifier for a public sector agency associated with the parcel address. -
BlockNumber(optional):
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(optional):
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(optional):
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. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the record parcel. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the record parcel was created. -
DistrictName(optional):
string
Title:
District
Maximum Length:50
The district name of the parcel. -
FixtureExemption(optional):
number
Title:
Fixture Exemption
The exempted fixture information of the parcel. -
Fixtures(optional):
number
Title:
Fixtures
The fixtures associated with the parcel. -
ImprovementValue(optional):
number
Title:
Improvement Value
The improvement value of the parcel. -
Jurisdiction(optional):
string
Title:
Jurisdiction
Maximum Length:50
The name of the city, if incorporated, or the name of the county, if unincorporated. -
LandUseCode(optional):
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(optional):
number
Title:
Land Value
The land value of the parcel. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the record parcel was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record parcel. -
Latitude(optional):
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(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Record ID
Maximum Length:50
The unique identifier for the application record. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for the record associated with the parcel.
-
Longitude(optional):
number
Title:
Longitude
The geographic location of the parcel that is north or south of the equator. -
LotNumber(optional):
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(optional):
string
Title:
Map Book Page
Maximum Length:50
The recorded map book and page. -
MapName(optional):
string
Title:
Map Name
Maximum Length:50
The recorded map name. For example, Public Works. -
NetAssessedValues(optional):
number
Title:
Net Assessed Value
The net assessed value of the parcel. -
OtherExemption(optional):
number
Title:
Other Exemption
Any additional exemptions for the parcel. -
OwnerExemption(optional):
number
Title:
Owner Exemption
The exempted owner information of the parcel. -
PageNumber(optional):
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(optional):
integer(int64)
Title:
Parcel
The unique identifier of the record parcel. -
ParcelIdEntered(optional):
string
Title:
Parcel
Maximum Length:30
The Assessor Parcel Number (APN) as entered by the user. -
ParcelKey(optional):
integer(int64)
Title:
Parcel Key
The unique identifier for a parcel. -
ParcelSizeOne(optional):
number
Title:
Parcel Size
The first parcel size. -
ParcelSizeOneUOM(optional):
string
Maximum Length:
3
The unit of measure for the first parcel size. -
ParcelType(optional):
string
Title:
Parcel Type
Maximum Length:30
The type of the parcel. For example, commercial, residential, or government. -
ParentParcelId(optional):
integer(int64)
Title:
Parent Parcel
The unique identifier for the parent record parcel. -
PersonalPropertyValue(optional):
number
Title:
Personal Property Value
The personal property value of the parcel. -
PrimaryFlag(optional):
boolean
Title:
Primary
Indicates the primary parcel. If the value is Y, then the parcel is the primary parcel. The default value is N. -
PrimaryParcelAddress(optional):
string
Maximum Length:
240
The address of the primary parcel address. -
PrimaryParcelCity(optional):
string
Maximum Length:
60
The city in the primary parcel address. -
PrimaryParcelState(optional):
string
Maximum Length:
6
The state in the primary parcel address. -
PrimaryZoningId(optional):
string
Title:
Primary Zone
Maximum Length:30
The primary zoning ID of the zoning for the parcel. -
PropertyDescription(optional):
string
Title:
Property Description
Maximum Length:240
The property description. -
SectionNumber(optional):
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(optional):
integer(int64)
Title:
SRID
The GIS coordinate system in use. -
Subdivision(optional):
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(optional):
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(optional):
string
Title:
Zone Description
Maximum Length:240
The zoning description.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.