Get an address parcel row
get
/fscmRestApi/resources/11.13.18.05/publicSectorApSearches/{publicSectorApSearchesUniqID}
Request
Path Parameters
-
publicSectorApSearchesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AddressId and ParcelId ---for the AP Searches resource and used to uniquely identify an instance of AP Searches. The client should not generate the hash key value. Instead, the client should query on the AP Searches collection resource with a filter on the primary key values in order to navigate to a specific instance of AP Searches.
For example: publicSectorApSearches?q=AddressId=<value1>;ParcelId=<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(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 : publicSectorApSearches-item-response
Type:
Show Source
object
-
AdditionalStructure: string
Read Only:
true
Maximum Length:200
The information about additional structures located on the parcel. -
Address: string
Read Only:
true
Maximum Length:431
The concatenated parcel address columns. -
Address1: string
Read Only:
true
Maximum Length:240
The first line of the parcel address. -
Address2: string
Read Only:
true
Maximum Length:240
The second line of the parcel address. -
Address3: string
Read Only:
true
Maximum Length:240
The third line of the parcel address. -
Address4: string
Read Only:
true
Maximum Length:240
The fourth line of the parcel address. -
Addresscity: string
Read Only:
true
Maximum Length:544
The concatenated parcel address columns. -
AddressCode: string
Read Only:
true
Maximum Length:32
The address code of the parcel address. -
AddressCoordinateX: number
Read Only:
true
The x coordinate of the parcel address. -
AddressCoordinateY: number
Read Only:
true
The y coordinate of the parcel address. -
AddressEnabled: string
Read Only:
true
Maximum Length:1
Indicates whether the parcel address is available to be used. -
AddressId: integer
Read Only:
true
The unique identifier for the address. -
AddressLatitude: number
Read Only:
true
The latitude of the parcel address. -
AddressLongitude: number
Read Only:
true
The longitude of the parcel address. -
AddressPrimary: string
Read Only:
true
Maximum Length:1
Indicates whether the parcel address is marked as primary for that parcel. -
Bathrooms: string
Read Only:
true
Maximum Length:20
The number of bathrooms for the building on the parcel. -
Bedrooms: string
Read Only:
true
Maximum Length:20
The number of bedrooms for the building on the parcel. -
BlockNum: string
Read Only:
true
Maximum Length:30
The block number of the parcel. -
BookNum: string
Read Only:
true
Maximum Length:30
The parcel location referenced by land management as a book number, which is used to divide and organize land. -
BoundaryDescription: string
Read Only:
true
Maximum Length:480
The boundary description of the parcel. -
BuildingType: string
Read Only:
true
Maximum Length:20
The building type of the parcel address. -
CellPhoneCountry: string
Read Only:
true
Maximum Length:10
The cell phone country code of the parcel address. -
CellPhoneNum: string
Read Only:
true
Maximum Length:40
The cell phone number of the parcel address. -
CensusBlock: string
Read Only:
true
Maximum Length:100
The census block where the parcel of real estate is located. A census block is an area within a census tract, roughly equivalent to a neighborhood established by the Bureau of Census for analyzing populations. -
CensusTract: string
Read Only:
true
Maximum Length:100
The census tract where the parcel of real estate is located. A census tract is an area roughly equivalent to a neighborhood established by the Bureau of Census for analyzing populations. -
City: string
Read Only:
true
Maximum Length:60
The city of the parcel address. -
ClimateZone: string
Read Only:
true
Maximum Length:200
The climate zone area where the parcel of real estate is located. -
Country: string
Read Only:
true
Maximum Length:3
The country of the parcel address. -
County: string
Read Only:
true
Maximum Length:60
The county of the parcel address. -
CrossroadOne: string
Read Only:
true
Maximum Length:240
The first crossroad of the intersection. -
CrossroadTwo: string
Read Only:
true
Maximum Length:240
The second crossroad of the intersection. -
DwellingUnitCount: integer
(int64)
Read Only:
true
The number of dwelling units for the parcel. -
EmailId: string
Read Only:
true
Maximum Length:50
The email address. -
FaxCountry: string
Read Only:
true
Maximum Length:10
The fax country code of the parcel address. -
FaxNum: string
Read Only:
true
Maximum Length:40
The fax phone number of the parcel address. -
FireRisk: string
Read Only:
true
Maximum Length:200
Indicates a risk factor that helps land use planners and utilities to assess their risk from potential damages due to fires. -
FloodInsRateMap: string
Read Only:
true
Maximum Length:200
The flood insurance rate map related to the parcel location for floodplain management and insurance purposes. -
FloodZone: string
Read Only:
true
Maximum Length:200
The flood zone area where the parcel of real estate is located. -
Floor: string
Read Only:
true
Maximum Length:20
The floor the parcel address is on. -
GeneralPlanTwo: string
Read Only:
true
Maximum Length:30
The alternate land Information of the Parcel. -
HomePhoneCountry: string
Read Only:
true
Maximum Length:10
The home phone country code of the parcel address. -
HomePhoneNum: string
Read Only:
true
Maximum Length:40
The home phone number of the parcel address. -
Jurisdiction: string
Read Only:
true
Maximum Length:50
The jurisdiction of the parcel. -
Landmark: string
Read Only:
true
Maximum Length:200
The landmark associated with the address. -
LandslideRisk: string
Read Only:
true
Maximum Length:200
Indicates a risk factor that helps land use planners and utilities to assess their risk from potential damages due to landslides. -
LandUseCode: string
Read Only:
true
Maximum Length:30
The land use code of the parcel. Land use codes describe private or commercial use of land. They are used by the tax assessor to determine property tax amounts. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LiquefactionRisk: string
Read Only:
true
Maximum Length:200
Indicates a risk factor that helps land use planners and utilities to assess their risk from potential earthquake damages. -
LotNum: string
Read Only:
true
Maximum Length:30
The lot number of the parcel. -
MapBookPage: string
Read Only:
true
Maximum Length:50
The map book page where the parcel of real estate can be found in the records of the city or county. -
MapName: string
Read Only:
true
Maximum Length:50
The map name of the map in which the parcel of real estate can be found in the records of the city or county. -
NameOne: string
Read Only:
true
Maximum Length:150
The name of the first contact person. -
NameTwo: string
Read Only:
true
Maximum Length:150
The name of the second contact person. -
ParcelCoordinateX: number
Read Only:
true
The x coordinate of the parcel. -
ParcelCoordinateY: number
Read Only:
true
The y coordinate of the parcel. -
ParcelEnabled: string
Read Only:
true
Maximum Length:1
Indicates whether the parcel is available to be used. -
ParcelId: integer
(int64)
Read Only:
true
The unique identifier for the parcel. -
ParcelIdEntered: string
Read Only:
true
Maximum Length:30
The parcel number. -
ParcelLatitude: number
Read Only:
true
The latitude of the parcel. -
ParcelLongitude: number
Read Only:
true
The longitude of the parcel. -
ParcelSizeOne: number
Read Only:
true
The first line of the parcel size. -
ParcelSizeOneUnit: string
Read Only:
true
Maximum Length:10
The unit of measure for the first line of the parcel size. -
ParcelSizeTwo: number
Read Only:
true
The second line of the parcel size. -
ParcelSizeTwoUnit: string
Read Only:
true
Maximum Length:10
The unit of measure for the second line of the parcel size. -
ParcelStatus: string
Read Only:
true
Maximum Length:20
The status of the parcel. Values are Final or Provisional. -
ParcelType: string
Read Only:
true
Maximum Length:30
The type of the parcel. -
Patio: string
Read Only:
true
Maximum Length:200
The information about patios located on the parcel. -
Pool: string
Read Only:
true
Maximum Length:200
The information about pools located on the parcel. -
PostalCode: string
Read Only:
true
Maximum Length:60
The postal code of the parcel address. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:10
The postal plus 4 code of the parcel address. -
PrimaryZoningId: string
Read Only:
true
Maximum Length:30
The unique identifier for the primary zoning information of the parcel. -
PropertyDescription: string
Read Only:
true
Maximum Length:240
The property description of the parcel. -
Province: string
Read Only:
true
Maximum Length:60
The province of the parcel address. -
SectionNum: string
Read Only:
true
Maximum Length:30
The section number of the parcel. -
SoilType: string
Read Only:
true
Maximum Length:200
The soil type of the land for the parcel of real estate. -
State: string
Read Only:
true
Maximum Length:60
The state of the parcel address. -
StreetDirection: string
Read Only:
true
Maximum Length:10
The street direction of the parcel address. -
StreetName: string
Read Only:
true
Maximum Length:240
The street name of the parcel address. -
StreetNameConcat: string
Read Only:
true
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
Read Only:
true
Maximum Length:20
The street number of the parcel address. -
StreetNumberAlpha: string
Read Only:
true
Maximum Length:20
Indicates the alphabetic portion of the street number in the parcel address. -
StreetNumberNumeric: integer
(int64)
Read Only:
true
Indicates the numerical portion of the street number in the parcel address. -
StreetSuffix: string
Read Only:
true
Maximum Length:20
The street suffix that further describes that street like Drive, Avenue etc. -
StreetType: string
Read Only:
true
Maximum Length:20
The street type of the parcel address. -
StructureSizeOne: number
Read Only:
true
The first line of the structure size. -
StructureSizeOneUnit: string
Read Only:
true
Maximum Length:10
The unit of measure for the first line of the structure size. -
StructureSizeTwo: number
Read Only:
true
The second line of the structure size. -
StructureSizeTwoUnit: string
Read Only:
true
Maximum Length:10
The unit of measure for the second line of the structure size. -
Subdivision: string
Read Only:
true
Maximum Length:30
The subdivision of the parcel. -
TaxRateArea: string
Read Only:
true
Maximum Length:100
The area identifier of the parcel location for taxation purposes. -
UnitNum: string
Read Only:
true
Maximum Length:30
The unit number of the parcel. -
UnitNumber: string
Read Only:
true
Maximum Length:30
The unit number of the parcel. -
WorkPhoneCountry: string
Read Only:
true
Maximum Length:10
The work phone country code of the parcel address. -
WorkPhoneNum: string
Read Only:
true
Maximum Length:40
The work phone number of the parcel address. -
YearBuilt: string
Read Only:
true
Maximum Length:4
The year in which the building on the parcel was built. -
ZoningCodeTwo: string
Read Only:
true
Maximum Length:30
The secondary zoning code of the zoning related to the parcel. -
ZoningDescription: string
Read Only:
true
Maximum Length:240
The zoning description of the parcel.
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.