Get all parcel genealogy transaction details

get

/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionDetails

Request

Query Parameters
  • 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).
  • 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
  • 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 genealogy transaction detail that matches the specified primary key criteria.
      Finder Variables:
      • ParcelTrxDtlKey; string; The unique identifier for the parcel genealogy transaction detail.
    • simpleSearchFinder: Finds a parcel genealogy transaction detail that matches the specified value.
      Finder Variables:
      • value; string; The unique identifier for the parcel genealogy transaction key.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. 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
  • 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

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreationDate; string; The date and time when the parcel genealogy transaction detail was created.
    • ExistingParcel; string; Indicates whether parcel was previoulsy created in the system or it is being created with the parcel genealogy transaction.
    • FinalParcelIdEntered; string; The final parcel number.
    • LastUpdateDate; string; The date and time when the parcel genealogy transaction detail was last updated.
    • MigratedDataFlag; string; Flag used by the import data process.
    • ParcelId; integer; The unique identifier for the parcel.
    • ParcelIdEntered; string; Identifier given by the user for the parcel of real estate. In the USA, this is the Assessor Parcel Number.
    • ParcelTrxDtlKey; string; The new identifier for parcel genealogy transaction detail.
    • ParcelTrxDtlPuid; string; The public unique identifier for parcel genealogy transaction detail. Used to import data.
    • ParcelTrxKey; integer; The new identifier for parcel genealogy transaction.
    • ParcelTrxPuid; string; The public unique identifier for parcel genealogy transaction. Used to import data.
    • PreviousState; string; The previous state of this row.
    • ProvisionalParcelIdEntered; string; The provisional parcel number.
    • Relationship; string; Identifies the relationship of the parcel within a transaction.
    • RelationshipMeaning; string; The description of the relationship of the parcel within the transaction.
    • Temporary; string; Indicates whether the data in this row is temporary.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorParcelTransactionDetails
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorParcelTransactionDetails-item-response
Type: object
Show Source
Nested Schema : Parcel genealogy transaction addresses
Type: array
Title: Parcel genealogy transaction addresses
The parcel genealogy transaction addresses resource is used to view, create, delete or modify parcel genealogy transaction addresses and associate them with a parcel genealogy transaction.
Show Source
Nested Schema : Parcel genealogy transaction conditions
Type: array
Title: Parcel genealogy transaction conditions
The parcel genealogy transaction conditions resource is used to view, create, delete or modify parcel genealogy transaction conditions and associate them with a parcel genealogy transaction.
Show Source
Nested Schema : Parcel genealogy transaction districts
Type: array
Title: Parcel genealogy transaction districts
The parcel genealogy transaction districts resource is used to view, create, delete or modify parcel genealogy transaction districts and associate them with a parcel genealogy transaction.
Show Source
Nested Schema : Parcel genealogy transaction owners
Type: array
Title: Parcel genealogy transaction owners
The parcel genealogy transaction owners resource is used to view, create, delete or modify parcel genealogy transaction owners and associate them with a parcel genealogy transaction.
Show Source
Nested Schema : Parcel genealogy transaction parcels
Type: array
Title: Parcel genealogy transaction parcels
The parcel genealogy transaction parcels resource is used to view, create, delete or modify parcel genealogy transaction parcels and associate them with a parcel genealogy transaction.
Show Source
Nested Schema : publicSectorParcelTransactionDetails-TransactionAddress-item-response
Type: object
Show Source
Nested Schema : publicSectorParcelTransactionDetails-TransactionCondition-item-response
Type: object
Show Source
Nested Schema : publicSectorParcelTransactionDetails-TransactionDistrict-item-response
Type: object
Show Source
Nested Schema : publicSectorParcelTransactionDetails-TransactionOwner-item-response
Type: object
Show Source
Nested Schema : publicSectorParcelTransactionDetails-TransactionParcel-item-response
Type: object
Show Source
Back to Top