Get a record parcel with its parcel address
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordParcelAddressCrosses/{publicSectorRecordParcelAddressCrossesUniqID}
Request
Path Parameters
-
publicSectorRecordParcelAddressCrossesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ParcelKey and AddressKey ---for the Record Parcels with Parcel Addresses resource and used to uniquely identify an instance of Record Parcels with Parcel Addresses. The client should not generate the hash key value. Instead, the client should query on the Record Parcels with Parcel Addresses collection resource with a filter on the primary key values in order to navigate to a specific instance of Record Parcels with Parcel Addresses.
For example: publicSectorRecordParcelAddressCrosses?q=ParcelKey=<value1>;AddressKey=<value2>
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:
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 : publicSectorRecordParcelAddressCrosses-item-response
Type:
Show Source
object
-
Address1: string
Read Only:
true
Maximum Length:240
The first or main address. -
Address2: string
Read Only:
true
Maximum Length:240
The second address, if present. -
Address3: string
Read Only:
true
Maximum Length:240
The third address, if present. -
Address4: string
Read Only:
true
Maximum Length:240
The fourth address, if present. -
AddressId: integer
(int64)
Read Only:
true
The identifier of the parcel address. -
AddressKey: integer
(int64)
Read Only:
true
The unique identifier of the parcel address. -
AddressPrimaryFlag: boolean
Read Only:
true
Maximum Length:1
Indicates the primary parcel address. If the value is Y, then the parcel address is the primary parcel address. The default value is N. -
City: string
Read Only:
true
Maximum Length:60
The city in the parcel address. -
CoordinateX: number
Read Only:
true
The x-axis coordinate of the record parcel address. -
CoordinateY: number
Read Only:
true
The y-axis coordinate of the record parcel address. -
Country: string
Read Only:
true
Maximum Length:3
The country in the parcel address. -
County: string
Read Only:
true
Maximum Length:5
The county in the parcel address. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record parcel was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The user who last updated the record parcel. -
Latitude: number
Read Only:
true
The latitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Read Only:
true
Maximum Length:50
The unique identifier for the application record. -
LnpRecordKey: integer
(int64)
Read Only:
true
The unique identifier for the record associated with the parcel. -
Longitude: number
Read Only:
true
The longitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance. -
ParcelId: integer
(int64)
Read Only:
true
The identifier of the record parcel. -
ParcelIdEntered: string
Read Only:
true
Maximum Length:30
The Assessor Parcel Number (APN) as entered by the user. -
ParcelKey: integer
Read Only:
true
The unique identifier for a parcel. -
ParcelLatitude: number
Read Only:
true
The geographic location of the parcel that is north or south of the equator. -
ParcelLongitude: number
Read Only:
true
The geographic location of the parcel address that is east or west of the meridian. -
PostalCode: string
Read Only:
true
Maximum Length:20
The postal code in the parcel address. -
PrimaryFlag: boolean
Read Only:
true
Maximum Length:1
Indicates the primary parcel. If the value is Y, then the parcel is the primary parcel. The default value is N. -
PrimaryTransAddress: boolean
Title:
Primary Transaction Address
Read Only:true
Maximum Length:1
Indicates the primary address for the transaction. If the value is 'Y' then the address is the primary transaction address. The default value is N. -
Province: string
Title:
Province
Read Only:true
Maximum Length:60
The province in the parcel address. -
State: string
Read Only:
true
Maximum Length:6
The state in the parcel address. -
StreetDirection: string
Title:
Direction
Read Only:true
Maximum Length:10
The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center. -
StreetName: string
Title:
Street
Read Only:true
Maximum Length:240
The street name in the parcel address. -
StreetNumber: string
Title:
Street Number
Read Only:true
Maximum Length:20
The street number in the parcel address. -
StreetSuffix: string
Title:
Suffix
Read Only:true
Maximum Length:20
The street suffix that further describes that street like Drive, Avenue etc. -
StreetType: string
Title:
Street Type
Read Only:true
Maximum Length:20
The street type designation. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber: string
Title:
Unit
Read Only:true
Maximum Length:30
The exact unit in a building. For example, Apartment 208A or Suite 300.
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.