Create parcel import options
post
/fscmRestApi/resources/11.13.18.05/publicSectorParcelImportOptions
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
-
Address2Flag: boolean
Title:
Address Line 2
Maximum Length:1
Indicates whether the attribute Address Line 2 should be part of the combination of address attributes used to identify a new address. -
AgencyId: integer
(int32)
Title:
Agency ID
The unique identifier of the agency associated with the options. Value is mandatory and is set programmatically. -
CityFlag: boolean
Title:
City
Maximum Length:1
Indicates whether the attribute City should be part of the combination of address attributes used to identify a new address. -
DisableMissingAddressFlag: boolean
Title:
Disable Addresses Not Found in Import File
Maximum Length:1
Indicates whether reference addresses in the database that are not in the address import file should be disabled. This option should only be used when the address import file contains a complete set of addresses for each parcel, including addresses with no changes. -
DisableMissingDistrictFlag: boolean
Title:
Delete District Assignments Not Found in Import File
Maximum Length:1
Indicates whether parcel district assignments in your database that are not in the district import file should be deleted. This option should only be used when the district import file contains a complete set of districts for each parcel, including districts with no changes. -
DisableMissingParcelOwnerFlag: boolean
Title:
Disable Owners Not Found in Import File
Maximum Length:1
Indicates whether reference owners in your database that are not in the owner import file should be disabled. This option should only be used when the owner import file contains a complete set of owners for each parcel, including owners with no changes. -
FloorFlag: boolean
Title:
Floor
Maximum Length:1
Indicates whether the attribute Floor should be part of the combination of address attributes used to identify a new address. -
ImportAddressConditionFlag: boolean
Title:
Address Condition
Maximum Length:1
Indicates whether an address condition import file is to be processed by the Import Parcel Information process. -
ImportAddressDistrictFlag: boolean
Maximum Length:
1
Indicates whether an address district import file is to be processed by the Import Parcel Information process. -
ImportParcelAddressFlag: boolean
Maximum Length:
1
Indicates whether a parcel address import file is to be processed by the Import Parcel Information process. -
ImportParcelConditionFlag: boolean
Title:
Parcel Condition
Maximum Length:1
Indicates whether a parcel condition import file is to be processed by the Import Parcel Information process. -
ImportParcelDistrictFlag: boolean
Maximum Length:
1
Indicates whether a parcel district import file is to be processed by the Import Parcel Information process. -
ImportParcelFlag: boolean
Maximum Length:
1
Indicates whether a parcel import file is to be processed by the Import Parcel Information process. -
ImportParcelOwnerFlag: boolean
Maximum Length:
1
Indicates whether a parcel owner import file is to be processed by the Import Parcel Information process. -
ImportParcelValueFlag: boolean
Title:
Value
Maximum Length:1
Indicates whether a parcel value import file is to be processed by the Import Parcel Information process. -
MapAddressDistrict: string
Maximum Length:
50
Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the address district import file. -
MapParcel: string
Maximum Length:
50
Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel import file. -
MapParcelAddress: string
Maximum Length:
50
Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel address import file. -
MapParcelDistrict: string
Maximum Length:
50
Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel district import file. -
MapParcelOwner: string
Maximum Length:
50
Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel owner import file. -
MapParcelValue: string
Maximum Length:
50
Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel value import file. -
MissingAddconFlag: boolean
Title:
Resolve Address Conditions Not Found in Import File
Maximum Length:1
Indicates whether property address conditions in your database that are not in the address condition import file should be resolved. This option should only be used when the address condition import file contains a complete set of active property address conditions. -
MissingParconFlag: boolean
Title:
Resolve Parcel Conditions Not Found in Import File
Maximum Length:1
Indicates whether parcel conditions in your database that are not in the parcel condition import file should be resolved. This option should only be used when the parcel condition import file contains a complete set of active parcel conditions. -
OptionalProcessEight: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessFive: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessFour: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessNine: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessOne: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessSeven: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessSix: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessThree: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessTwo: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OwnerAddress2Flag: boolean
Title:
Address Line 2
Maximum Length:1
Indicates whether the attribute Address Line 2 should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
OwnerAddressFlag: boolean
Title:
Address Line 1
Maximum Length:1
Indicates whether the attribute Address Line 1 should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
OwnerCityFlag: boolean
Title:
City
Maximum Length:1
Indicates whether the attribute City should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
OwnerNameFlag: boolean
Title:
Owner Name
Maximum Length:1
Indicates whether the attribute Owner Name should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
OwnerPostalCodeFlag: boolean
Title:
Postal Code
Maximum Length:1
Indicates whether the attribute Postal Code should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
OwnerStateFlag: boolean
Title:
State
Maximum Length:1
Indicates whether the attribute State should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
PostalCodeFlag: boolean
Title:
Postal Code
Maximum Length:1
Indicates whether the attribute Postal Code should be part of the combination of address attributes used to identify a new address. -
PreviewMode: boolean
Maximum Length:
1
Indicates whether the Import Parcel Information process should allow the user to review a list of parcel reference data to be inactivated prior to performing the updates. -
RetireMissingParcelFlag: boolean
Title:
Retire Parcels Not Found in Import File
Maximum Length:1
Indicates whether reference parcels in the database that are not in the parcel import file should be retired. This option should only be used when the parcel import file contains a complete set of active parcels, including parcels with no changes. -
SecondaryOwnerNameFlag: boolean
Title:
Secondary Owner
Maximum Length:1
Indicates whether the attribute Secondary Owner should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
StateFlag: boolean
Title:
State
Maximum Length:1
Indicates whether the attribute State should be part of the combination of address attributes used to identify a new address. -
StreetDirectionFlag: boolean
Title:
Direction Prefix
Maximum Length:1
Indicates whether the attribute Direction Prefix should be part of the combination of address attributes used to identify a new address. -
StreetNameFlag: boolean
Title:
Street Name
Maximum Length:1
Indicates whether the attribute Street Name should be part of the combination of address attributes used to identify a new address. -
StreetNumberFlag: boolean
Title:
Street Number
Maximum Length:1
Indicates whether the attribute Street Number should be part of the combination of address attributes used to identify a new address. -
StreetSuffixFlag: boolean
Title:
Direction Suffix
Maximum Length:1
Indicates whether the attribute Direction Suffix should be part of the combination of address attributes used to identify a new address. -
StreetTypeFlag: boolean
Title:
Street Suffix
Maximum Length:1
Indicates whether the attribute Street Suffix should be part of the combination of address attributes used to identify a new address. -
UnitNumberFlag: boolean
Title:
Unit
Maximum Length:1
Indicates whether the attribute Unit should be part of the combination of address attributes used to identify a new address.
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 : publicSectorParcelImportOptions-item-response
Type:
Show Source
object
-
Address2Flag: boolean
Title:
Address Line 2
Maximum Length:1
Indicates whether the attribute Address Line 2 should be part of the combination of address attributes used to identify a new address. -
AgencyId: integer
(int32)
Title:
Agency ID
The unique identifier of the agency associated with the options. Value is mandatory and is set programmatically. -
CityFlag: boolean
Title:
City
Maximum Length:1
Indicates whether the attribute City should be part of the combination of address attributes used to identify a new address. -
DisableMissingAddressFlag: boolean
Title:
Disable Addresses Not Found in Import File
Maximum Length:1
Indicates whether reference addresses in the database that are not in the address import file should be disabled. This option should only be used when the address import file contains a complete set of addresses for each parcel, including addresses with no changes. -
DisableMissingDistrictFlag: boolean
Title:
Delete District Assignments Not Found in Import File
Maximum Length:1
Indicates whether parcel district assignments in your database that are not in the district import file should be deleted. This option should only be used when the district import file contains a complete set of districts for each parcel, including districts with no changes. -
DisableMissingParcelOwnerFlag: boolean
Title:
Disable Owners Not Found in Import File
Maximum Length:1
Indicates whether reference owners in your database that are not in the owner import file should be disabled. This option should only be used when the owner import file contains a complete set of owners for each parcel, including owners with no changes. -
FloorFlag: boolean
Title:
Floor
Maximum Length:1
Indicates whether the attribute Floor should be part of the combination of address attributes used to identify a new address. -
ImportAddressConditionFlag: boolean
Title:
Address Condition
Maximum Length:1
Indicates whether an address condition import file is to be processed by the Import Parcel Information process. -
ImportAddressDistrictFlag: boolean
Maximum Length:
1
Indicates whether an address district import file is to be processed by the Import Parcel Information process. -
ImportParcelAddressFlag: boolean
Maximum Length:
1
Indicates whether a parcel address import file is to be processed by the Import Parcel Information process. -
ImportParcelConditionFlag: boolean
Title:
Parcel Condition
Maximum Length:1
Indicates whether a parcel condition import file is to be processed by the Import Parcel Information process. -
ImportParcelDistrictFlag: boolean
Maximum Length:
1
Indicates whether a parcel district import file is to be processed by the Import Parcel Information process. -
ImportParcelFlag: boolean
Maximum Length:
1
Indicates whether a parcel import file is to be processed by the Import Parcel Information process. -
ImportParcelOwnerFlag: boolean
Maximum Length:
1
Indicates whether a parcel owner import file is to be processed by the Import Parcel Information process. -
ImportParcelValueFlag: boolean
Title:
Value
Maximum Length:1
Indicates whether a parcel value import file is to be processed by the Import Parcel Information process. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MapAddressDistrict: string
Maximum Length:
50
Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the address district import file. -
MapParcel: string
Maximum Length:
50
Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel import file. -
MapParcelAddress: string
Maximum Length:
50
Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel address import file. -
MapParcelDistrict: string
Maximum Length:
50
Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel district import file. -
MapParcelOwner: string
Maximum Length:
50
Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel owner import file. -
MapParcelValue: string
Maximum Length:
50
Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel value import file. -
MissingAddconFlag: boolean
Title:
Resolve Address Conditions Not Found in Import File
Maximum Length:1
Indicates whether property address conditions in your database that are not in the address condition import file should be resolved. This option should only be used when the address condition import file contains a complete set of active property address conditions. -
MissingParconFlag: boolean
Title:
Resolve Parcel Conditions Not Found in Import File
Maximum Length:1
Indicates whether parcel conditions in your database that are not in the parcel condition import file should be resolved. This option should only be used when the parcel condition import file contains a complete set of active parcel conditions. -
OptionalProcessEight: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessFive: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessFour: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessNine: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessOne: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessSeven: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessSix: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessThree: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OptionalProcessTwo: string
Maximum Length:
20
The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process. -
OwnerAddress2Flag: boolean
Title:
Address Line 2
Maximum Length:1
Indicates whether the attribute Address Line 2 should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
OwnerAddressFlag: boolean
Title:
Address Line 1
Maximum Length:1
Indicates whether the attribute Address Line 1 should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
OwnerCityFlag: boolean
Title:
City
Maximum Length:1
Indicates whether the attribute City should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
OwnerNameFlag: boolean
Title:
Owner Name
Maximum Length:1
Indicates whether the attribute Owner Name should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
OwnerPostalCodeFlag: boolean
Title:
Postal Code
Maximum Length:1
Indicates whether the attribute Postal Code should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
OwnerStateFlag: boolean
Title:
State
Maximum Length:1
Indicates whether the attribute State should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
PostalCodeFlag: boolean
Title:
Postal Code
Maximum Length:1
Indicates whether the attribute Postal Code should be part of the combination of address attributes used to identify a new address. -
PreviewMode: boolean
Maximum Length:
1
Indicates whether the Import Parcel Information process should allow the user to review a list of parcel reference data to be inactivated prior to performing the updates. -
RetireMissingParcelFlag: boolean
Title:
Retire Parcels Not Found in Import File
Maximum Length:1
Indicates whether reference parcels in the database that are not in the parcel import file should be retired. This option should only be used when the parcel import file contains a complete set of active parcels, including parcels with no changes. -
SecondaryOwnerNameFlag: boolean
Title:
Secondary Owner
Maximum Length:1
Indicates whether the attribute Secondary Owner should be part of the combination of parcel owner attributes used to identify a new parcel owner. -
StateFlag: boolean
Title:
State
Maximum Length:1
Indicates whether the attribute State should be part of the combination of address attributes used to identify a new address. -
StreetDirectionFlag: boolean
Title:
Direction Prefix
Maximum Length:1
Indicates whether the attribute Direction Prefix should be part of the combination of address attributes used to identify a new address. -
StreetNameFlag: boolean
Title:
Street Name
Maximum Length:1
Indicates whether the attribute Street Name should be part of the combination of address attributes used to identify a new address. -
StreetNumberFlag: boolean
Title:
Street Number
Maximum Length:1
Indicates whether the attribute Street Number should be part of the combination of address attributes used to identify a new address. -
StreetSuffixFlag: boolean
Title:
Direction Suffix
Maximum Length:1
Indicates whether the attribute Direction Suffix should be part of the combination of address attributes used to identify a new address. -
StreetTypeFlag: boolean
Title:
Street Suffix
Maximum Length:1
Indicates whether the attribute Street Suffix should be part of the combination of address attributes used to identify a new address. -
UnitNumberFlag: boolean
Title:
Unit
Maximum Length:1
Indicates whether the attribute Unit should be part of the combination of address attributes used to identify a new address.
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.