Get all parcel values
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcelValues
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:- ParcelValueRowFinder: Finds a parcel value that matches the effective date range specified. Finder Variables:
- EffectiveEndDate; string; The date on which the parcel value is no longer valid.
- EffectiveStartDate; string; The date on which the parcel value becomes valid.
- simpleSearchFinder: Finds a parcel value that matches the specified value. Finder Variables:
- value; string; The unique identifier for the parcel.
- PrimaryKey: Finds a parcel value that matches the specified primary key criteria. Finder Variables:
- EffectiveEndDate; string; The date on which the parcel value is no longer valid.
- EffectiveStartDate; string; The date on which the parcel value becomes valid.
- ParcelId; integer; The unique identifier for the parcel.
- ParcelValueRowFinder: Finds a parcel value that matches the effective date range specified. 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 : publicSectorParcelValues
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 : publicSectorParcelValues-item
Type:
Show Source
object
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the parcel value. -
CreationDate(optional):
string(date-time)
The date and time that the parcel value was created.
-
CurrencyCode(optional):
string
Title:
Currency Code
Maximum Length:3
The currency in which the parcel value is stated. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End Date
The date on which the parcel value is no longer valid. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start Date
The date on which the parcel value becomes valid. -
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. -
LandValue(optional):
number
Title:
Land Value
The land value of the parcel. -
LastUpdateDate(optional):
string(date-time)
The date and time that the parcel value was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the parcel value. -
links(optional):
array Items
Title:
Items
Link Relations -
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. -
ParcelId(optional):
integer(int64)
The unique identifier for the parcel.
-
ParcelSizeOne(optional):
number
Title:
Parcel Size 1
The first parcel size. -
ParcelSizeOneUOM(optional):
string
Title:
Parcel Size 1 UOM
Maximum Length:5
The unit of measure for the first parcel size. -
ParcelSizeTwo(optional):
number
Title:
Parcel Size 2
The second parcel size. -
ParcelSizeTwoUOM(optional):
string
Title:
Parcel Size 2 UOM
Maximum Length:5
The unit of measure for the second parcel size. -
PersonalPropertyValue(optional):
number
Title:
Personal Property Value
The personal property value of the parcel. -
PropertyUseCode(optional):
string
Title:
Property Use Code
Maximum Length:30
The property use code of the parcel.
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.