Get all parcel genealogy transaction owners
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionOwners
Request
Query Parameters
-
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 -
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 genealogy transaction owner that matches the specified primary key criteria.
Finder Variables:- ParcelTrxOwnKey; integer; The unique identifier for the parcel genealogy transaction owner.
- PrimaryKey: Finds a parcel genealogy transaction owner that matches the specified primary key criteria.
-
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.
-
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 -
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 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
-
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
You can use these queryable attributes to filter this collection resource using the q query parameter:- Address1; string; The first line of the parcel owner address.
- Address2; string; The second line of the parcel owner address.
- Address3; string; The third line of the parcel owner address.
- Address4; string; The fourth line of the parcel owner address.
- AddressFieldOne; string; The first line of the parcel owner address.
- AddressFieldThree; string; The third line of the parcel owner address.
- AddressFieldTwo; string; The second line of the parcel owner address.
- AssignedToChildParcel; string; Indicates whether the owner is assigned to the parcel.
- BuildingType; string; The building type of the parcel owner.
- CellPhoneCountry; string; Tthe cell phone country code of the parcel owner.
- CellPhoneNumber; string; The cell phone number of the parcel owner.
- City; string; The city of the parcel owner.
- Country; string; The country of the parcel owner.
- County; string; The county of the parcel owner.
- CreationDate; string; The date and time that the parcel genealogy transaction owner was created.
- DisplayParentParcel; string; Parent parcel information.
- DocumentNumber; string; The document number of the parcel owner.
- EmailId; string; The email address for the parcel owner.
- EnabledFlag; string; Indicates whether the parcel owner is available to be used. The default value is N.
- FaxCountry; string; The fax country code of the parcel owner.
- FaxNumber; string; The fax phone number of the parcel owner.
- FinalParcelIdEntered; string; The final parcel number.
- Floor; string; The floor the parcel owner is on.
- HomePhoneCountry; string; The home phone country code of the parcel owner.
- HomePhoneNumber; string; The home phone number of the parcel owner.
- LastTransferDate; string; The last transfer date of the parcel owner.
- LastTransferType; string; The last transfer type of the parcel owner.
- LastUpdateDate; string; The date and time that the parcel genealogy transaction owner was last updated.
- OwnerCode; string; The code of the parcel owner.
- OwnerId; integer; The unique identifier for the parcel owner.
- OwnerName; string; The name of the primary parcel owner.
- OwnerType; string; The type of parcel owner.
- ParcelIdEntered; string; Identifier entered by the user for the parcel of real estate. In the USA, this is the Assessor Parcel Number.
- ParcelTrxDtlKey; integer; 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 a parcel genealogy transaction.
- ParcelTrxOwnKey; integer; The new identifier for a parcel genealogy transaction owner.
- ParcelTrxOwnPuid; string; The public unique identifier for a parcel genealogy transaction owner. Used to import data.
- ParentParcelId; integer; Unique identifier of the parent parcel.
- ParentParcelIdEntered; string; Parent parcel Assessor Parcel Number.
- PostalCode; string; The postal code of the parcel owner.
- PostalPlus4Code; string; The postal plus 4 code of the parcel owner.
- PreviousState; string; The previous state of this row.
- PrimaryFlag; string; Indicates whether the parcel owner is the primary owner for the parcel. If the value is Y, the parcel owner is the primary owner. The default value is N.
- Province; string; The province of the parcel owner.
- ProvisionalParcelIdEntered; string; The provisional parcel number.
- SecondaryOwnerName; string; The name of the secondary parcel owner.
- Selected; string; Indicates whether the owner is assigned to the parcel.
- State; string; The state of the parcel owner.
- StreeName; string; The street name of the parcel owner.
- StreetDirection; string; The street direction of the parcel owner.
- StreetNumber; string; The street number of the parcel owner.
- StreetType; string; The street type of the parcel owner.
- SummaryRow; string; Indicates whether the row summarizes parcel owner information.
- Temporary; string; Indicates whether the data in this row is temporary.
- UnitNumber; string; The unit number of the parcel owner.
- WorkPhoneCountry; string; The work phone country code of the parcel owner.
- WorkPhoneNumber; string; The work phone number of the parcel owner.
-
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".
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 : publicSectorParcelTransactionOwners
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorParcelTransactionOwners-item-response
Type:
Show Source
object
-
Address1: string
Maximum Length:
240
The first line of the parcel owner address. -
Address2: string
Maximum Length:
240
The second line of the parcel owner address. -
Address3: string
Maximum Length:
240
The third line of the parcel owner address. -
Address4: string
Maximum Length:
240
The fourth line of the parcel owner address. -
AddressFieldOne: string
Maximum Length:
20
The first line of the parcel owner address. -
AddressFieldThree: string
Maximum Length:
20
The third line of the parcel owner address. -
AddressFieldTwo: string
Maximum Length:
20
The second line of the parcel owner address. -
AssignedToChildParcel: string
Maximum Length:
30
Indicates whether the owner is assigned to the parcel. -
BuildingType: string
Maximum Length:
20
The building type of the parcel owner. -
CellPhoneCountry: string
Maximum Length:
10
Tthe cell phone country code of the parcel owner. -
CellPhoneNumber: string
Maximum Length:
40
The cell phone number of the parcel owner. -
City: string
Maximum Length:
60
The city of the parcel owner. -
Country: string
Maximum Length:
3
The country of the parcel owner. -
County: string
Maximum Length:
60
The county of the parcel owner. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the parcel genealogy transaction owner was created. -
DisplayParentParcel: string
Maximum Length:
30
Parent parcel information. -
DocumentNumber: string
Maximum Length:
50
The document number of the parcel owner. -
EmailId: string
Maximum Length:
50
The email address for the parcel owner. -
EnabledFlag: string
Maximum Length:
1
Indicates whether the parcel owner is available to be used. The default value is N. -
FaxCountry: string
Maximum Length:
10
The fax country code of the parcel owner. -
FaxNumber: string
Maximum Length:
40
The fax phone number of the parcel owner. -
FinalParcelIdEntered: string
Maximum Length:
30
The final parcel number. -
Floor: string
Maximum Length:
20
The floor the parcel owner is on. -
HomePhoneCountry: string
Maximum Length:
10
The home phone country code of the parcel owner. -
HomePhoneNumber: string
Maximum Length:
40
The home phone number of the parcel owner. -
LastTransferDate: string
(date)
The last transfer date of the parcel owner.
-
LastTransferType: string
Maximum Length:
50
The last transfer type of the parcel owner. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time that the parcel genealogy transaction owner was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerCode: string
Maximum Length:
32
The code of the parcel owner. -
OwnerId: integer
(int64)
The unique identifier for the parcel owner.
-
OwnerName: string
Maximum Length:
150
The name of the primary parcel owner. -
OwnerType: string
Maximum Length:
20
The type of parcel owner. -
ParcelIdEntered: string
Maximum Length:
30
Identifier entered by the user for the parcel of real estate. In the USA, this is the Assessor Parcel Number. -
ParcelTrxDtlKey: integer
(int64)
The new identifier for parcel genealogy transaction detail.
-
ParcelTrxDtlPuid: string
Maximum Length:
480
The public unique identifier for parcel genealogy transaction detail. Used to import data. -
ParcelTrxKey: integer
(int64)
The new identifier for a parcel genealogy transaction.
-
ParcelTrxOwnKey: integer
(int64)
The new identifier for a parcel genealogy transaction owner.
-
ParcelTrxOwnPuid: string
Maximum Length:
480
The public unique identifier for a parcel genealogy transaction owner. Used to import data. -
ParentParcelId: integer
(int64)
Unique identifier of the parent parcel.
-
ParentParcelIdEntered: string
Maximum Length:
30
Parent parcel Assessor Parcel Number. -
PostalCode: string
Maximum Length:
60
The postal code of the parcel owner. -
PostalPlus4Code: string
Maximum Length:
10
The postal plus 4 code of the parcel owner. -
PreviousState: string
Maximum Length:
20
The previous state of this row. -
PrimaryFlag: string
Maximum Length:
1
Indicates whether the parcel owner is the primary owner for the parcel. If the value is Y, the parcel owner is the primary owner. The default value is N. -
Province: string
Maximum Length:
60
The province of the parcel owner. -
ProvisionalParcelIdEntered: string
Maximum Length:
30
The provisional parcel number. -
SecondaryOwnerName: string
Maximum Length:
150
The name of the secondary parcel owner. -
Selected: string
Maximum Length:
1
Indicates whether the owner is assigned to the parcel. -
State: string
Maximum Length:
60
The state of the parcel owner. -
StreeName: string
Maximum Length:
240
The street name of the parcel owner. -
StreetDirection: string
Maximum Length:
10
The street direction of the parcel owner. -
StreetNumber: string
Maximum Length:
20
The street number of the parcel owner. -
StreetType: string
Maximum Length:
20
The street type of the parcel owner. -
SummaryRow: string
Maximum Length:
1
Indicates whether the row summarizes parcel owner information. -
Temporary: string
Maximum Length:
1
Indicates whether the data in this row is temporary. -
UnitNumber: string
Maximum Length:
30
The unit number of the parcel owner. -
WorkPhoneCountry: string
Maximum Length:
10
The work phone country code of the parcel owner. -
WorkPhoneNumber: string
Maximum Length:
40
The work phone number of the parcel owner.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.