Get all parcel genealogy transaction addresses
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionAddresses
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 address that matches the specified primary key criteria.
Finder Variables:- ParcelTrxAddKey; integer; The unique identifier for the parcel genealogy transaction address.
- PrimaryKey: Finds a parcel genealogy transaction address 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 address.
- Address2; string; The second line of the parcel address.
- Address3; string; The third line of the parcel address.
- Address4; string; The fourth line of the parcel address.
- AddressCode; string; The unique identifier populated for an address assigned to a child parcel.
- AddressFieldOne; string; An additional field which, if populated, can be used to find the address in searches.
- AddressFieldThree; string; An additional field which, if populated, can be used to find the address in searches.
- AddressFieldTwo; string; An additional field which, if populated, can be used to find the address in searches.
- AddressId; integer; The unique identifier for the parcel address. Mandatory system-generated value.
- AddressType; string; The type of the parcel address.
- AssignedToChildParcel; string; The unique identifier of the child parcel to which the parent parcel address is assigned.
- BuildingType; string; The building type of the parcel address.
- CellPhoneCountry; string; The cell phone country code associated with the parcel address contact.
- CellPhoneNumber; string; The cell phone number associated with the parcel address contact.
- City; string; The city of the parcel address.
- CoordinateX; number; The x coordinate of the parcel address.
- CoordinateY; number; The y coordinate of the parcel address.
- Country; string; The country of the parcel address.
- County; string; The county of the parcel address.
- CreationDate; string; The date and time when the parcel genealogy transaction address was created.
- CrossroadOne; string; The first crossroad associated with the parcel address.
- CrossroadTwo; string; The second crossroad associated with the parcel address.
- DisplayParentParcel; string; The unique identifier of the parent parcel from which the assigned address originated.
- EmailId; string; The email address associated with the parcel address contact.
- EnabledFlag; string; Indicates whether the parcel address is available to be used.
- FaxCountry; string; The fax country code of the parcel address contact.
- FaxNumber; string; The fax phone number associated with the parcel address contact.
- FinalParcelIdEntered; string; The final parcel number (APN) typically assigned by the county.
- Floor; string; The floor the parcel address is on.
- HomePhoneCountry; string; The home phone country code associated with the parcel address contact.
- HomePhoneNumber; string; The home phone number associated with the parcel address contact.
- InputSource; string; Indicates how the parcel address data was specifed or entered.
- Landmark; string; The landmark associated with the address.
- LastUpdateDate; string; The date and time when the parcel genealogy transaction address was last updated.
- Latitude; number; The latitude of the parcel address.
- Longitude; number; The longitude of the parcel address.
- MunicipalityId; string; The unique identifier of the municipality in which the parcel address address is located.
- Name; string; The name of the first parcel address contact.
- ParcelIdEntered; string; The unique identifier of the child parcel in the genealogy transaction. Mandatory user-supplied value.
- ParcelTrxAddKey; integer; The unique identifier of the parcel genealogy transaction address. Mandatory system-generated value.
- ParcelTrxAddPuid; string; The public unique identifier for parcel genealogy transaction address.
- ParcelTrxDtlKey; integer; The unique identifier of the parcel genealogy transaction detail. Mandatory system-generated value.
- ParcelTrxDtlPuid; string; The public unique identifier for parcel genealogy transaction detail.
- ParcelTrxKey; integer; The unique identifier of the parcel genealogy transaction. Mandatory system-generated value.
- ParentParcelId; integer; The unique identifier of the parent parcel in the genealogy transaction. Mandatory system-generated value.
- ParentParcelIdEntered; string; The unique identifier of the parent parcel in the genealogy transaction. Mandatory user-supplied value.
- PostalCode; string; The postal code of the parcel address.
- PostalPlus4Code; string; The postal plus 4 code of the parcel address.
- PreviousState; string; The previous state of this row.
- PrimaryFlag; string; Indicates whether the assigned parent parcel address is the primary address for the child parcel.
- Province; string; The province of the parcel address.
- ProvisionalParcelIdEntered; string; The temporary parcel number supplied by the user to be used until the final parcel number (APN) is available.
- SecondaryName; string; The name of the second parcel address contact.
- Selected; string; Indicates whether the address is assigned to the child parcel.
- Srid; integer; The spatial reference identifier. This is a unique coordinate identifier for a local, regional, or global system used to locate geographical or spatial entities within geographic information systems.
- State; string; The state of the parcel address.
- StreeName; string; The street name of the parcel address.
- StreetDirection; string; The street direction of the parcel address.
- StreetName; string; The street name of the parcel address.
- StreetNumber; string; The street number of the parcel address.
- StreetSuffix; string; The suffix that further describes that street like drive, avenue etc.
- StreetType; string; The street type of the parcel address.
- SummaryRow; string; The address to be displayed on the child parcel summary row on the Manage Addresses page. Normally this is the primary address for the child parcel.
- Temporary; string; Indicates whether the data in this row is temporary.
- UnitNumber; string; The unit number of the parcel address.
- WorkPhoneCountry; string; The work phone country code associated with the parcel address contact.
- WorkPhoneNumber; string; The work phone number associated with the parcel address contact.
-
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:
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.
Root Schema : publicSectorParcelTransactionAddresses
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 : publicSectorParcelTransactionAddresses-item-response
Type:
Show Source
object
-
Address1: string
Maximum Length:
240
The first line of the parcel address. -
Address2: string
Maximum Length:
240
The second line of the parcel address. -
Address3: string
Maximum Length:
240
The third line of the parcel address. -
Address4: string
Maximum Length:
240
The fourth line of the parcel address. -
AddressCode: string
Maximum Length:
32
The unique identifier populated for an address assigned to a child parcel. -
AddressFieldOne: string
Maximum Length:
20
An additional field which, if populated, can be used to find the address in searches. -
AddressFieldThree: string
Maximum Length:
20
An additional field which, if populated, can be used to find the address in searches. -
AddressFieldTwo: string
Maximum Length:
20
An additional field which, if populated, can be used to find the address in searches. -
AddressId: integer
(int64)
The unique identifier for the parcel address. Mandatory system-generated value.
-
AddressType: string
Maximum Length:
20
The type of the parcel address. -
AssignedToChildParcel: string
Maximum Length:
30
The unique identifier of the child parcel to which the parent parcel address is assigned. -
BuildingType: string
Maximum Length:
20
The building type of the parcel address. -
CellPhoneCountry: string
Maximum Length:
10
The cell phone country code associated with the parcel address contact. -
CellPhoneNumber: string
Maximum Length:
40
The cell phone number associated with the parcel address contact. -
City: string
Maximum Length:
60
The city of the parcel address. -
CoordinateX: number
The x coordinate of the parcel address.
-
CoordinateY: number
The y coordinate of the parcel address.
-
Country: string
Maximum Length:
60
The country of the parcel address. -
County: string
Maximum Length:
60
The county of the parcel address. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the parcel genealogy transaction address was created. -
CrossroadOne: string
Maximum Length:
240
The first crossroad associated with the parcel address. -
CrossroadTwo: string
Maximum Length:
240
The second crossroad associated with the parcel address. -
DisplayParentParcel: string
Maximum Length:
30
The unique identifier of the parent parcel from which the assigned address originated. -
EmailId: string
Maximum Length:
50
The email address associated with the parcel address contact. -
EnabledFlag: string
Maximum Length:
1
Indicates whether the parcel address is available to be used. -
FaxCountry: string
Maximum Length:
10
The fax country code of the parcel address contact. -
FaxNumber: string
Maximum Length:
40
The fax phone number associated with the parcel address contact. -
FinalParcelIdEntered: string
Maximum Length:
30
The final parcel number (APN) typically assigned by the county. -
Floor: string
Maximum Length:
20
The floor the parcel address is on. -
HomePhoneCountry: string
Maximum Length:
10
The home phone country code associated with the parcel address contact. -
HomePhoneNumber: string
Maximum Length:
40
The home phone number associated with the parcel address contact. -
InputSource: string
Maximum Length:
1
Indicates how the parcel address data was specifed or entered. -
Landmark: string
Maximum Length:
200
The landmark associated with the address. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the parcel genealogy transaction address was last updated. -
Latitude: number
The latitude of the parcel address.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
The longitude of the parcel address.
-
MunicipalityId: string
Maximum Length:
20
The unique identifier of the municipality in which the parcel address address is located. -
Name: string
Maximum Length:
150
The name of the first parcel address contact. -
ParcelIdEntered: string
Maximum Length:
30
The unique identifier of the child parcel in the genealogy transaction. Mandatory user-supplied value. -
ParcelTrxAddKey: integer
(int64)
The unique identifier of the parcel genealogy transaction address. Mandatory system-generated value.
-
ParcelTrxAddPuid: string
Maximum Length:
480
The public unique identifier for parcel genealogy transaction address. -
ParcelTrxDtlKey: integer
(int64)
The unique identifier of the parcel genealogy transaction detail. Mandatory system-generated value.
-
ParcelTrxDtlPuid: string
Maximum Length:
480
The public unique identifier for parcel genealogy transaction detail. -
ParcelTrxKey: integer
(int64)
The unique identifier of the parcel genealogy transaction. Mandatory system-generated value.
-
ParentParcelId: integer
(int64)
The unique identifier of the parent parcel in the genealogy transaction. Mandatory system-generated value.
-
ParentParcelIdEntered: string
Maximum Length:
30
The unique identifier of the parent parcel in the genealogy transaction. Mandatory user-supplied value. -
PostalCode: string
Maximum Length:
60
The postal code of the parcel address. -
PostalPlus4Code: string
Maximum Length:
20
The postal plus 4 code of the parcel address. -
PreviousState: string
Maximum Length:
20
The previous state of this row. -
PrimaryFlag: string
Maximum Length:
1
Indicates whether the assigned parent parcel address is the primary address for the child parcel. -
Province: string
Maximum Length:
60
The province of the parcel address. -
ProvisionalParcelIdEntered: string
Maximum Length:
30
The temporary parcel number supplied by the user to be used until the final parcel number (APN) is available. -
SecondaryName: string
Maximum Length:
150
The name of the second parcel address contact. -
Selected: string
Maximum Length:
1
Indicates whether the address is assigned to the child parcel. -
Srid: integer
(int64)
The spatial reference identifier. This is a unique coordinate identifier for a local, regional, or global system used to locate geographical or spatial entities within geographic information systems.
-
State: string
Maximum Length:
60
The state of the parcel address. -
StreeName: string
Maximum Length:
240
The street name of the parcel address. -
StreetDirection: string
Maximum Length:
10
The street direction of the parcel address. -
StreetName: string
Maximum Length:
240
The street name of the parcel address. -
StreetNumber: string
Maximum Length:
20
The street number of the parcel address. -
StreetSuffix: string
Maximum Length:
20
The suffix that further describes that street like drive, avenue etc. -
StreetType: string
Maximum Length:
20
The street type of the parcel address. -
SummaryRow: string
Maximum Length:
1
The address to be displayed on the child parcel summary row on the Manage Addresses page. Normally this is the primary address for the child parcel. -
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 address. -
WorkPhoneCountry: string
Maximum Length:
10
The work phone country code associated with the parcel address contact. -
WorkPhoneNumber: string
Maximum Length:
40
The work phone number associated with the parcel address contact.
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.