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 Structure
Maximum Length:200
The information about additional structures located on the parcel. -
Bathrooms: string
Title:
Bathrooms
Maximum Length:20
The number of bathrooms for the building on the parcel. -
Bedrooms: string
Title:
Bedrooms
Maximum Length:20
The number of bedrooms for the building on the parcel. -
BlockNumber: string
Title:
Block Number
Maximum Length:30
The block number of the parcel. -
BookNumber: string
Title:
Book Number
Maximum Length:30
The book number of the parcel. -
BoundaryDescription: string
Title:
Boundary Description
Maximum Length:480
The boundary description of the parcel. -
CensusBlock: string
Title:
Census Block
Maximum Length:100
The neighbourhood information related to the location of the parcel. -
CensusTract: string
Title:
Census Tract
Maximum Length:100
The neighbourhood information related to the location of the parcel. -
ClimateZone: string
Title:
Climate Zone
Maximum Length:200
The detailed climate zone of the parcel. -
CoordinateX: number
Title:
X Coordinate
Indicates the x coordinate of the parcel. -
CoordinateY: number
Title:
Y Coordinate
Indicates the y coordinate of the parcel. -
DwellingUnitCount: integer
(int64)
Title:
Number of Dwelling Units
The number of dwelling units for the parcel. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the parcel is available to be used. The default value is N. -
FinalParcelIdEntered: string
Maximum Length:
30
The final parcel number. -
FireRisk: string
Title:
Fire Risk
Maximum Length:200
The fire risk associated with the parcel. -
FloodInsRateMap: string
Title:
Flood Insurance Rate Map
Maximum Length:200
The flood insurance rate map related to the parcel location for floodplain management and insurance purposes. -
FloodZone: string
Title:
Flood Zone
Maximum Length:200
The detailed flood zone of the parcel. -
GeneralPlanTwo: string
Title:
General Plan 2
Maximum Length:30
The alternate land Information of the parcel. -
Jurisdiction: string
Title:
Jurisdiction
Maximum Length:50
The jurisdiction of the parcel. -
LandslideRisk: string
Title:
Landslide Risk
Maximum Length:200
The landslide risk associated with the parcel. -
LandUseCode: string
Title:
General Plan
Maximum Length:30
The land use code of the parcel. -
Latitude: number
Title:
Latitude
The latitude of the parcel. -
LiquefactionRisk: string
Title:
Liquefaction Risk
Maximum Length:200
The liquefaction risk associated with the parcel. -
Longitude: number
Title:
Longitude
The longitude of the parcel. -
LotNumber: string
Title:
Lot Number
Maximum Length:30
The lot number of the parcel. -
MapBookPage: string
Title:
Map Book Page
Maximum Length:50
Tthe map book page of the parcel. -
MapName: string
Title:
Map Name
Maximum Length:50
The map name of the parcel. -
ParcelId: integer
(int64)
Title:
Parcel ID
The unique identifier for the parcel. -
ParcelIdEntered: string
Title:
Parcel Number
Maximum Length:30
The parcel number. -
ParcelSizeOne: number
Title:
Parcel Size 1
The first parcel size. -
ParcelSizeOneUnit: string
Title:
Parcel Size 1 UOM
Maximum Length:10
The unit of measure for the first parcel size. -
ParcelSizeTwo: number
Title:
Parcel Size 2
The second parcel size. -
ParcelSizeTwoUnit: string
Title:
Parcel Size 2 UOM
Maximum Length:10
The unit of measure for the second parcel size. -
ParcelStatus: string
Title:
Status
Maximum Length:20
The status of the parcel which can be either Final or Provisional. -
ParcelType: string
Title:
Parcel Type
Maximum Length:30
The type of parcel. -
ParcelUnitNumber: string
Title:
Unit Number
Maximum Length:30
The unit number of the parcel. -
Patio: string
Title:
Patio
Maximum Length:200
The information about patios located on the parcel. -
Pool: string
Title:
Pool
Maximum Length:200
The information about pools located on the parcel. -
PrimaryZoningId: string
Title:
Zoning Code
Maximum Length:30
The unique identifier for the primary zoning of the parcel. -
PropertyDescription: string
Title:
Property Description
Maximum Length:240
The property description of the parcel. -
ProvParcelIdEntered: string
Maximum Length:
30
The provisional parcel number. -
SectionNumber: string
Title:
Section Number
Maximum Length:30
The section number of the parcel. -
SoilType: string
Title:
Soil Type
Maximum Length:200
The soil type associated with the parcel. -
StructureSizeOne: number
Title:
Structure Size 1
The first structure size. -
StructureSizeOneUnit: string
Title:
Structure Size 1 UOM
Maximum Length:10
The unit of measure for the first structure size. -
StructureSizeTwo: number
Title:
Structure Size 2
The second structure size. -
StructureSizeTwoUnit: string
Title:
Structure Size 2 UOM
Maximum Length:10
The unit of measure for the second structure size. -
Subdivision: string
Title:
Subdivision
Maximum Length:30
The subdivision of the parcel. -
TaxRateArea: string
Title:
Tax Rate Area
Maximum Length:100
The area identifier of the parcel location for taxation purposes. -
YearBuilt: string
Title:
Year Built
Maximum Length:4
The year in which the building on the parcel was built. -
ZoningCodeTwo: string
Title:
Zoning Code 2
Maximum Length:30
The secondary code of the zoning related to the parcel. -
ZoningDescription: string
Title:
Zoning Description
Maximum Length:240
The 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(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 : publicSectorParcels-item-response
Type:
Show Source
object
-
AdditionalStructure: string
Title:
Additional Structure
Maximum Length:200
The information about additional structures located on the parcel. -
Bathrooms: string
Title:
Bathrooms
Maximum Length:20
The number of bathrooms for the building on the parcel. -
Bedrooms: string
Title:
Bedrooms
Maximum Length:20
The number of bedrooms for the building on the parcel. -
BlockNumber: string
Title:
Block Number
Maximum Length:30
The block number of the parcel. -
BookNumber: string
Title:
Book Number
Maximum Length:30
The book number of the parcel. -
BoundaryDescription: string
Title:
Boundary Description
Maximum Length:480
The boundary description of the parcel. -
CensusBlock: string
Title:
Census Block
Maximum Length:100
The neighbourhood information related to the location of the parcel. -
CensusTract: string
Title:
Census Tract
Maximum Length:100
The neighbourhood information related to the location of the parcel. -
ClimateZone: string
Title:
Climate Zone
Maximum Length:200
The detailed climate zone of the parcel. -
CoordinateX: number
Title:
X Coordinate
Indicates the x coordinate of the parcel. -
CoordinateY: number
Title:
Y Coordinate
Indicates the y coordinate of the parcel. -
DwellingUnitCount: integer
(int64)
Title:
Number of Dwelling Units
The number of dwelling units for the parcel. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the parcel is available to be used. The default value is N. -
FinalParcelIdEntered: string
Maximum Length:
30
The final parcel number. -
FireRisk: string
Title:
Fire Risk
Maximum Length:200
The fire risk associated with the parcel. -
FloodInsRateMap: string
Title:
Flood Insurance Rate Map
Maximum Length:200
The flood insurance rate map related to the parcel location for floodplain management and insurance purposes. -
FloodZone: string
Title:
Flood Zone
Maximum Length:200
The detailed flood zone of the parcel. -
GeneralPlanTwo: string
Title:
General Plan 2
Maximum Length:30
The alternate land Information of the parcel. -
Jurisdiction: string
Title:
Jurisdiction
Maximum Length:50
The jurisdiction of the parcel. -
LandslideRisk: string
Title:
Landslide Risk
Maximum Length:200
The landslide risk associated with the parcel. -
LandUseCode: string
Title:
General Plan
Maximum Length:30
The land use code of the parcel. -
Latitude: number
Title:
Latitude
The latitude of the parcel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LiquefactionRisk: string
Title:
Liquefaction Risk
Maximum Length:200
The liquefaction risk associated with the parcel. -
Longitude: number
Title:
Longitude
The longitude of the parcel. -
LotNumber: string
Title:
Lot Number
Maximum Length:30
The lot number of the parcel. -
MapBookPage: string
Title:
Map Book Page
Maximum Length:50
Tthe map book page of the parcel. -
MapName: string
Title:
Map Name
Maximum Length:50
The map name of the parcel. -
PageNumber: string
Title:
Page Number
Read Only:true
Maximum Length:30
The page number of the parcel. -
ParcelId: integer
(int64)
Title:
Parcel ID
The unique identifier for the parcel. -
ParcelIdEntered: string
Title:
Parcel Number
Maximum Length:30
The parcel number. -
ParcelSizeOne: number
Title:
Parcel Size 1
The first parcel size. -
ParcelSizeOneUnit: string
Title:
Parcel Size 1 UOM
Maximum Length:10
The unit of measure for the first parcel size. -
ParcelSizeTwo: number
Title:
Parcel Size 2
The second parcel size. -
ParcelSizeTwoUnit: string
Title:
Parcel Size 2 UOM
Maximum Length:10
The unit of measure for the second parcel size. -
ParcelStatus: string
Title:
Status
Maximum Length:20
The status of the parcel which can be either Final or Provisional. -
ParcelType: string
Title:
Parcel Type
Maximum Length:30
The type of parcel. -
ParcelUnitNumber: string
Title:
Unit Number
Maximum Length:30
The unit number of the parcel. -
ParentParcelId: integer
(int64)
Title:
Parent Parcel ID
Read Only:true
The unique identifier for the parent of the parcel. -
Patio: string
Title:
Patio
Maximum Length:200
The information about patios located on the parcel. -
Pool: string
Title:
Pool
Maximum Length:200
The information about pools located on the parcel. -
PrimaryZoningId: string
Title:
Zoning Code
Maximum Length:30
The unique identifier for the primary zoning of the parcel. -
PropertyDescription: string
Title:
Property Description
Maximum Length:240
The property description of the parcel. -
ProvParcelIdEntered: string
Maximum Length:
30
The provisional parcel number. -
SectionNumber: string
Title:
Section Number
Maximum Length:30
The section number of the parcel. -
SoilType: string
Title:
Soil Type
Maximum Length:200
The soil type associated with the parcel. -
Srid: integer
(int64)
Read Only:
true
The 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 1
The first structure size. -
StructureSizeOneUnit: string
Title:
Structure Size 1 UOM
Maximum Length:10
The unit of measure for the first structure size. -
StructureSizeTwo: number
Title:
Structure Size 2
The second structure size. -
StructureSizeTwoUnit: string
Title:
Structure Size 2 UOM
Maximum Length:10
The unit of measure for the second structure size. -
Subdivision: string
Title:
Subdivision
Maximum Length:30
The subdivision of the parcel. -
TaxRateArea: string
Title:
Tax Rate Area
Maximum Length:100
The area identifier of the parcel location for taxation purposes. -
YearBuilt: string
Title:
Year Built
Maximum Length:4
The year in which the building on the parcel was built. -
ZoningCodeTwo: string
Title:
Zoning Code 2
Maximum Length:30
The secondary code of the zoning related to the parcel. -
ZoningDescription: string
Title:
Zoning Description
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.