Get all address parcel rows
get
/fscmRestApi/resources/11.13.18.05/publicSectorApValueSearches
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:- simpleSearchFinder: Finds an address parcel row that matches the specified value. Finder Variables:
- value; string; The unique identifier for the parcel.
- PrimaryKey: Finds an address parcel row that matches the specified primary key criteria. Finder Variables:
- ParcelId; integer; The unique identifier for the parcel.
- simpleSearchFinder: Finds an address parcel row that matches the specified value. 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 : publicSectorApValueSearches
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 : publicSectorApValueSearches-item
Type:
Show Source
object
-
AdditionalStructure(optional):
string
Maximum Length:
200
The information about additional structures located on the parcel. -
Address1(optional):
string
Maximum Length:
240
The first line of the parcel address. -
Address2(optional):
string
Maximum Length:
240
The second line of the parcel address. -
Address3(optional):
string
Maximum Length:
240
The third line of the parcel address. -
Address4(optional):
string
Maximum Length:
240
The fourth line of the parcel address. -
AddressCode(optional):
string
Maximum Length:
32
The address code of the parcel address. -
AddressCoordinateX(optional):
number
The x coordinate of the parcel address.
-
AddressCoordinateY(optional):
number
The y coordinate of the parcel address.
-
AddressCrossroadOne(optional):
string
Maximum Length:
240
The first crossroad of the intersection. -
AddressCrossroadTwo(optional):
string
Maximum Length:
240
The second crossroad of the intersection. -
AddressEnabled(optional):
string
Maximum Length:
1
Indicates whether the parcel address is available to be used. -
AddressId(optional):
integer(int64)
The unique identifier for the address.
-
AddressLandmark(optional):
string
Maximum Length:
200
The landmark associated with the address. -
AddressLatitude(optional):
number
The latitude of the parcel address.
-
AddressLongitude(optional):
number
The longitude of the parcel address.
-
AddressName(optional):
string
Maximum Length:
150
The name of the first contact person. -
AddressPrimary(optional):
string
Maximum Length:
1
Indicates whether the parcel address is marked as primary for that parcel. -
AddressStreetSuffix(optional):
string
Maximum Length:
20
The streeet suffix that further describes that street like Drive, Avenue etc. -
Bathrooms(optional):
string
Maximum Length:
20
The number of bathrooms for the building on the parcel. -
Bedrooms(optional):
string
Maximum Length:
20
The number of bedrooms for the building on the parcel. -
BlockNumber(optional):
string
Maximum Length:
30
The block number of the parcel. -
BuildingType(optional):
string
Maximum Length:
20
The building type of the parcel address. -
CensusBlock(optional):
string
Maximum Length:
100
The neighborhood information related to the location of the parcel. -
CensusTract(optional):
string
Maximum Length:
100
The neighborhood information related to the location of the parcel. -
City(optional):
string
Maximum Length:
60
The city of the parcel address. -
ClimateZone(optional):
string
Maximum Length:
200
The detailed climate zone of the parcel. -
Country(optional):
string
Maximum Length:
3
The country of the parcel address. -
County(optional):
string
Maximum Length:
5
The county of the parcel address. -
CurrencyCode(optional):
string
Maximum Length:
3
The currency code of the parcel. -
DwellingUnitCount(optional):
integer(int64)
The number of dwelling units for the parcel.
-
EffectiveEndDate(optional):
string(date)
The date on which the parcel value is no longer valid.
-
EffectiveStartDate(optional):
string(date)
The date on which the parcel value becomes valid.
-
FireRisk(optional):
string
Maximum Length:
200
The fire risk associated with the parcel. -
FirstParcelSize(optional):
number
The first parcel size.
-
FirstParcelSizeUnit(optional):
string
Maximum Length:
10
The unit of measure for the first parcel size. -
FixtureExemption(optional):
number
The exempted fixture information of the parcel.
-
Fixtures(optional):
number
The fixtures associated with the parcel.
-
FloodInsRateMap(optional):
string
Maximum Length:
200
The flood insurance rate map related to the parcel location for floodplain management and insurance purposes. -
FloodZone(optional):
string
Maximum Length:
200
The detailed flood zone of the parcel. -
Floor(optional):
string
Maximum Length:
20
The floor the parcel address is on. -
GeneralPlanTwo(optional):
string
Maximum Length:
30
The alternate land Information of the parcel. -
ImprovementValue(optional):
number
The improvement value of the parcel.
-
Jurisdiction(optional):
string
Maximum Length:
50
The jurisdiction of the parcel. -
LandslideRisk(optional):
string
Maximum Length:
200
The landslide risk associated with the parcel. -
LandValue(optional):
number
The land value of the parcel.
-
links(optional):
array Items
Title:
Items
Link Relations -
LiquefactionRisk(optional):
string
Maximum Length:
200
The liquefaction risk associated with the parcel. -
LotNumber(optional):
string
Maximum Length:
30
The lot number of the parcel. -
NetAssessedValues(optional):
number
The net assessed value of the parcel.
-
OtherExemption(optional):
number
Any additional exemptions for the parcel.
-
OwnerAddressOne(optional):
string
Maximum Length:
240
The first line of the owner's address. -
OwnerCity(optional):
string
Maximum Length:
60
The city of the owner's address. -
OwnerEnabled(optional):
string
Maximum Length:
1
Indicates whether the parcel owner is available to be used. -
OwnerExemption(optional):
number
The exempted owner information of the parcel.
-
OwnerId(optional):
integer(int64)
The unique identifier for the owner.
-
OwnerName(optional):
string
Maximum Length:
150
The name of the primary owner. -
OwnerPrimary(optional):
string
Maximum Length:
1
Indicates whether the parcel owner is marked as primary for that parcel. -
OwnerSecondaryName(optional):
string
Maximum Length:
150
The name of the secondary owner. -
OwnerState(optional):
string
Maximum Length:
60
The state of the owner's address. -
ParcelCoordinateX(optional):
number
The x coordinate of the parcel.
-
ParcelCoordinateY(optional):
number
The y coordinate of the parcel.
-
ParcelEnabled(optional):
string
Maximum Length:
1
Indicates whether the parcel is available to be used. -
ParcelId(optional):
integer(int64)
The unique identifier for the parcel.
-
ParcelIdEntered(optional):
string
Maximum Length:
30
The parcel number. -
ParcelLatitude(optional):
number
The latitude of the parcel.
-
ParcelLongitude(optional):
number
The longitude of the parcel.
-
ParcelSizeOne(optional):
number
The first parcel size.
-
ParcelSizeOneUOM(optional):
string
Maximum Length:
5
The unit of measure for the first parcel size. -
ParcelSizeTwo(optional):
number
The second parcel size.
-
ParcelSizeTwoUOM(optional):
string
Maximum Length:
5
The unit of measure for the second parcel size. -
ParcelStatus(optional):
string
Maximum Length:
20
The status of the parcel which can be either Final or Provisional. -
ParcelType(optional):
string
Maximum Length:
30
The type of the parcel. -
ParcelUnitNumber(optional):
string
Maximum Length:
30
The unit number of the parcel. -
Patio(optional):
string
Maximum Length:
200
The information about patios located on the parcel. -
PersonalPropertyValue(optional):
number
The personal property value of the parcel.
-
Pool(optional):
string
Maximum Length:
200
The information about pools located on the parcel. -
PostalCode(optional):
string
Maximum Length:
20
The postal code of the parcel address. -
PostalPlus4Code(optional):
string
Maximum Length:
10
The postal plus 4 code of the parcel address. -
PrimaryZoningId(optional):
string
Maximum Length:
30
The unique identifier for the primary zoning information of the parcel. -
PropertyDescription(optional):
string
Maximum Length:
240
The property description of the parcel. -
PropertyUseCode(optional):
string
Maximum Length:
30
The property use code of the parcel. -
Province(optional):
string
Maximum Length:
60
The province of the parcel address. -
SecondaryAddressName(optional):
string
Maximum Length:
150
The name of the second contact person. -
SecondParcelSize(optional):
number
The second parcel size.
-
SecondParcelSizeUnit(optional):
string
Maximum Length:
10
The unit of measure for the second parcel size. -
SoilType(optional):
string
Maximum Length:
200
The soil type associated with the parcel. -
State(optional):
string
Maximum Length:
6
The state of the parcel address. -
StreetDirection(optional):
string
Maximum Length:
10
The street direction of the parcel address. -
StreetName(optional):
string
Maximum Length:
240
The street name of the parcel address. -
StreetNumber(optional):
string
Maximum Length:
20
The street number of the parcel address. -
StreetType(optional):
string
Maximum Length:
20
The street type of the parcel address. -
StructureSizeOne(optional):
number
The first structure size.
-
StructureSizeOneUnit(optional):
string
Maximum Length:
10
The unit of measure for the first structure size. -
StructureSizeTwo(optional):
number
The second structure size.
-
StructureSizeTwoUnit(optional):
string
Maximum Length:
10
The unit of measure for the second structure size. -
TaxRateArea(optional):
string
Maximum Length:
100
The area identifier of the parcel location for taxation purposes. -
UnitNumber(optional):
string
Maximum Length:
30
The unit number of the parcel. -
YearBuilt(optional):
string
Maximum Length:
4
The year in which the building on the parcel was built. -
ZoningCodeTwo(optional):
string
Maximum Length:
30
The secondary code of the zoning related to 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.