Get a parcel genealogy transaction header
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders/{ParcelTrxKey}
Request
Path Parameters
-
ParcelTrxKey(required): integer(int64)
The unique identifier of the parcel genealogy transaction. Mandatory system-generated value.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorParcelTransactionHeaders-item-response
Type:
Show Source
object
-
ChildParcel: string
Title:
Child Parcel
Maximum Length:30
The child parcel of the parcel genealogy transaction if only a single child is specified. -
CreationDate: string
(date-time)
Read Only:
true
The date and time the parcel genealogy transaction was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The user who last updated the parcel genealogy transaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MigratedDataFlag: string
Maximum Length:
3
Indicates whether the transaction was created online or migrated from a legacy system. -
ParcelTransactionDetail: array
Parcel genealogy transaction details
Title:
Parcel genealogy transaction details
The parcel genealogy transaction detail resource is used to view, create, delete, or modify parcel genealogy transaction details and associate them with a parcel genealogy transaction. -
ParcelTrxDttm: string
(date-time)
The date and time when the parcel genealogy transaction was created.
-
ParcelTrxKey: integer
(int64)
Title:
Transaction Number
The unique identifier of the parcel genealogy transaction. Mandatory system-generated value. -
ParcelTrxPuid: string
Maximum Length:
480
The public unique identifier of the parcel genealogy transaction. -
ParcelTrxStatus: string
Title:
Status
Maximum Length:10
The status of the parcel genealogy transaction. Valid values include Pending and Complete. -
ParcelTrxStatusMeaning: string
Read Only:
true
Maximum Length:80
The description of the transaction status. -
ParcelTrxType: string
Title:
Type
Maximum Length:20
The type of parcel genealogy transaction. Valid values include Split, Merge and Adjust. -
ParcelTrxTypeMeaning: string
Read Only:
true
Maximum Length:80
The description of the transaction type. -
ParentParcel: string
Title:
Parent Parcel
Maximum Length:30
The parent parcel of the parcel genealogy transaction if only a single parent is specified. -
PreviousState: string
Maximum Length:
20
The previous state of this row. -
Temporary: string
Maximum Length:
1
Indicates whether the data in this row is temporary.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Parcel genealogy transaction details
Type:
array
Title:
Parcel genealogy transaction details
The parcel genealogy transaction detail resource is used to view, create, delete, or modify parcel genealogy transaction details and associate them with a parcel genealogy transaction.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorParcelTransactionHeaders-ParcelTransactionDetail-item-response
Type:
Show Source
object
-
CreationDate: string
(date-time)
Read Only:
true
The date and time when the parcel genealogy transaction detail was created. -
ExistingParcel: string
Maximum Length:
1
Indicates whether parcel was previously created in the system or it is being created with the parcel genealogy transaction. -
FinalParcelIdEntered: string
Maximum Length:
30
The final parcel number (APN) typically assigned by the county. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the parcel genealogy transaction detail was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MigratedDataFlag: string
Maximum Length:
3
Indicates whether the transaction was created online or migrated from a legacy system. -
ParcelId: integer
The unique identifier of the parcel of real estate in the genealogy transaction. Mandatory system-generated value.
-
ParcelIdEntered: string
Maximum Length:
30
The unique identifier of the child parcel in the genealogy transaction. Mandatory user supplied value. -
ParcelTrxDtlKey: string
Maximum Length:
18
The unique identifier of the parcel genealogy transaction detail. Mandatory system-generated value. -
ParcelTrxDtlPuid: string
Maximum Length:
480
The public unique identifier of the parcel genealogy transaction detail. -
ParcelTrxKey: integer
(int64)
The unique identifier of the parcel genealogy transaction. Mandatory system-generated value.
-
ParcelTrxPuid: string
Maximum Length:
480
The public unique identifier of the parcel genealogy transaction. -
PreviousState: string
Maximum Length:
20
The previous state of this row. -
ProvisionalParcelIdEntered: string
Maximum Length:
30
The temporary parcel number supplied by the user to be used until the final parcel number (APN) is available. -
Relationship: string
Maximum Length:
15
The relationship of the parcels included in a genealogy transaction. -
RelationshipMeaning: string
Read Only:
true
Maximum Length:80
The description of the relationship of the parcel within the transaction. -
Temporary: string
Maximum Length:
1
Indicates whether the data in this row is temporary.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ParcelTransactionDetail
-
Parameters:
- ParcelTrxKey:
$request.path.ParcelTrxKey
The parcel genealogy transaction detail resource is used to view, create, delete, or modify parcel genealogy transaction details and associate them with a parcel genealogy transaction. - ParcelTrxKey: