Get all record parcels with their parcel addresses
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordParcelAddressCrosses
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 parcel and its address using the primary key criteria. Finder Variables:
- AddressKey; integer; The unique identifier for a parcel address.
- ParcelKey; integer; The unique identifier for a parcel.
- PrimaryKey: Finds a parcel and its address using the 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 : publicSectorRecordParcelAddressCrosses
Type:
Show Source
object-
count(optional):
integer
Title:
CountThe number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMoreIndicates 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:
ItemsThe items in the collection. -
limit(optional):
integer
Title:
LimitThe actual paging size used by the server. -
links(optional):
array Items
Title:
ItemsThe link relations associated with the resource instance. -
offset(optional):
integer
Title:
OffsetThe offset value used in the current page.
Nested Schema : Items
Type:
arrayTitle:
ItemsThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordParcelAddressCrosses-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
240The first or main address. -
Address2(optional):
string
Maximum Length:
240The second address, if present. -
Address3(optional):
string
Maximum Length:
240The third address, if present. -
Address4(optional):
string
Maximum Length:
240The fourth address, if present. -
AddressId(optional):
integer(int64)
The identifier of the parcel address.
-
AddressKey(optional):
integer(int64)
The unique identifier of the parcel address.
-
AddressPrimaryFlag(optional):
boolean
Indicates the primary parcel address. If the value is Y, then the parcel address is the primary parcel address. The default value is N.
-
City(optional):
string
Maximum Length:
60The city in the parcel address. -
CoordinateX(optional):
number
The x-axis coordinate of the record parcel address.
-
CoordinateY(optional):
number
The y-axis coordinate of the record parcel address.
-
Country(optional):
string
Maximum Length:
3The country in the parcel address. -
County(optional):
string
Maximum Length:
5The county in the parcel address. -
CreatedBy(optional):
string
Maximum Length:
64The user who created the record parcel. -
CreationDate(optional):
string(date-time)
The date when the record parcel was created.
-
LastUpdateDate(optional):
string(date-time)
The user who last updated the record parcel.
-
LastUpdatedBy(optional):
string
Maximum Length:
64The date when the record parcel was last updated. -
Latitude(optional):
number
The latitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
-
links(optional):
array Items
Title:
ItemsLink Relations -
LnpRecordId(optional):
string
Maximum Length:
50The unique identifier for the application record. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for the record associated with the parcel.
-
Longitude(optional):
number
The longitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
-
ParcelId(optional):
integer(int64)
The identifier of the record parcel.
-
ParcelIdEntered(optional):
string
Maximum Length:
30The Assessor Parcel Number (APN) as entered by the user. -
ParcelKey(optional):
integer(int64)
The unique identifier for a parcel.
-
ParcelLatitude(optional):
number
The geographic location of the parcel that is north or south of the equator.
-
ParcelLongitude(optional):
number
The geographic location of the parcel address that is east or west of the meridian.
-
PostalCode(optional):
string
Maximum Length:
20The postal code in the parcel address. -
PrimaryFlag(optional):
boolean
Indicates the primary parcel. If the value is Y, then the parcel is the primary parcel. The default value is N.
-
PrimaryTransAddress(optional):
boolean
Title:
Primary Transaction AddressIndicates the primary address for the transaction. If the value is 'Y' then the address is the primary transaction address. The default value is N. -
Province(optional):
string
Title:
ProvinceMaximum Length:60The province in the parcel address. -
State(optional):
string
Maximum Length:
6The state in the parcel address. -
StreetDirection(optional):
string
Title:
DirectionMaximum Length:10The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center. -
StreetName(optional):
string
Title:
StreetMaximum Length:240The street name in the parcel address. -
StreetNumber(optional):
string
Title:
Street NumberMaximum Length:20The street number in the parcel address. -
StreetSuffix(optional):
string
Title:
SuffixMaximum Length:20The street suffix that further describes that street like Drive, Avenue etc. -
StreetType(optional):
string
Title:
Street TypeMaximum Length:20The street type designation. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber(optional):
string
Title:
UnitMaximum Length:30The exact unit in a building. For example, Apartment 208A or Suite 300.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.