Get all parcel import options
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcelImportOptions
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds parcel import options that match the specified primary key criteria.
Finder Variables:- AgencyId; integer; The unique identifier of the agency associated with the parcel import options.
- PrimaryKey: Finds parcel import options that match the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- Address2Flag; boolean; Indicates whether the attribute Address Line 2 should be part of the combination of address attributes used to identify a new address.
- AgencyId; integer; The unique identifier of the agency associated with the options. Value is mandatory and is set programmatically.
- CityFlag; boolean; Indicates whether the attribute City should be part of the combination of address attributes used to identify a new address.
- DisableMissingAddressFlag; boolean; 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; 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; 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; Indicates whether the attribute Floor should be part of the combination of address attributes used to identify a new address.
- ImportAddressConditionFlag; boolean; Indicates whether an address condition import file is to be processed by the Import Parcel Information process.
- ImportAddressDistrictFlag; boolean; Indicates whether an address district import file is to be processed by the Import Parcel Information process.
- ImportParcelAddressFlag; boolean; Indicates whether a parcel address import file is to be processed by the Import Parcel Information process.
- ImportParcelConditionFlag; boolean; Indicates whether a parcel condition import file is to be processed by the Import Parcel Information process.
- ImportParcelDistrictFlag; boolean; Indicates whether a parcel district import file is to be processed by the Import Parcel Information process.
- ImportParcelFlag; boolean; Indicates whether a parcel import file is to be processed by the Import Parcel Information process.
- ImportParcelOwnerFlag; boolean; Indicates whether a parcel owner import file is to be processed by the Import Parcel Information process.
- ImportParcelValueFlag; boolean; Indicates whether a parcel value import file is to be processed by the Import Parcel Information process.
- MapAddressDistrict; string; 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; 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; 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; 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; 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; 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; 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; 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; The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
- OptionalProcessFive; string; The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
- OptionalProcessFour; string; The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
- OptionalProcessNine; string; The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
- OptionalProcessOne; string; The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
- OptionalProcessSeven; string; The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
- OptionalProcessSix; string; The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
- OptionalProcessThree; string; The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
- OptionalProcessTwo; string; The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
- OwnerAddress2Flag; boolean; 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; 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; Indicates whether the attribute City should be part of the combination of parcel owner attributes used to identify a new parcel owner.
- OwnerNameFlag; boolean; 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; 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; Indicates whether the attribute State should be part of the combination of parcel owner attributes used to identify a new parcel owner.
- PostalCodeFlag; boolean; Indicates whether the attribute Postal Code should be part of the combination of address attributes used to identify a new address.
- PreviewMode; boolean; 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; 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; 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; Indicates whether the attribute State should be part of the combination of address attributes used to identify a new address.
- StreetDirectionFlag; boolean; Indicates whether the attribute Direction Prefix should be part of the combination of address attributes used to identify a new address.
- StreetNameFlag; boolean; Indicates whether the attribute Street Name should be part of the combination of address attributes used to identify a new address.
- StreetNumberFlag; boolean; Indicates whether the attribute Street Number should be part of the combination of address attributes used to identify a new address.
- StreetSuffixFlag; boolean; Indicates whether the attribute Direction Suffix should be part of the combination of address attributes used to identify a new address.
- StreetTypeFlag; boolean; Indicates whether the attribute Street Suffix should be part of the combination of address attributes used to identify a new address.
- UnitNumberFlag; boolean; Indicates whether the attribute Unit should be part of the combination of address attributes used to identify a new address.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.