Get a record parcel
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}
Request
Path Parameters
-
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:
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 : publicSectorRecParcels-item-response
Type:
Show Source
object
-
AdditionalStructure: string
Maximum Length:
200
Information about additional structures located on the parcel. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the public sector agency associated with the parcel. -
Bathrooms: string
Maximum Length:
20
Number of bathrooms for the building on the parcel. -
Bedrooms: string
Maximum Length:
20
Number of bedrooms for the building on the parcel. -
BlockNumber: string
Title:
Block
Maximum Length:30
The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
BookNumber: string
Title:
Book
Maximum Length:30
The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
BoundaryDescription: string
Title:
Boundary Description
Maximum Length:480
A textual description of the property boundaries. This is not a listing of coordinates. For example, SMITH LOT - COME E 155 FT FROM SW CORNER OF LOT 206 THEN 77.5 FT N TO A LINE WHICH EXTENDS FROM A PT N 309.91 FT AND E 55.25 FT FROM BEG TO A PT E 155 FT FROM LOT 206. -
CensusBlock: string
Maximum Length:
100
Neighborhood information related to the location of the parcel. -
CensusTract: string
Maximum Length:
100
Neighborhood information related to the location of the parcel. -
ClimateZone: string
Maximum Length:
200
Climate zone information of the parcel. -
CoordinateX: number
Title:
Coordinate X
The x-axis coordinate for the record parcel. -
CoordinateY: number
Title:
Coordinate Y
The y-axis coordinate for the record parcel. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record parcel was created. -
DistrictName: string
Title:
District
Maximum Length:50
The district name of the parcel. -
DwellingUnitCount: integer
(int64)
The count of dwelling units in the record parcel.
-
FireRisk: string
Maximum Length:
200
Fire risk information related to the parcel. -
FloodInsRateMap: string
Maximum Length:
200
Flood Insurance Rate Map related to the parcel. -
FloodZone: string
Maximum Length:
200
Detailed land information of the parcel. -
GeneralPlanTwo: string
Maximum Length:
30
Alternate plan information of the parcel. -
Jurisdiction: string
Title:
Jurisdiction
Maximum Length:50
The name of the city, if incorporated, or the name of the county, if unincorporated. -
LandslideRisk: string
Maximum Length:
200
Landslide risk information related to the parcel. -
LandUseCode: string
Title:
Land Use
Maximum Length:30
The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record parcel was last updated. -
Latitude: number
Title:
Latitude
The geographic location of the parcel that is north or south of the equator. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LiquefactionRisk: string
Maximum Length:
200
Liquefaction risk information of the parcel. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The unique identifier for the application record. -
LnpRecordKey: integer
(int64)
Title:
Record
The unique identifier for the record associated with the parcel. -
Longitude: number
Title:
Longitude
The geographic location of the parcel that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance. -
LotNumber: string
Title:
Lot
Maximum Length:30
The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
MapBookPage: string
Title:
Map Book Page
Maximum Length:50
The recorded map book and page. -
MapName: string
Title:
Map Name
Maximum Length:50
The recorded map name. For example, Public Works. -
PageNumber: string
Title:
Page
Maximum Length:30
The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
ParcelAddress: array
Record Parcel Addresses
Title:
Record Parcel Addresses
The record parcel addresses resource is used to view, create, modify, or delete a record parcel address. Record parcel addresses are the street addresses of parcels or plots of real estate associated with a record. -
ParcelId: integer
(int64)
Title:
Parcel
The unique identifier of the record parcel. -
ParcelIdEntered: string
Title:
Parcel
Maximum Length:30
The Assessor Parcel Number (APN) as entered by the user. -
ParcelKey: integer
(int64)
Title:
Parcel Key
The unique identifier for a parcel. -
ParcelOwner: array
Record Parcel Owners
Title:
Record Parcel Owners
The record parcel owners resource is used to view, create, modify, or delete a record parcel owner. Record parcel owners are the owners of parcels or plots of real estate associated with a record. -
ParcelSizeOne: number
The first parcel size.
-
ParcelSizeOneUnit: string
Maximum Length:
10
The unit of measure for the first parcel size. -
ParcelSizeTwo: number
The second parcel size.
-
ParcelSizeTwoUnit: string
Maximum Length:
10
The unit of measure for the second parcel size. -
ParcelStatus: string
Maximum Length:
20
Default Value:ORA_FIN
The status of the parcel, which is Final or Provisional. -
ParcelType: string
Title:
Parcel Type
Maximum Length:30
The type of the parcel. For example, commercial, residential, or government. -
ParentParcelId: integer
(int64)
Title:
Parent Parcel
The unique identifier for the parent record parcel. -
Patio: string
Maximum Length:
200
Information about patios located on the parcel. -
Pool: string
Maximum Length:
200
Information about pools located on the parcel. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates the primary parcel. If the value is Y, then the parcel is the primary parcel. The default value is N. -
PrimaryZoningId: string
Title:
Primary Zone
Maximum Length:30
The primary zoning ID of the zoning for the parcel. -
PropertyDescription: string
Title:
Property Description
Maximum Length:240
The property description. -
SectionNumber: string
Title:
Section
Maximum Length:30
The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
Shape: object
Shape
The spatial field of a record parcel, which is the storage field for the shape information.
-
ShapeJson: string
The transient string field of a record parcel, which is the shape's JSON data from the ESRI GIS server.
-
SoilType: string
Maximum Length:
200
Soil type information of the parcel. -
Srid: integer
(int64)
Title:
SRID
The GIS coordinate system in use. -
StructureSizeOne: number
The first structure size.
-
StructureSizeOneUnit: string
Maximum Length:
10
The unit of measure for the first structure size. -
StructureSizeTwo: number
The second structure size.
-
StructureSizeTwoUnit: string
Maximum Length:
10
The unit of measure for the second structure size. -
Subdivision: string
Title:
Subdivision
Maximum Length:30
The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
TaxRateArea: string
Maximum Length:
100
Area Identifier of the parcel location for taxation purpose. -
UnitNumber: string
Title:
Unit
Maximum Length:30
The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
YearBuilt: string
Maximum Length:
4
The year in which the building on the parcel was built. -
ZoningCodeTwo: string
Maximum Length:
30
Indicates secondary zoning code of the parcel. -
ZoningDescription: string
Title:
Zone Description
Maximum Length:240
The zoning description.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Record Parcel Addresses
Type:
array
Title:
Record Parcel Addresses
The record parcel addresses resource is used to view, create, modify, or delete a record parcel address. Record parcel addresses are the street addresses of parcels or plots of real estate associated with a record.
Show Source
Nested Schema : Record Parcel Owners
Type:
array
Title:
Record Parcel Owners
The record parcel owners resource is used to view, create, modify, or delete a record parcel owner. Record parcel owners are the owners of parcels or plots of real estate associated with a record.
Show Source
Nested Schema : Shape
Type:
object
The spatial field of a record parcel, which is the storage field for the shape information.
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.
Nested Schema : publicSectorRecParcels-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 of a public sector agency associated with the parcel address. -
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 for 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 using the 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, and so on. -
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 : publicSectorRecParcels-ParcelOwner-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first or main address of the parcel owner. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address of the parcel owner, if present. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address of the parcel owner, if present. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address of the parcel owner, if present. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for a public sector agency associated with a parcel owner. -
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 owner. -
CellPhoneNumber: string
Title:
Cell Phone
Maximum Length:40
The cell phone number of the parcel owner. -
City: string
Title:
City
Maximum Length:60
The city in the parcel owner's address. -
Country: string
Title:
Country
Maximum Length:60
The country in the parcel owner's address. -
County: string
Title:
County
Maximum Length:60
The county in the parcel owner's address. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the parcel owner was created. -
DocumentNumber: string
Title:
Document
Maximum Length:50
The County Recorder's office document number for the transfer of ownership. -
EmailId: string
Title:
Email
Maximum Length:50
The email address of the parcel owner. -
FaxCountry: string
Title:
Fax Country
Maximum Length:10
The country code for the fax number of the parcel owner. -
FaxNumber: string
Title:
Fax
Maximum Length:40
The fax number of the parcel owner. -
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 owner. -
HomePhoneNumber: string
Title:
Home Phone
Maximum Length:40
The home telephone number of the parcel owner. -
LastTransferDate: string
(date)
Title:
Last Transfer Date
The date of the last transfer of ownership. -
LastTransferType: string
Title:
Last Transfer Type
Maximum Length:50
The type of last transfer of ownership. For example, grant deed, gift deed, or regular sale. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the parcel owner was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The unique identifier for the application record. -
LnpRecordKey: integer
(int64)
Title:
Record
The unique identifier for the record associated with the parcel. -
Owner: string
Title:
Owner
Maximum Length:150
The name of the first or main owner. -
OwnerId: integer
(int64)
Title:
Owner
The unique identifier for the parcel owner. -
OwnerKey: integer
(int64)
Title:
Owner Key
The unique identifier for a record parcel owner. -
OwnerType: string
Title:
Ownership Type
Maximum Length:20
The type of ownership. For example, business or private person. -
ParcelId: integer
(int64)
Title:
Parcel
The unique identifier for the parcel. -
ParcelKey: integer
(int64)
Title:
Parcel Key
The unique identifier for the record parcel. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code in the parcel owner's address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
An extended postal code in the parcel owner's address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates the primary parcel owner. If the value is Y, then the parcel owner is the primary owner. The default value is N. -
Province: string
Title:
Province
Maximum Length:60
The province in the parcel owner's address. -
SecondaryOwner: string
Title:
Secondary Owner
Maximum Length:150
The name of the secondary owner. -
State: string
Title:
State
Maximum Length:60
The state in the parcel owner's 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 owner's address used during a search. -
StreetNumber: string
Title:
Street Number
Maximum Length:20
The street number in the parcel owner's address. -
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 owner. -
WorkPhoneNumber: string
Title:
Work Phone
Maximum Length:40
The work telephone number of the parcel owner.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ParcelAddress
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddressParameters:
- ParcelKey:
$request.path.ParcelKey
The record parcel addresses resource is used to view, create, modify, or delete a record parcel address. Record parcel addresses are the street addresses of parcels or plots of real estate associated with a record. - ParcelKey:
- ParcelOwner
-
Parameters:
- ParcelKey:
$request.path.ParcelKey
The record parcel owners resource is used to view, create, modify, or delete a record parcel owner. Record parcel owners are the owners of parcels or plots of real estate associated with a record. - ParcelKey: