Create a parcel
post
/fscmRestApi/resources/11.13.18.05/publicSectorParcels
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AdditionalStructure: string
Title:
Additional StructureMaximum Length:200The information about additional structures located on the parcel. -
Bathrooms: string
Title:
BathroomsMaximum Length:20The number of bathrooms for the building on the parcel. -
Bedrooms: string
Title:
BedroomsMaximum Length:20The number of bedrooms for the building on the parcel. -
BlockNumber: string
Title:
Block NumberMaximum Length:30The block number of the parcel. -
BookNumber: string
Title:
Book NumberMaximum Length:30The book number of the parcel. -
BoundaryDescription: string
Title:
Boundary DescriptionMaximum Length:480The boundary description of the parcel. -
CensusBlock: string
Title:
Census BlockMaximum Length:100The neighbourhood information related to the location of the parcel. -
CensusTract: string
Title:
Census TractMaximum Length:100The neighbourhood information related to the location of the parcel. -
ClimateZone: string
Title:
Climate ZoneMaximum Length:200The detailed climate zone of the parcel. -
CoordinateX: number
Title:
X CoordinateIndicates the x coordinate of the parcel. -
CoordinateY: number
Title:
Y CoordinateIndicates the y coordinate of the parcel. -
DwellingUnitCount: integer
(int64)
Title:
Number of Dwelling UnitsThe number of dwelling units for the parcel. -
EnabledFlag: boolean
Title:
EnabledMaximum Length:1Indicates whether the parcel is available to be used. The default value is N. -
FinalParcelIdEntered: string
Maximum Length:
30The final parcel number. -
FireRisk: string
Title:
Fire RiskMaximum Length:200The fire risk associated with the parcel. -
FloodInsRateMap: string
Title:
Flood Insurance Rate MapMaximum Length:200The flood insurance rate map related to the parcel location for floodplain management and insurance purposes. -
FloodZone: string
Title:
Flood ZoneMaximum Length:200The detailed flood zone of the parcel. -
GeneralPlanTwo: string
Title:
General Plan 2Maximum Length:30The alternate land Information of the parcel. -
Jurisdiction: string
Title:
JurisdictionMaximum Length:50The jurisdiction of the parcel. -
LandslideRisk: string
Title:
Landslide RiskMaximum Length:200The landslide risk associated with the parcel. -
LandUseCode: string
Title:
General PlanMaximum Length:30The land use code of the parcel. -
Latitude: number
Title:
LatitudeThe latitude of the parcel. -
LiquefactionRisk: string
Title:
Liquefaction RiskMaximum Length:200The liquefaction risk associated with the parcel. -
Longitude: number
Title:
LongitudeThe longitude of the parcel. -
LotNumber: string
Title:
Lot NumberMaximum Length:30The lot number of the parcel. -
MapBookPage: string
Title:
Map Book PageMaximum Length:50Tthe map book page of the parcel. -
MapName: string
Title:
Map NameMaximum Length:50The map name of the parcel. -
ParcelId: integer
(int64)
Title:
Parcel IDThe unique identifier for the parcel. -
ParcelIdEntered: string
Title:
Parcel NumberMaximum Length:30The parcel number. -
ParcelSizeOne: number
Title:
Parcel Size 1The first parcel size. -
ParcelSizeOneUnit: string
Title:
Parcel Size 1 UOMMaximum Length:10The unit of measure for the first parcel size. -
ParcelSizeTwo: number
Title:
Parcel Size 2The second parcel size. -
ParcelSizeTwoUnit: string
Title:
Parcel Size 2 UOMMaximum Length:10The unit of measure for the second parcel size. -
ParcelStatus: string
Title:
StatusMaximum Length:20The status of the parcel which can be either Final or Provisional. -
ParcelType: string
Title:
Parcel TypeMaximum Length:30The type of parcel. -
ParcelUnitNumber: string
Title:
Unit NumberMaximum Length:30The unit number of the parcel. -
Patio: string
Title:
PatioMaximum Length:200The information about patios located on the parcel. -
Pool: string
Title:
PoolMaximum Length:200The information about pools located on the parcel. -
PrimaryZoningId: string
Title:
Zoning CodeMaximum Length:30The unique identifier for the primary zoning of the parcel. -
PropertyDescription: string
Title:
Property DescriptionMaximum Length:240The property description of the parcel. -
ProvParcelIdEntered: string
Maximum Length:
30The provisional parcel number. -
SectionNumber: string
Title:
Section NumberMaximum Length:30The section number of the parcel. -
SoilType: string
Title:
Soil TypeMaximum Length:200The soil type associated with the parcel. -
StructureSizeOne: number
Title:
Structure Size 1The first structure size. -
StructureSizeOneUnit: string
Title:
Structure Size 1 UOMMaximum Length:10The unit of measure for the first structure size. -
StructureSizeTwo: number
Title:
Structure Size 2The second structure size. -
StructureSizeTwoUnit: string
Title:
Structure Size 2 UOMMaximum Length:10The unit of measure for the second structure size. -
Subdivision: string
Title:
SubdivisionMaximum Length:30The subdivision of the parcel. -
TaxRateArea: string
Title:
Tax Rate AreaMaximum Length:100The area identifier of the parcel location for taxation purposes. -
YearBuilt: string
Title:
Year BuiltMaximum Length:4The year in which the building on the parcel was built. -
ZoningCodeTwo: string
Title:
Zoning Code 2Maximum Length:30The secondary code of the zoning related to the parcel. -
ZoningDescription: string
Title:
Zoning DescriptionMaximum Length:240The zoning description of the parcel.
Response
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 : publicSectorParcels-item-response
Type:
Show Source
object-
AdditionalStructure: string
Title:
Additional StructureMaximum Length:200The information about additional structures located on the parcel. -
Bathrooms: string
Title:
BathroomsMaximum Length:20The number of bathrooms for the building on the parcel. -
Bedrooms: string
Title:
BedroomsMaximum Length:20The number of bedrooms for the building on the parcel. -
BlockNumber: string
Title:
Block NumberMaximum Length:30The block number of the parcel. -
BookNumber: string
Title:
Book NumberMaximum Length:30The book number of the parcel. -
BoundaryDescription: string
Title:
Boundary DescriptionMaximum Length:480The boundary description of the parcel. -
CensusBlock: string
Title:
Census BlockMaximum Length:100The neighbourhood information related to the location of the parcel. -
CensusTract: string
Title:
Census TractMaximum Length:100The neighbourhood information related to the location of the parcel. -
ClimateZone: string
Title:
Climate ZoneMaximum Length:200The detailed climate zone of the parcel. -
CoordinateX: number
Title:
X CoordinateIndicates the x coordinate of the parcel. -
CoordinateY: number
Title:
Y CoordinateIndicates the y coordinate of the parcel. -
DwellingUnitCount: integer
(int64)
Title:
Number of Dwelling UnitsThe number of dwelling units for the parcel. -
EnabledFlag: boolean
Title:
EnabledMaximum Length:1Indicates whether the parcel is available to be used. The default value is N. -
FinalParcelIdEntered: string
Maximum Length:
30The final parcel number. -
FireRisk: string
Title:
Fire RiskMaximum Length:200The fire risk associated with the parcel. -
FloodInsRateMap: string
Title:
Flood Insurance Rate MapMaximum Length:200The flood insurance rate map related to the parcel location for floodplain management and insurance purposes. -
FloodZone: string
Title:
Flood ZoneMaximum Length:200The detailed flood zone of the parcel. -
GeneralPlanTwo: string
Title:
General Plan 2Maximum Length:30The alternate land Information of the parcel. -
Jurisdiction: string
Title:
JurisdictionMaximum Length:50The jurisdiction of the parcel. -
LandslideRisk: string
Title:
Landslide RiskMaximum Length:200The landslide risk associated with the parcel. -
LandUseCode: string
Title:
General PlanMaximum Length:30The land use code of the parcel. -
Latitude: number
Title:
LatitudeThe latitude of the parcel. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LiquefactionRisk: string
Title:
Liquefaction RiskMaximum Length:200The liquefaction risk associated with the parcel. -
Longitude: number
Title:
LongitudeThe longitude of the parcel. -
LotNumber: string
Title:
Lot NumberMaximum Length:30The lot number of the parcel. -
MapBookPage: string
Title:
Map Book PageMaximum Length:50Tthe map book page of the parcel. -
MapName: string
Title:
Map NameMaximum Length:50The map name of the parcel. -
PageNumber: string
Title:
Page NumberRead Only:trueMaximum Length:30The page number of the parcel. -
ParcelId: integer
(int64)
Title:
Parcel IDThe unique identifier for the parcel. -
ParcelIdEntered: string
Title:
Parcel NumberMaximum Length:30The parcel number. -
ParcelSizeOne: number
Title:
Parcel Size 1The first parcel size. -
ParcelSizeOneUnit: string
Title:
Parcel Size 1 UOMMaximum Length:10The unit of measure for the first parcel size. -
ParcelSizeTwo: number
Title:
Parcel Size 2The second parcel size. -
ParcelSizeTwoUnit: string
Title:
Parcel Size 2 UOMMaximum Length:10The unit of measure for the second parcel size. -
ParcelStatus: string
Title:
StatusMaximum Length:20The status of the parcel which can be either Final or Provisional. -
ParcelType: string
Title:
Parcel TypeMaximum Length:30The type of parcel. -
ParcelUnitNumber: string
Title:
Unit NumberMaximum Length:30The unit number of the parcel. -
ParentParcelId: integer
(int64)
Title:
Parent Parcel IDRead Only:trueThe unique identifier for the parent of the parcel. -
Patio: string
Title:
PatioMaximum Length:200The information about patios located on the parcel. -
Pool: string
Title:
PoolMaximum Length:200The information about pools located on the parcel. -
PrimaryZoningId: string
Title:
Zoning CodeMaximum Length:30The unique identifier for the primary zoning of the parcel. -
PropertyDescription: string
Title:
Property DescriptionMaximum Length:240The property description of the parcel. -
ProvParcelIdEntered: string
Maximum Length:
30The provisional parcel number. -
SectionNumber: string
Title:
Section NumberMaximum Length:30The section number of the parcel. -
SoilType: string
Title:
Soil TypeMaximum Length:200The soil type associated with the parcel. -
Srid: integer
(int64)
Read Only:
trueThe 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. -
StructureSizeOne: number
Title:
Structure Size 1The first structure size. -
StructureSizeOneUnit: string
Title:
Structure Size 1 UOMMaximum Length:10The unit of measure for the first structure size. -
StructureSizeTwo: number
Title:
Structure Size 2The second structure size. -
StructureSizeTwoUnit: string
Title:
Structure Size 2 UOMMaximum Length:10The unit of measure for the second structure size. -
Subdivision: string
Title:
SubdivisionMaximum Length:30The subdivision of the parcel. -
TaxRateArea: string
Title:
Tax Rate AreaMaximum Length:100The area identifier of the parcel location for taxation purposes. -
YearBuilt: string
Title:
Year BuiltMaximum Length:4The year in which the building on the parcel was built. -
ZoningCodeTwo: string
Title:
Zoning Code 2Maximum Length:30The secondary code of the zoning related to the parcel. -
ZoningDescription: string
Title:
Zoning DescriptionMaximum Length:240The zoning description of the parcel.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.