Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "DisableMissingAddressFlag":{
            "title":"Disable Addresses Not Found in Import File",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "OwnerNameFlag":{
            "title":"Owner Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Owner Name should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "OwnerAddressFlag":{
            "title":"Address Line 1",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Address Line 1 should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImportParcelFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a parcel import file is to be processed by the Import Parcel Information process.",
            "nullable":true
        },
        "CityFlag":{
            "title":"City",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute City should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "OptionalProcessFive":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true
        },
        "OptionalProcessNine":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true
        },
        "StreetTypeFlag":{
            "title":"Street Suffix",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Street Suffix should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "DisableMissingDistrictFlag":{
            "title":"Delete District Assignments Not Found in Import File",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "MapParcelAddress":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "StreetNumberFlag":{
            "title":"Street Number",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Street Number should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "Address2Flag":{
            "title":"Address Line 2",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Address Line 2 should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImportParcelAddressFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a parcel address import file is to be processed by the Import Parcel Information process.",
            "nullable":true
        },
        "OptionalProcessThree":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true
        },
        "PreviewMode":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "MissingAddconFlag":{
            "title":"Resolve Address Conditions Not Found in Import File",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "FloorFlag":{
            "title":"Floor",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Floor should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "DisableMissingParcelOwnerFlag":{
            "title":"Disable Owners Not Found in Import File",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "OptionalProcessFour":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true
        },
        "OwnerAddress2Flag":{
            "title":"Address Line 2",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Address Line 2 should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true
        },
        "OwnerPostalCodeFlag":{
            "title":"Postal Code",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Postal Code should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "SecondaryOwnerNameFlag":{
            "title":"Secondary Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Secondary Owner should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImportParcelDistrictFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a parcel district import file is to be processed by the Import Parcel Information process.",
            "nullable":true
        },
        "StreetDirectionFlag":{
            "title":"Direction Prefix",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Direction Prefix should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "RetireMissingParcelFlag":{
            "title":"Retire Parcels Not Found in Import File",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "StreetSuffixFlag":{
            "title":"Direction Suffix",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Direction Suffix should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImportParcelConditionFlag":{
            "title":"Parcel Condition",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a parcel condition import file is to be processed by the Import Parcel Information process.",
            "nullable":true
        },
        "OptionalProcessSix":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true
        },
        "OptionalProcessOne":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true
        },
        "UnitNumberFlag":{
            "title":"Unit",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Unit should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "OptionalProcessEight":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the options. Value is mandatory and is set programmatically.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "MissingParconFlag":{
            "title":"Resolve Parcel Conditions Not Found in Import File",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "MapParcelOwner":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "PostalCodeFlag":{
            "title":"Postal Code",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Postal Code should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImportParcelOwnerFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a parcel owner import file is to be processed by the Import Parcel Information process.",
            "nullable":true
        },
        "MapParcel":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "OptionalProcessTwo":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true
        },
        "ImportParcelValueFlag":{
            "title":"Value",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a parcel value import file is to be processed by the Import Parcel Information process.",
            "nullable":true
        },
        "MapParcelDistrict":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "StateFlag":{
            "title":"State",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute State should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "StreetNameFlag":{
            "title":"Street Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Street Name should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ImportAddressDistrictFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an address district import file is to be processed by the Import Parcel Information process.",
            "nullable":true
        },
        "OptionalProcessSeven":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true
        },
        "MapParcelValue":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ImportAddressConditionFlag":{
            "title":"Address Condition",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an address condition import file is to be processed by the Import Parcel Information process.",
            "nullable":true
        },
        "MapAddressDistrict":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "OwnerCityFlag":{
            "title":"City",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute City should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "OwnerStateFlag":{
            "title":"State",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute State should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorParcelImportOptions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "DisableMissingAddressFlag":{
            "title":"Disable Addresses Not Found in Import File",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerNameFlag":{
            "title":"Owner Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Owner Name should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OwnerAddressFlag":{
            "title":"Address Line 1",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Address Line 1 should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ImportParcelFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a parcel import file is to be processed by the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "CityFlag":{
            "title":"City",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute City should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OptionalProcessFive":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionalProcessNine":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetTypeFlag":{
            "title":"Street Suffix",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Street Suffix should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DisableMissingDistrictFlag":{
            "title":"Delete District Assignments Not Found in Import File",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MapParcelAddress":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNumberFlag":{
            "title":"Street Number",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Street Number should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Address2Flag":{
            "title":"Address Line 2",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Address Line 2 should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ImportParcelAddressFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a parcel address import file is to be processed by the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OptionalProcessThree":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "PreviewMode":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MissingAddconFlag":{
            "title":"Resolve Address Conditions Not Found in Import File",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorFlag":{
            "title":"Floor",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Floor should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DisableMissingParcelOwnerFlag":{
            "title":"Disable Owners Not Found in Import File",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionalProcessFour":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerAddress2Flag":{
            "title":"Address Line 2",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Address Line 2 should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerPostalCodeFlag":{
            "title":"Postal Code",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Postal Code should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SecondaryOwnerNameFlag":{
            "title":"Secondary Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Secondary Owner should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ImportParcelDistrictFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a parcel district import file is to be processed by the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetDirectionFlag":{
            "title":"Direction Prefix",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Direction Prefix should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RetireMissingParcelFlag":{
            "title":"Retire Parcels Not Found in Import File",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetSuffixFlag":{
            "title":"Direction Suffix",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Direction Suffix should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ImportParcelConditionFlag":{
            "title":"Parcel Condition",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a parcel condition import file is to be processed by the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionalProcessSix":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionalProcessOne":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumberFlag":{
            "title":"Unit",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Unit should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OptionalProcessEight":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the options. Value is mandatory and is set programmatically.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "MissingParconFlag":{
            "title":"Resolve Parcel Conditions Not Found in Import File",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MapParcelOwner":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCodeFlag":{
            "title":"Postal Code",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Postal Code should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ImportParcelOwnerFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a parcel owner import file is to be processed by the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "MapParcel":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionalProcessTwo":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "ImportParcelValueFlag":{
            "title":"Value",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a parcel value import file is to be processed by the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "MapParcelDistrict":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "StateFlag":{
            "title":"State",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute State should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StreetNameFlag":{
            "title":"Street Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute Street Name should be part of the combination of address attributes used to identify a new address.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ImportAddressDistrictFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an address district import file is to be processed by the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionalProcessSeven":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "MapParcelValue":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ImportAddressConditionFlag":{
            "title":"Address Condition",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an address condition import file is to be processed by the Import Parcel Information process.",
            "nullable":true,
            "x-queryable":true
        },
        "MapAddressDistrict":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerCityFlag":{
            "title":"City",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute City should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OwnerStateFlag":{
            "title":"State",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute State should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top