Get a parcel genealogy transaction
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactions/{publicSectorParcelTransactionsUniqID}
Request
Path Parameters
-
publicSectorParcelTransactionsUniqID: integer
This is the hash key of the attributes which make up the composite key--- ParcelTrxKey, ParcelTrxDtlKey and ParcelId ---for the Parcel genealogy transactions resource and used to uniquely identify an instance of Parcel genealogy transactions. The client should not generate the hash key value. Instead, the client should query on the Parcel genealogy transactions collection resource with a filter on the primary key values in order to navigate to a specific instance of Parcel genealogy transactions.
For example: publicSectorParcelTransactions?q=ParcelTrxKey=<value1>;ParcelTrxDtlKey=<value2>;ParcelId=<value3>
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorParcelTransactions-item
Type:
Show Source
object
-
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. -
City(optional):
string
Maximum Length:
60
The city of the parcel address. -
links(optional):
array Items
Title:
Items
Link Relations -
ParcelId(optional):
integer(int64)
The unique identifier of the parcel of real estate. Mandatory system generated value.
-
ParcelIdEntered(optional):
string
Maximum Length:
30
The unique identifier of the child parcel of real estate. Mandatory user supplied value. -
ParcelStatus(optional):
string
Maximum Length:
255
The status code of the parcel. -
ParcelStatusMeaning(optional):
string
Maximum Length:
80
The description of the status of the parcel which can be Final, Provisional, or Retired. -
ParcelTrxDtlKey(optional):
integer(int64)
The unique identifier of the parcel genealogy transaction detail. Mandatory system generated value.
-
ParcelTrxDttm(optional):
string(date-time)
The date and time when the parcel genealogy transaction was created.
-
ParcelTrxKey(optional):
integer(int64)
The unique identifier of the parcel genealogy transaction. Mandatory system generated value.
-
ParcelTrxStatus(optional):
string
Maximum Length:
10
Status of the parcel genealogy transaction. Valid values include pending and active. -
ParcelTrxStatusMeaning(optional):
string
Maximum Length:
80
The description of the transaction status. -
ParcelTrxType(optional):
string
Maximum Length:
20
The type of parcel genealogy transaction. Valid values include split, merge, and adjust. -
ParcelTrxTypeMeaning(optional):
string
Maximum Length:
80
The description of the transaction type. -
PrimaryFlag(optional):
string
Maximum Length:
1
Indicates whether the assigned parent parcel address is the primary address for the child parcel. -
ProvisionalParcelIdEntered(optional):
string
Maximum Length:
30
The temporary parcel number supplied by the user to be used until the final parcel number (APN) is available. -
Relationship(optional):
string
Maximum Length:
15
The relationship of the parcels included in a genealogy transaction. -
RelationshipMeaning(optional):
string
Maximum Length:
80
The description of the relationship of the parcel within the transaction. -
State(optional):
string
Maximum Length:
60
The state of the parcel address.
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.