Get all records with parcel address and business location details
get
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists
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:- ActiveBusLicSearchFinder: Finds the active business license application by the specified keyword, for public users.
Finder Variables:- value; string; The keyword used to find an active business license application by record ID, record type, status, person name, user who created the record, creation date, expiration date, fees due, total fees, the primary or secondary parcel address, or city.
- ActiveMasterBLListFinder: Find the active business license and contact access, for logged in users.
Finder Variables:- value; string; The keyword used to find an active master business license application by record ID, record type, status, person name, user who created the record, creation date, expiration date, fees due, total fees, the primary or secondary parcel address, or city.
- ActiveMasterBLListForShowAllFinder: Finds the active and closed business license and contact access, for logged in users.
Finder Variables:- value; string; The keyword used to find an active master business license application by record ID, record type, status, person name, user who created the record, creation date, expiration date, fees due, total fees, the primary or secondary parcel address, or city.
- PrimaryKey: Finds the record that matches the primary key criteria.
Finder Variables:- LnpRecordKey; integer; The unique identifier for a record. The record can be for a permit, business license, professional license, or planning and zoning, which is determined by the classification.
- PublicSearchFinder: Finds a record that matches the specified keyword, by public users.
Finder Variables:- value; string; The keyword used to find a record by record ID, record type, record status, creation date, expiration date, fees due, total fees, primary or secondary parcel address, or city.
- PublicUserActiveSearchFinder: Finds the active records that match the specified keyword, by public users.
Finder Variables:- value; string; The keyword used to find an active permit application by record ID, record type, status, person name, user who created the record, creation date, expiration date, fees due, total fees, the primary or secondary parcel address, or city.
- RecordListSearchFinder: Finds a record that matches the specified keyword.
Finder Variables:- value; string; The keyword used to find a record by record ID, record type, status, description, person name, user who created the record, or up to four parcel addresses.
- ActiveBusLicSearchFinder: Finds the active business license application by the specified keyword, for public users.
-
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:- AboutToExpireDate; string; The date that is calculated based on the number of days remaining for the record to expire.
- ActivityExpirationDate; string; The date when the business license application expires.
- Applicant; integer; The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.
- BlBusDbaBusinessName; string; The doing business as name for the business from business location.
- BusAddress1; string; The address line 1 of the business' address.
- BusAddress2; string; The address line 2 of the business??? address.
- BusAddress3; string; The address line 3 of the business??? address.
- BusAddress4; string; The address line 4 of the business??? address.
- BusAddressId; integer; The reference key to the TCA location table.
- BusBusinessLegalName; string; The legal name of the business entity.
- BusBusinessName; string; The name of the applicant's business. For example, a contractor enters his or her contracting business name.
- BusCity; string; The city portion of the business??? address.
- BusCountry; string; The country to which the business belongs.
- BusCounty; string; The county portion of the business??? address.
- BusDbaBusinessName; string; The Doing Business As name for the business.
- BusDescription; string; The description of the business.
- BusEnabledFlag; string; Indicates if the business entity is enabled.
- BusExemptFlag; string; The ownership type of the business. Examples are corporation, sole proprietorship, and partnership.
- BusExemptType; string; The tax exemption type for the business.
- BusOwnershipType; string; Indicates if the business is tax exempt.
- BusPostalCode; string; The postal code portion of the business??? address.
- BusPostalPlus4Code; string; The postal4 code portion of the business??? address.
- BusProvince; string; The province portion of the business??? address.
- BusStartDate; string; A field in the business information component of the form designer used to enter the date when the business was established.
- BusState; string; The state portion of the business??? address.
- BusStatus; string; The current status of the business entity.
- BusinessEntityId; string; A meaningful identifier for the business entity.
- BusinessEntityKey; integer; The unique identifier for the business entity.
- Classification; string; The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
- CreationDate; string; The date when the record was created.
- CurrencyCode; string; The currency code used for applying payments.
- CurrentLicenseStatus; string; The license status of an issued business license.
- CurrentTransFlag; string; Indicates that the selected row is the current transaction.
- Description; string; The record description.
- EmailAddress1; string; The applicant email address.
- ExpirationDate; string; The date when the record expires.
- InsCommenceAteDate; string; Indicates the date that the inspection commencement will be about to expire.
- InsCommenceExpDate; string; Indicates the date on which the inspection commencement will expire.
- InsCommencementDateOption; string; Indicates the inspection commencement date options.
- InsScheduledDate; string; Indicates inspection scheduled date.
- IssueDate; string; The date when the application was issued.
- LastUpdateDate; string; The date when the record was last updated.
- LayoutVersion; string; The layout version.
- LicenseAboutToExpireDate; string; The date when an issued business license is about to expire.
- LicenseExpirationDate; string; The date when an issued business license expires.
- LicenseFinancialStatus; string; The overall financial status for the business.
- LicensePeriod; string; The period that applies to the transaction.
- LicenseStatus; string; The overall status for the business.
- LnpRecordId; string; The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
- LnpRecordKey; integer; The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
- OriginalIssueDate; string; The date the business license was originally issued.
- ParcelAddressAddress1; string; Indicates the first address line in the address of the application's primary parcel.
- ParcelAddressAddress2; string; Indicates the second address line in the address of the application's primary parcel.
- ParcelAddressCity; string; Indicates the city in the address of the application's primary parcel.
- ParcelAddressLatitude; number; The latitude in the address of the application's primary parcel.
- ParcelAddressLongitude; number; The longitude in the address of the application's primary parcel.
- ParcelAddressPostalCode; string; Indicates the postal code in the address of the application's primary parcel.
- ParcelAddressState; string; Indicates the state in the address of the application's primary parcel.
- ParcelAddressStreetNameConcat; string; Indicates the concatenated value of the street name corresponding to the address of the application's primary parcel. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix and direction suffix.
- ParcelAddressStreetNumber; string; Indicates the street number in the address of the application's primary parcel.
- ParcelAddressStreetNumberAlpha; string; Indicates the alphabetic portion of the street number in the address of the application's primary parcel.
- ParcelAddressStreetNumberNumeric; integer; Indicates the numerical portion of the street number in the address of the application's primary parcel.
- PaymentInProcess; number; The total fees where the payment is in process.
- PersonName; string; The name of the person who completed the application process.
- PhoneNumber; string; The applicant telephone number.
- PrimaryContact; string; The primary contact of this record.
- PrimaryFlag; string; Indicates whether the record is primary.
- PrimaryMeaning; string; Calculated field to show primary meaning from the fnd lookup table.
- PrimaryRecordId; string; Used to store the parent record ID for a sub-record.
- PrimaryRecordKey; integer; Used to store the primary record key for a sub-record.
- ProjectKey; integer; The project to which this record belongs.
- ReceivedDate; string; The date on which the transaction was received.
- RecordType; string; The user-friendly name for the record type.
- RecordTypeCode; string; The unique alphanumeric code or short name for the record type.
- RecordTypeId; string; The unique identifier for a record type.
- Status; string; The identifier of the record status.
- SubClassDesc; string; The description for Subclassification.
- SubapplicationFlag; string; Indicates whether the record is a sub application.
- SubapplicationMeaning; string; Calculated field to show primary meaning from the fnd lookup table.
- Subclassification; string; The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process.
- SubmitDate; string; The date when the record was submitted.
- SystemStatus; string; The predefined system status to which the record status maps.
- Total; number; The total amount of fees for this record.
- TotalDue; number; The amount of fees that are currently due for this record.
- VersionType; string; The version of the permit. Values are original, amendment, and renewal.
- VersionTypeDesc; string; Indicates the description for the version type.
-
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:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorApplicationLists
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 : publicSectorApplicationLists-item-response
Type:
Show Source
object
-
AboutToExpireDate: string
(date-time)
Title:
About to Expire
Read Only:true
The date that is calculated based on the number of days remaining for the record to expire. -
ActivityExpirationDate: string
(date-time)
Title:
Activity Expiration Date
Read Only:true
The date when the business license application expires. -
Applicant: integer
(int64)
Title:
Applicant
Read Only:true
The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit. -
BlBusDbaBusinessName: string
Read Only:
true
Maximum Length:100
The doing business as name for the business from business location. -
BusAddress1: string
Read Only:
true
Maximum Length:240
The address line 1 of the business' address. -
BusAddress2: string
Read Only:
true
Maximum Length:240
The address line 2 of the business??? address. -
BusAddress3: string
Read Only:
true
Maximum Length:240
The address line 3 of the business??? address. -
BusAddress4: string
Read Only:
true
Maximum Length:240
The address line 4 of the business??? address. -
BusAddressId: integer
(int64)
Read Only:
true
The reference key to the TCA location table. -
BusBusinessLegalName: string
Read Only:
true
Maximum Length:240
The legal name of the business entity. -
BusBusinessName: string
Read Only:
true
Maximum Length:100
The name of the applicant's business. For example, a contractor enters his or her contracting business name. -
BusCity: string
Read Only:
true
Maximum Length:60
The city portion of the business??? address. -
BusCountry: string
Read Only:
true
Maximum Length:3
The country to which the business belongs. -
BusCounty: string
Read Only:
true
Maximum Length:60
The county portion of the business??? address. -
BusDbaBusinessName: string
Read Only:
true
Maximum Length:100
The Doing Business As name for the business. -
BusDescription: string
Read Only:
true
Maximum Length:200
The description of the business. -
BusEnabledFlag: string
Read Only:
true
Maximum Length:1
Indicates if the business entity is enabled. -
BusExemptFlag: string
Read Only:
true
Maximum Length:1
The ownership type of the business. Examples are corporation, sole proprietorship, and partnership. -
BusExemptType: string
Read Only:
true
Maximum Length:30
The tax exemption type for the business. -
BusinessEntityId: string
Read Only:
true
Maximum Length:50
A meaningful identifier for the business entity. -
BusinessEntityKey: integer
(int64)
Read Only:
true
The unique identifier for the business entity. -
BusinessLocation: array
Business Locations
Title:
Business Locations
The business location resource is used to view the business locations that are associated with the business license application. -
BusOwnershipType: string
Read Only:
true
Maximum Length:15
Indicates if the business is tax exempt. -
BusPostalCode: string
Read Only:
true
Maximum Length:60
The postal code portion of the business??? address. -
BusPostalPlus4Code: string
Read Only:
true
Maximum Length:10
The postal4 code portion of the business??? address. -
BusProvince: string
Read Only:
true
Maximum Length:60
The province portion of the business??? address. -
BusStartDate: string
(date)
Read Only:
true
A field in the business information component of the form designer used to enter the date when the business was established. -
BusState: string
Read Only:
true
Maximum Length:60
The state portion of the business??? address. -
BusStatus: string
Read Only:
true
Maximum Length:10
The current status of the business entity. -
Classification: string
Title:
Classification
Read Only:true
Maximum Length:3
The record classification. The classifications can be permit, business license, professional license, or planning and zoning. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:3
The currency code used for applying payments. -
CurrentLicenseStatus: string
Read Only:
true
Maximum Length:30
The license status of an issued business license. -
CurrentTransFlag: string
Read Only:
true
Maximum Length:1
Indicates that the selected row is the current transaction. -
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
The record description. -
EmailAddress1: string
Title:
Email
Read Only:true
Maximum Length:320
The applicant email address. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Read Only:true
The date when the record expires. -
InsCommenceAteDate: string
(date-time)
Read Only:
true
Indicates the date that the inspection commencement will be about to expire. -
InsCommenceExpDate: string
(date-time)
Read Only:
true
Indicates the date on which the inspection commencement will expire. -
InsCommencementDateOption: string
Read Only:
true
Maximum Length:30
Indicates the inspection commencement date options. -
InsScheduledDate: string
(date-time)
Read Only:
true
Indicates inspection scheduled date. -
IssueDate: string
(date-time)
Title:
Issue Date
Read Only:true
The date when the application was issued. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LayoutVersion: string
Read Only:
true
Maximum Length:30
The layout version. -
LicenseAboutToExpireDate: string
(date-time)
Read Only:
true
The date when an issued business license is about to expire. -
LicenseExpirationDate: string
(date-time)
Title:
License Expiration Date
Read Only:true
The date when an issued business license expires. -
LicenseFinancialStatus: string
Read Only:
true
Maximum Length:30
The overall financial status for the business. -
LicensePeriod: string
Read Only:
true
Maximum Length:100
The period that applies to the transaction. -
LicenseStatus: string
Read Only:
true
Maximum Length:30
The overall status for the business. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Permit
Read Only:true
Maximum Length:50
The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey: integer
(int64)
Title:
Record
Read Only:true
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification. -
OriginalIssueDate: string
(date-time)
Read Only:
true
The date the business license was originally issued. -
ParcelAddress: array
Parcel Addresses
Title:
Parcel Addresses
The parcel address resource is used to view the parcel addresses. -
ParcelAddressAddress1: string
Title:
Address Line 1
Read Only:true
Maximum Length:240
Indicates the first address line in the address of the application's primary parcel. -
ParcelAddressAddress2: string
Title:
Address Line 2
Read Only:true
Maximum Length:240
Indicates the second address line in the address of the application's primary parcel. -
ParcelAddressCity: string
Title:
City
Read Only:true
Maximum Length:60
Indicates the city in the address of the application's primary parcel. -
ParcelAddressLatitude: number
Title:
Latitude
Read Only:true
The latitude in the address of the application's primary parcel. -
ParcelAddressLongitude: number
Title:
Longitude
Read Only:true
The longitude in the address of the application's primary parcel. -
ParcelAddressPostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
Indicates the postal code in the address of the application's primary parcel. -
ParcelAddressState: string
Title:
State
Read Only:true
Maximum Length:60
Indicates the state in the address of the application's primary parcel. -
ParcelAddressStreetNameConcat: string
Title:
Street
Read Only:true
Maximum Length:350
Indicates the concatenated value of the street name corresponding to the address of the application's primary parcel. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix and direction suffix. -
ParcelAddressStreetNumber: string
Title:
Street Number
Read Only:true
Maximum Length:20
Indicates the street number in the address of the application's primary parcel. -
ParcelAddressStreetNumberAlpha: string
Read Only:
true
Maximum Length:20
Indicates the alphabetic portion of the street number in the address of the application's primary parcel. -
ParcelAddressStreetNumberNumeric: integer
(int64)
Read Only:
true
Indicates the numerical portion of the street number in the address of the application's primary parcel. -
PaymentInProcess: number
Title:
Payment in Process
Read Only:true
The total fees where the payment is in process. -
PersonName: string
Title:
Name
Read Only:true
Maximum Length:450
The name of the person who completed the application process. -
PhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:40
The applicant telephone number. -
PrimaryContact: string
Read Only:
true
Maximum Length:450
The primary contact of this record. -
PrimaryFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the record is primary. -
PrimaryMeaning: string
Read Only:
true
Maximum Length:50
Calculated field to show primary meaning from the fnd lookup table. -
PrimaryRecordId: string
Read Only:
true
Maximum Length:50
Used to store the parent record ID for a sub-record. -
PrimaryRecordKey: integer
(int64)
Read Only:
true
Used to store the primary record key for a sub-record. -
ProjectKey: integer
(int64)
Title:
Project
Read Only:true
The project to which this record belongs. -
ReceivedDate: string
(date-time)
Read Only:
true
The date on which the transaction was received. -
RecordType: string
Title:
Permit Type
Read Only:true
Maximum Length:100
The user-friendly name for the record type. -
RecordTypeCode: string
Title:
Record Type Code
Read Only:true
Maximum Length:20
The unique alphanumeric code or short name for the record type. -
RecordTypeId: string
Title:
Record Type ID
Read Only:true
Maximum Length:30
The unique identifier for a record type. -
Status: string
Title:
Status
Read Only:true
Maximum Length:15
The identifier of the record status. -
SubapplicationFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the record is a sub application. -
SubapplicationMeaning: string
Read Only:
true
Maximum Length:50
Calculated field to show primary meaning from the fnd lookup table. -
SubClassDesc: string
Read Only:
true
Maximum Length:80
The description for Subclassification. -
Subclassification: string
Read Only:
true
Maximum Length:10
The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process. -
SubmitDate: string
(date-time)
Title:
Submission Date
Read Only:true
The date when the record was submitted. -
SystemStatus: string
Title:
System Status
Read Only:true
Maximum Length:15
The predefined system status to which the record status maps. -
Total: number
Title:
Total Fees
Read Only:true
The total amount of fees for this record. -
TotalDue: number
Title:
Total Due
Read Only:true
The amount of fees that are currently due for this record. -
VersionType: string
Read Only:
true
Maximum Length:1
The version of the permit. Values are original, amendment, and renewal. -
VersionTypeDesc: string
Read Only:
true
Maximum Length:80
Indicates the description for the version type.
Nested Schema : Business Locations
Type:
array
Title:
Business Locations
The business location resource is used to view the business locations that are associated with the business license application.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Parcel Addresses
Type:
array
Title:
Parcel Addresses
The parcel address resource is used to view the parcel addresses.
Show Source
Nested Schema : publicSectorApplicationLists-BusinessLocation-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address 1
Maximum Length:240
The address Line 1 that is part of the parcel address. -
Address2: string
Title:
Address 2
Maximum Length:240
The address Line 2 that is part of the parcel address. -
Address3: string
Title:
Address 3
Maximum Length:240
The address Line 3 that is part of the parcel address. -
Address4: string
Title:
Address 4
Maximum Length:240
The address Line 4 that is part of the parcel address. -
AddressCode: string
Maximum Length:
32
The unique identifier for the parcel address. -
AddressId: integer
(int64)
The system generated sequence key for the parcel address.
-
AddressType: string
Maximum Length:
20
The attribute used for address point validation. Possible values might be main address, virtual address, shipping gate address, or others. -
AgencyId: integer
(int32)
Default Value:
1
The identifier of the agency. -
AltPhoneAreaCode: string
Maximum Length:
10
The phone area code within a country. -
AltPhoneCountryCode: string
Maximum Length:
10
The international country code for a telephone number. -
AltPhoneExtension: string
Maximum Length:
20
The additional extension number after initial connection to an internal telephone system. -
AltPhoneNumber: string
Maximum Length:
40
The phone number of the location. -
AltPhoneType: string
Title:
Alternate Phone Type
Maximum Length:30
The type of phone for the location. -
AltRawPhoneNumber: string
Maximum Length:
60
The location???s full phone number. -
BuildingType: string
Maximum Length:
20
The building type used for parcel address searches. -
BusCategory: string
Title:
Category
Maximum Length:50
Indicates the type of business category. -
BusDbaBusinessName: string
Title:
Doing Business As
Maximum Length:100
The Doing Business As name for the business. -
BusDescription: string
Title:
Business Description
Maximum Length:200
The description of the business. -
BusinessEntityId: string
Title:
Business ID
Maximum Length:50
A meaningful identifier for the business entity. -
BusinessEntityKey: integer
(int64)
The unique identifier for the business entity.
-
BusinessLocationId: string
Maximum Length:
50
A meaningful identifier for the business location. -
BusinessLocationKey: integer
(int64)
The unique identifier for the business location.
-
BusinessLocationPartyId: integer
(int64)
The unique identifier for the business location???s TCA party.
-
BusStateTaxId: string
Title:
State Tax ID
Maximum Length:20
The business??? state tax identifier. -
BusSubCategory: string
Title:
Subcategory
Maximum Length:50
Indicates the type of business sub category. -
City: string
Title:
City
Maximum Length:60
The city that is part of the parcel address. -
CityTaxId: string
Title:
City Tax ID
Maximum Length:20
The business??? city tax identifier. -
CoordinateX: number
The geographic x coordinate of the parcel address location.
-
CoordinateY: number
The geographic y coordinate of the parcel address location.
-
Country: string
Title:
Country
Maximum Length:3
The country that is part of the parcel address. -
County: string
Title:
County
Maximum Length:60
The county in which the parcel address is located. -
CrossroadOne: string
Maximum Length:
240
The cross road 1 that is part of parcel address. -
CrossroadTwo: string
Maximum Length:
240
The cross road 2 that is part of parcel address. -
EcontactAvailabilityOne: string
Title:
Availability
Maximum Length:1000
The availability of the emergency contact. -
EcontactAvailabilityTwo: string
Title:
Availability
Maximum Length:1000
The availability of the emergency contact. -
EcontactEmailOne: string
Title:
Email
Maximum Length:320
The email of the emergency contact. -
EcontactEmailTwo: string
Title:
Email
Maximum Length:320
The email of the emergency contact. -
EcontactFirstNameOne: string
Title:
Contact 1 First Name
Maximum Length:150
The first name of the emergency contact. -
EcontactFirstNameTwo: string
Title:
Contact 2 First Name
Maximum Length:150
The first name of the emergency contact. -
EcontactLastNameOne: string
Title:
Contact 1 Last Name
Maximum Length:150
The last name of the emergency contact. -
EcontactLastNameTwo: string
Title:
Contact 2 Last Name
Maximum Length:150
The last name of the emergency contact. -
EcontactPhoneAreaCodeOne: string
Maximum Length:
10
The phone area code within a country. -
EcontactPhoneAreaCodeTwo: string
Maximum Length:
10
The phone area code within a country. -
EcontactPhoneCountryOne: string
Maximum Length:
10
The international country code for a telephone number. -
EcontactPhoneCountryTwo: string
Maximum Length:
10
The international country code for a telephone number. -
EcontactPhoneExtensionOne: string
Maximum Length:
20
The additional extension number after initial connection to an internal telephone system. -
EcontactPhoneExtensionTwo: string
Maximum Length:
20
The additional extension number after initial connection to an internal telephone system. -
EcontactPhoneNumberOne: string
Maximum Length:
40
The first phone number of the emergency contact. -
EcontactPhoneNumberTwo: string
Maximum Length:
40
The second phone number of the emergency contact. -
EcontactPhoneTypeOne: string
Title:
Phone Type
Maximum Length:30
The phone type of the emergency contact. -
EcontactPhoneTypeTwo: string
Title:
Phone Type
Maximum Length:30
The phone type of the emergency contact. -
EcontactRawPhoneNumberOne: string
Maximum Length:
60
The first phone number of the emergency contact. -
EcontactRawPhoneNumberTwo: string
Maximum Length:
60
The second phone number of the emergency contact. -
EmailAddress: string
Title:
Email
Maximum Length:320
The business location???s email address. -
EmployeesTotal: integer
(int64)
Indicates the total number of employees in that business location.
-
EnabledFlag: string
Maximum Length:
1
Indicates if the business location is enabled. -
EndDate: string
(date)
The end date of the business location.
-
Floor: string
Maximum Length:
20
The floor number used for parcel address searches. -
InactiveReason: string
Maximum Length:
1000
The reason why the business location was changed to inactive. -
Landmark: string
Maximum Length:
200
The landmark for the parcel address. -
Latitude: number
The geographical latitude location of the parcel address.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpBusinessLocationKey: integer
(int64)
The unique identifier for the transaction business location.
-
LnpBusinessLocationPuid: string
Maximum Length:
480
The unique identifier of the migrated business location record. -
LnpRecordId: string
Maximum Length:
50
A meaningful identifier for the transaction. -
LnpRecordKey: integer
(int64)
The unique identifier for the transaction.
-
LocationType: string
Title:
Location Type
Maximum Length:30
The location type. -
Longitude: number
The geographical longitude location of the parcel address.
-
MailingAddress1: string
Maximum Length:
240
The address line 1 of the location???s address. -
MailingAddress2: string
Maximum Length:
240
The address line 2 of the location???s address. -
MailingAddress3: string
Maximum Length:
240
The address line 3 of the location???s address. -
MailingAddress4: string
Maximum Length:
240
The address line 4 of the location???s address. -
MailingCity: string
Maximum Length:
60
The city portion of the location???s address. -
MailingCountry: string
Maximum Length:
3
The address portion of the location???s address. -
MailingCounty: string
Maximum Length:
60
The county portion of the location???s address. -
MailingPostalCode: string
Maximum Length:
60
The postal code portion of the location???s address. -
MailingPostalPlusFourCode: string
Maximum Length:
10
The postal4 code portion of the location???s address. -
MailingProvince: string
Maximum Length:
60
The province portion of the location???s address. -
MailingState: string
Maximum Length:
60
The state portion of the location???s address. -
MobileBusFlag: boolean
Title:
Is this a mobile business?
Maximum Length:1
Default Value:false
Indicates if the business provides a mobile product or service. -
MunicipalityId: string
Maximum Length:
20
The municipality in which the parcel address is located. -
OtherTaxId: string
Title:
County Tax ID
Maximum Length:20
Identifier for the business??? other tax. -
ParcelId: integer
(int64)
Title:
Parcel
The system generated key from the parcel parent. -
ParcelIdEntered: string
Title:
Parcel Number
Maximum Length:30
The identifier given by the user for the parcel of real estate. In the USA, this is the Assessor Parcel Number. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code that is part of the parcel address. -
PostalPlus4Code: string
Maximum Length:
10
For US addresses, the full postal code is often quoted as a 5 digit number, followed by a 4 digit number. This column represents the second number having 4 digits. -
PrimaryPhoneAreaCode: string
Maximum Length:
10
The phone area code within a country. -
PrimaryPhoneCountryCode: string
Maximum Length:
10
The international country code for a telephone number. -
PrimaryPhoneExtension: string
Maximum Length:
20
The additional extension number after initial connection to an internal telephone system. -
PrimaryPhoneNumber: string
Maximum Length:
40
The phone number of the location. -
PrimaryPhoneType: string
Title:
Primary Phone Type
Maximum Length:30
The type of phone for the location. -
PrimaryRawPhoneNumber: string
Maximum Length:
60
The location???s full phone number. -
Province: string
Title:
Province
Maximum Length:60
The location information about the province in which the parcel address is located. -
RecordNumber: string
Maximum Length:
64
The record number of the business location. -
SameMailAddressFlag: boolean
Title:
Is the mailing and billing address the same as the physical location?
Maximum Length:1
Default Value:false
Indicates that the mailing address is the same as the primary address. -
StartDate: string
(date)
Title:
Proposed Start Date
The start date of the business location. -
State: string
Title:
State
Maximum Length:60
The state that is part of the parcel address. -
Status: string
Maximum Length:
10
The current status of the business location. -
StQualPerNum: string
Title:
State Equalization Board Number
Maximum Length:30
The state equalization board number for business. -
StreetDirection: string
Maximum Length:
10
The street direction used for parcel address searches. -
StreetName: string
Maximum Length:
240
The street name used for parcel address searches. -
StreetNumber: string
Maximum Length:
20
The street number used for parcel address searches. -
StreetSuffix: string
Maximum Length:
20
The street name that describes the street. -
StreetType: string
Maximum Length:
20
The street type used for parcel address searches. -
SubjectId: string
Maximum Length:
30
The attribute used to identify where the data should be displayed. -
TaxClass: string
Title:
Municipal Tax Class
Maximum Length:30
The municipal tax class for the business. -
UnitNumber: string
Maximum Length:
30
The apartment unit number used for parcel address searches. -
Website: string
Title:
Website
Maximum Length:1000
The business??? primary website address. -
WithinJurisdictionFlag: boolean
Title:
Is this business physically located within the agency's jurisdiction?
Maximum Length:1
Default Value:true
Indicates if the location is within the agency???s jurisdiction.
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.
Nested Schema : publicSectorApplicationLists-ParcelAddress-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address Line 1
Maximum Length:240
The first or main address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address, if present. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address, if present. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address, if present. -
AddressId: integer
(int64)
Title:
Address
The identifier of the parcel address. -
AddressKey: integer
(int64)
Title:
Address Key
The unique identifier of the parcel address. -
AddressType: string
Title:
Address Type
Maximum Length:20
The address type used for delivery point validation (DPV). For example, main address, side address, or virtual address. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the agency. -
BuildingType: string
Title:
Building
Maximum Length:20
The type of building used in an address search. For example, Tower A or Block 3. -
CellPhoneCountry: string
Title:
Cell Phone Country
Maximum Length:10
The country code for the cell phone number of parcel contact. -
CellPhoneNumber: string
Title:
Cell Phone
Maximum Length:40
The cell phone number of the parcel address contact. -
City: string
Title:
City
Maximum Length:60
The city in the parcel address. -
CoordinateX: number
Title:
Coordinate X
The x-axis coordinate of the record parcel address. -
CoordinateY: number
Title:
Coordinate Y
The y-axis coordinate of the record parcel address. -
Country: string
Title:
Country
Maximum Length:60
The country in the parcel address. -
County: string
Title:
County
Maximum Length:60
The country in the parcel address. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the parcel address was created. -
CrossroadOne: string
Maximum Length:
240
The first cross road of the intersection. -
CrossroadTwo: string
Maximum Length:
240
The second cross road of the intersection. -
EmailId: string
Title:
Email
Maximum Length:50
The email address of the parcel address contact. -
FaxCountry: string
Title:
Fax Country
Maximum Length:10
The country code for the fax number of the parcel contact. -
FaxNumber: string
Title:
Fax
Maximum Length:40
The fax number of the parcel address contact. -
Floor: string
Title:
Floor
Maximum Length:20
The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C. -
HomePhoneCountry: string
Title:
Home Phone Country
Maximum Length:10
The country code for the home telephone number of the parcel address contact. -
HomePhoneNumber: string
Title:
Home Phone
Maximum Length:40
The home telephone number of the parcel address contact. -
InputSource: string
Title:
Source
Maximum Length:1
Indicates how the data was entered or loaded into the application. The values are S for system data and U for user-entered data. -
Landmark: string
Maximum Length:
200
The landmark associated with the address. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the parcel address was last updated. -
Latitude: number
Title:
Latitude
The latitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
A logical identifier for the application record. -
LnpRecordKey: integer
(int64)
Title:
Record
The unique identifier of the record associated with the parcel address. -
Longitude: number
Title:
Longitude
The longitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance. -
MunicipalityId: string
Title:
Municipality
Maximum Length:20
The municipality identifier if the parcel is not managed at the county level. -
ParcelId: integer
(int64)
Title:
Parcel
The identifier of the record parcel. -
ParcelKey: integer
(int64)
Title:
Parcel Key
The unique identifier of the parcel associated with a parcel address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code in the parcel address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
An extended postal code in the parcel address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates the primary parcel address. If the value is Y, then the parcel address is the primary parcel address. The default value is N. -
PrimaryTransAddress: boolean
Title:
Primary Transaction Address
Maximum Length:1
Indicates the primary address for the transaction. If the value is 'Y' then the address is the primary transaction address. The default value is N. -
Province: string
Title:
Province
Maximum Length:60
The province in the parcel address. -
Srid: integer
(int64)
Title:
SRID
The SRID of the parcel address. This attribute indicates the Spatial Reference System Identifier (SRID), which is a unique value that identifies projected, unprojected, and local spatial coordinate system definitions. Used in all GIS systems. -
State: string
Title:
State
Maximum Length:60
The state in the parcel address. -
StreetDirection: string
Title:
Direction
Maximum Length:10
The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center. -
StreetName: string
Title:
Street
Maximum Length:240
The street name in the parcel address used during a search. -
StreetNameConcat: string
Maximum Length:
350
The concatenated value of the street name corresponding to the parcel address. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix and direction suffix. -
StreetNumber: string
Title:
Street Number
Maximum Length:20
The street number in the parcel address. -
StreetSuffix: string
Maximum Length:
20
The street suffix that further describes that street like Drive, Avenue, and others. -
StreetType: string
Title:
Street Type
Maximum Length:20
The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
UnitNumber: string
Title:
Unit
Maximum Length:30
The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300. -
WorkPhoneCountry: string
Title:
Work Phone Country
Maximum Length:10
The country code for the work telephone number of the parcel contact. -
WorkPhoneNumber: string
Title:
Work Phone
Maximum Length:40
The work telephone number of the parcel address contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source