Get a record parcel address
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelAddress/{AddressKey}
Request
Path Parameters
-
AddressKey(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
LnpRecordKey(required): integer(int64)
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
-
ParcelKey(required): integer(int64)
The unique identifier for a parcel.
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 : publicSectorRecordLists-RecordParcel-ParcelAddress-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first or main address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address, if present. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address, if present. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address, if present. -
AddressId: integer
(int64)
Title:
Address
The identifier of the parcel address. -
AddressKey: integer
(int64)
Title:
Address Key
The unique identifier of the parcel address. -
AddressType: string
Title:
Address Type
Maximum Length:20
The address type used for delivery point validation (DPV). For example, main address, side address, or virtual address. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for a public sector agency. -
BuildingType: string
Title:
Building
Maximum Length:20
The building type of building used in an address search. For example, Tower A or Block 3. -
CellPhoneCountry: string
Title:
Cell Phone Country
Maximum Length:10
The country code for the cell phone number of parcel contact. -
CellPhoneNumber: string
Title:
Cell Phone
Maximum Length:40
The cell phone number of the parcel address contact. -
City: string
Title:
City
Maximum Length:60
The city in the parcel address. -
CoordinateX: number
Title:
Coordinate X
The x-axis coordinate of the record parcel address. -
CoordinateY: number
Title:
Coordinate Y
The y-axis coordinate of the record parcel address. -
Country: string
Title:
Country
Maximum Length:60
The country in the parcel address. -
County: string
Title:
County
Maximum Length:60
The country in the parcel address. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the parcel address was created. -
CrossroadOne: string
Maximum Length:
240
The first crossroad of the intersection. -
CrossroadTwo: string
Maximum Length:
240
The second crossroad of the intersection. -
EmailId: string
Title:
Email
Maximum Length:50
The email address of the parcel address contact. -
FaxCountry: string
Title:
Fax Country
Maximum Length:10
The country code for the fax number of the parcel contact. -
FaxNumber: string
Title:
Fax
Maximum Length:40
The fax number of the parcel address contact. -
Floor: string
Title:
Floor
Maximum Length:20
The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry: string
Title:
Home Phone Country
Maximum Length:10
The country code for the home telephone number of the parcel address contact. -
HomePhoneNumber: string
Title:
Home Phone
Maximum Length:40
The home telephone number of the parcel address contact. -
InputSource: string
Title:
Source
Maximum Length:1
Indicates how the data were entered or loaded into the application. The values are S for system data and U for user-entered data. -
Landmark: string
Maximum Length:
200
The landmark associated with the address. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the parcel address was last updated. -
Latitude: number
Title:
Latitude
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
Title:
Record ID
Maximum Length:50
A logical identifier for the application record. -
LnpRecordKey: integer
(int64)
Title:
Record
The unique identifier of the record associated with the parcel address. -
Longitude: number
Title:
Longitude
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. -
MunicipalityId: string
Title:
Municipality
Maximum Length:20
The municipality identifier if the parcel is not managed at the county level. -
ParcelId: integer
(int64)
Title:
Parcel
The identifier of the record parcel. -
ParcelKey: integer
(int64)
Title:
Parcel Key
The unique identifier of the parcel associated with a parcel address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code in the parcel address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
An extended postal code in the parcel address. -
PrimaryFlag: boolean
Title:
Primary
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. -
PrimaryTransAddress: boolean
Title:
Primary Transaction Address
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
Maximum Length:60
The province in the parcel address. -
Srid: integer
(int64)
Title:
SRID
The SRID of the parcel address. This attribute indicates the Spatial Reference System Identifier (SRID), which is a unique value that identifies projected, unprojected, and local spatial coordinate system definitions. Used in all GIS systems. -
State: string
Title:
State
Maximum Length:60
The state in the parcel address. -
StreetDirection: string
Title:
Direction
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
Maximum Length:240
The street name in the parcel address used during a search. -
StreetNameConcat: string
Maximum Length:
350
Indicates the concatenated value of the street name corresponding to the parcel address. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix and direction suffix. -
StreetNumber: string
Title:
Street Number
Maximum Length:20
The street number in the parcel address. -
StreetSuffix: string
Maximum Length:
20
The street suffix that further describes that street like Drive, Avenue etc. -
StreetType: string
Title:
Street Type
Maximum Length:20
The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber: string
Title:
Unit
Maximum Length:30
The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country
Maximum Length:10
The country code for the work telephone number of the parcel contact. -
WorkPhoneNumber: string
Title:
Work Phone
Maximum Length:40
The work telephone number of 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.