Create a set of business locations for the associated application
post
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/BusinessLocation
Request
Path Parameters
-
LnpRecordKey(required): integer(int64)
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.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
Address1: string
Title:
Address 1Maximum Length:240The address Line 1 that is part of the parcel address. -
Address2: string
Title:
Address 2Maximum Length:240The address Line 2 that is part of the parcel address. -
Address3: string
Title:
Address 3Maximum Length:240The address Line 3 that is part of the parcel address. -
Address4: string
Title:
Address 4Maximum Length:240The address Line 4 that is part of the parcel address. -
AddressCode: string
Maximum Length:
32The unique identifier for the parcel address. -
AddressId: integer
(int64)
The system generated sequence key for the parcel address.
-
AddressType: string
Maximum Length:
20The attribute used for address point validation. Possible values might be main address, virtual address, shipping gate address, or others. -
AgencyId: integer
(int32)
Default Value:
1The identifier of the agency. -
AltPhoneAreaCode: string
Maximum Length:
10The phone area code within a country. -
AltPhoneCountryCode: string
Maximum Length:
10The international country code for a telephone number. -
AltPhoneExtension: string
Maximum Length:
20The additional extension number after initial connection to an internal telephone system. -
AltPhoneNumber: string
Maximum Length:
40The phone number of the location. -
AltPhoneType: string
Title:
Alternate Phone TypeMaximum Length:30The type of phone for the location. -
AltRawPhoneNumber: string
Maximum Length:
60The location???s full phone number. -
BuildingType: string
Maximum Length:
20The building type used for parcel address searches. -
BusCategory: string
Title:
CategoryMaximum Length:50Indicates the type of business category. -
BusDbaBusinessName: string
Title:
Doing Business AsMaximum Length:100The Doing Business As name for the business. -
BusDescription: string
Title:
Business DescriptionMaximum Length:200The description of the business. -
BusinessEntityId: string
Title:
Business IDMaximum Length:50A meaningful identifier for the business entity. -
BusinessEntityKey: integer
(int64)
The unique identifier for the business entity.
-
BusinessLocationId: string
Maximum Length:
50A 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 IDMaximum Length:20The business??? state tax identifier. -
BusSubCategory: string
Title:
SubcategoryMaximum Length:50Indicates the type of business sub category. -
City: string
Title:
CityMaximum Length:60The city that is part of the parcel address. -
CityTaxId: string
Title:
City Tax IDMaximum Length:20The 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:
CountryMaximum Length:3The country that is part of the parcel address. -
County: string
Title:
CountyMaximum Length:60The county in which the parcel address is located. -
CrossroadOne: string
Maximum Length:
240The cross road 1 that is part of parcel address. -
CrossroadTwo: string
Maximum Length:
240The cross road 2 that is part of parcel address. -
EcontactAvailabilityOne: string
Title:
AvailabilityMaximum Length:1000The availability of the emergency contact. -
EcontactAvailabilityTwo: string
Title:
AvailabilityMaximum Length:1000The availability of the emergency contact. -
EcontactEmailOne: string
Title:
EmailMaximum Length:320The email of the emergency contact. -
EcontactEmailTwo: string
Title:
EmailMaximum Length:320The email of the emergency contact. -
EcontactFirstNameOne: string
Title:
Contact 1 First NameMaximum Length:150The first name of the emergency contact. -
EcontactFirstNameTwo: string
Title:
Contact 2 First NameMaximum Length:150The first name of the emergency contact. -
EcontactLastNameOne: string
Title:
Contact 1 Last NameMaximum Length:150The last name of the emergency contact. -
EcontactLastNameTwo: string
Title:
Contact 2 Last NameMaximum Length:150The last name of the emergency contact. -
EcontactPhoneAreaCodeOne: string
Maximum Length:
10The phone area code within a country. -
EcontactPhoneAreaCodeTwo: string
Maximum Length:
10The phone area code within a country. -
EcontactPhoneCountryOne: string
Maximum Length:
10The international country code for a telephone number. -
EcontactPhoneCountryTwo: string
Maximum Length:
10The international country code for a telephone number. -
EcontactPhoneExtensionOne: string
Maximum Length:
20The additional extension number after initial connection to an internal telephone system. -
EcontactPhoneExtensionTwo: string
Maximum Length:
20The additional extension number after initial connection to an internal telephone system. -
EcontactPhoneNumberOne: string
Maximum Length:
40The first phone number of the emergency contact. -
EcontactPhoneNumberTwo: string
Maximum Length:
40The second phone number of the emergency contact. -
EcontactPhoneTypeOne: string
Title:
Phone TypeMaximum Length:30The phone type of the emergency contact. -
EcontactPhoneTypeTwo: string
Title:
Phone TypeMaximum Length:30The phone type of the emergency contact. -
EcontactRawPhoneNumberOne: string
Maximum Length:
60The first phone number of the emergency contact. -
EcontactRawPhoneNumberTwo: string
Maximum Length:
60The second phone number of the emergency contact. -
EmailAddress: string
Title:
EmailMaximum Length:320The business location???s email address. -
EmployeesTotal: integer
(int64)
Indicates the total number of employees in that business location.
-
EnabledFlag: string
Maximum Length:
1Indicates if the business location is enabled. -
EndDate: string
(date)
The end date of the business location.
-
Floor: string
Maximum Length:
20The floor number used for parcel address searches. -
InactiveReason: string
Maximum Length:
1000The reason why the business location was changed to inactive. -
Landmark: string
Maximum Length:
200The landmark for the parcel address. -
Latitude: number
The geographical latitude location of the parcel address.
-
LnpBusinessLocationKey: integer
(int64)
The unique identifier for the transaction business location.
-
LnpBusinessLocationPuid: string
Maximum Length:
480The unique identifier of the migrated business location record. -
LnpRecordId: string
Maximum Length:
50A meaningful identifier for the transaction. -
LnpRecordKey: integer
(int64)
The unique identifier for the transaction.
-
LocationType: string
Title:
Location TypeMaximum Length:30The location type. -
Longitude: number
The geographical longitude location of the parcel address.
-
MailingAddress1: string
Maximum Length:
240The address line 1 of the location???s address. -
MailingAddress2: string
Maximum Length:
240The address line 2 of the location???s address. -
MailingAddress3: string
Maximum Length:
240The address line 3 of the location???s address. -
MailingAddress4: string
Maximum Length:
240The address line 4 of the location???s address. -
MailingCity: string
Maximum Length:
60The city portion of the location???s address. -
MailingCountry: string
Maximum Length:
3The address portion of the location???s address. -
MailingCounty: string
Maximum Length:
60The county portion of the location???s address. -
MailingPostalCode: string
Maximum Length:
60The postal code portion of the location???s address. -
MailingPostalPlusFourCode: string
Maximum Length:
10The postal4 code portion of the location???s address. -
MailingProvince: string
Maximum Length:
60The province portion of the location???s address. -
MailingState: string
Maximum Length:
60The state portion of the location???s address. -
MobileBusFlag: boolean
Title:
Is this a mobile business?Maximum Length:1Default Value:falseIndicates if the business provides a mobile product or service. -
MunicipalityId: string
Maximum Length:
20The municipality in which the parcel address is located. -
OtherTaxId: string
Title:
County Tax IDMaximum Length:20Identifier for the business??? other tax. -
ParcelId: integer
(int64)
Title:
ParcelThe system generated key from the parcel parent. -
ParcelIdEntered: string
Title:
Parcel NumberMaximum Length:30The identifier given by the user for the parcel of real estate. In the USA, this is the Assessor Parcel Number. -
PostalCode: string
Title:
Postal CodeMaximum Length:60The postal code that is part of the parcel address. -
PostalPlus4Code: string
Maximum Length:
10For 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:
10The phone area code within a country. -
PrimaryPhoneCountryCode: string
Maximum Length:
10The international country code for a telephone number. -
PrimaryPhoneExtension: string
Maximum Length:
20The additional extension number after initial connection to an internal telephone system. -
PrimaryPhoneNumber: string
Maximum Length:
40The phone number of the location. -
PrimaryPhoneType: string
Title:
Primary Phone TypeMaximum Length:30The type of phone for the location. -
PrimaryRawPhoneNumber: string
Maximum Length:
60The location???s full phone number. -
Province: string
Title:
ProvinceMaximum Length:60The location information about the province in which the parcel address is located. -
RecordNumber: string
Maximum Length:
64The record number of the business location. -
SameMailAddressFlag: boolean
Title:
Is the mailing and billing address the same as the physical location?Maximum Length:1Default Value:falseIndicates that the mailing address is the same as the primary address. -
StartDate: string
(date)
Title:
Proposed Start DateThe start date of the business location. -
State: string
Title:
StateMaximum Length:60The state that is part of the parcel address. -
Status: string
Maximum Length:
10The current status of the business location. -
StQualPerNum: string
Title:
State Equalization Board NumberMaximum Length:30The state equalization board number for business. -
StreetDirection: string
Maximum Length:
10The street direction used for parcel address searches. -
StreetName: string
Maximum Length:
240The street name used for parcel address searches. -
StreetNumber: string
Maximum Length:
20The street number used for parcel address searches. -
StreetSuffix: string
Maximum Length:
20The street name that describes the street. -
StreetType: string
Maximum Length:
20The street type used for parcel address searches. -
SubjectId: string
Maximum Length:
30The attribute used to identify where the data should be displayed. -
TaxClass: string
Title:
Municipal Tax ClassMaximum Length:30The municipal tax class for the business. -
UnitNumber: string
Maximum Length:
30The apartment unit number used for parcel address searches. -
Website: string
Title:
WebsiteMaximum Length:1000The business??? primary website address. -
WithinJurisdictionFlag: boolean
Title:
Is this business physically located within the agency's jurisdiction?Maximum Length:1Default Value:trueIndicates if the location is within the agency???s jurisdiction.
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.
Root Schema : publicSectorApplicationLists-BusinessLocation-item-response
Type:
Show Source
object-
Address1: string
Title:
Address 1Maximum Length:240The address Line 1 that is part of the parcel address. -
Address2: string
Title:
Address 2Maximum Length:240The address Line 2 that is part of the parcel address. -
Address3: string
Title:
Address 3Maximum Length:240The address Line 3 that is part of the parcel address. -
Address4: string
Title:
Address 4Maximum Length:240The address Line 4 that is part of the parcel address. -
AddressCode: string
Maximum Length:
32The unique identifier for the parcel address. -
AddressId: integer
(int64)
The system generated sequence key for the parcel address.
-
AddressType: string
Maximum Length:
20The attribute used for address point validation. Possible values might be main address, virtual address, shipping gate address, or others. -
AgencyId: integer
(int32)
Default Value:
1The identifier of the agency. -
AltPhoneAreaCode: string
Maximum Length:
10The phone area code within a country. -
AltPhoneCountryCode: string
Maximum Length:
10The international country code for a telephone number. -
AltPhoneExtension: string
Maximum Length:
20The additional extension number after initial connection to an internal telephone system. -
AltPhoneNumber: string
Maximum Length:
40The phone number of the location. -
AltPhoneType: string
Title:
Alternate Phone TypeMaximum Length:30The type of phone for the location. -
AltRawPhoneNumber: string
Maximum Length:
60The location???s full phone number. -
BuildingType: string
Maximum Length:
20The building type used for parcel address searches. -
BusCategory: string
Title:
CategoryMaximum Length:50Indicates the type of business category. -
BusDbaBusinessName: string
Title:
Doing Business AsMaximum Length:100The Doing Business As name for the business. -
BusDescription: string
Title:
Business DescriptionMaximum Length:200The description of the business. -
BusinessEntityId: string
Title:
Business IDMaximum Length:50A meaningful identifier for the business entity. -
BusinessEntityKey: integer
(int64)
The unique identifier for the business entity.
-
BusinessLocationId: string
Maximum Length:
50A 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 IDMaximum Length:20The business??? state tax identifier. -
BusSubCategory: string
Title:
SubcategoryMaximum Length:50Indicates the type of business sub category. -
City: string
Title:
CityMaximum Length:60The city that is part of the parcel address. -
CityTaxId: string
Title:
City Tax IDMaximum Length:20The 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:
CountryMaximum Length:3The country that is part of the parcel address. -
County: string
Title:
CountyMaximum Length:60The county in which the parcel address is located. -
CrossroadOne: string
Maximum Length:
240The cross road 1 that is part of parcel address. -
CrossroadTwo: string
Maximum Length:
240The cross road 2 that is part of parcel address. -
EcontactAvailabilityOne: string
Title:
AvailabilityMaximum Length:1000The availability of the emergency contact. -
EcontactAvailabilityTwo: string
Title:
AvailabilityMaximum Length:1000The availability of the emergency contact. -
EcontactEmailOne: string
Title:
EmailMaximum Length:320The email of the emergency contact. -
EcontactEmailTwo: string
Title:
EmailMaximum Length:320The email of the emergency contact. -
EcontactFirstNameOne: string
Title:
Contact 1 First NameMaximum Length:150The first name of the emergency contact. -
EcontactFirstNameTwo: string
Title:
Contact 2 First NameMaximum Length:150The first name of the emergency contact. -
EcontactLastNameOne: string
Title:
Contact 1 Last NameMaximum Length:150The last name of the emergency contact. -
EcontactLastNameTwo: string
Title:
Contact 2 Last NameMaximum Length:150The last name of the emergency contact. -
EcontactPhoneAreaCodeOne: string
Maximum Length:
10The phone area code within a country. -
EcontactPhoneAreaCodeTwo: string
Maximum Length:
10The phone area code within a country. -
EcontactPhoneCountryOne: string
Maximum Length:
10The international country code for a telephone number. -
EcontactPhoneCountryTwo: string
Maximum Length:
10The international country code for a telephone number. -
EcontactPhoneExtensionOne: string
Maximum Length:
20The additional extension number after initial connection to an internal telephone system. -
EcontactPhoneExtensionTwo: string
Maximum Length:
20The additional extension number after initial connection to an internal telephone system. -
EcontactPhoneNumberOne: string
Maximum Length:
40The first phone number of the emergency contact. -
EcontactPhoneNumberTwo: string
Maximum Length:
40The second phone number of the emergency contact. -
EcontactPhoneTypeOne: string
Title:
Phone TypeMaximum Length:30The phone type of the emergency contact. -
EcontactPhoneTypeTwo: string
Title:
Phone TypeMaximum Length:30The phone type of the emergency contact. -
EcontactRawPhoneNumberOne: string
Maximum Length:
60The first phone number of the emergency contact. -
EcontactRawPhoneNumberTwo: string
Maximum Length:
60The second phone number of the emergency contact. -
EmailAddress: string
Title:
EmailMaximum Length:320The business location???s email address. -
EmployeesTotal: integer
(int64)
Indicates the total number of employees in that business location.
-
EnabledFlag: string
Maximum Length:
1Indicates if the business location is enabled. -
EndDate: string
(date)
The end date of the business location.
-
Floor: string
Maximum Length:
20The floor number used for parcel address searches. -
InactiveReason: string
Maximum Length:
1000The reason why the business location was changed to inactive. -
Landmark: string
Maximum Length:
200The landmark for the parcel address. -
Latitude: number
The geographical latitude location of the parcel address.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LnpBusinessLocationKey: integer
(int64)
The unique identifier for the transaction business location.
-
LnpBusinessLocationPuid: string
Maximum Length:
480The unique identifier of the migrated business location record. -
LnpRecordId: string
Maximum Length:
50A meaningful identifier for the transaction. -
LnpRecordKey: integer
(int64)
The unique identifier for the transaction.
-
LocationType: string
Title:
Location TypeMaximum Length:30The location type. -
Longitude: number
The geographical longitude location of the parcel address.
-
MailingAddress1: string
Maximum Length:
240The address line 1 of the location???s address. -
MailingAddress2: string
Maximum Length:
240The address line 2 of the location???s address. -
MailingAddress3: string
Maximum Length:
240The address line 3 of the location???s address. -
MailingAddress4: string
Maximum Length:
240The address line 4 of the location???s address. -
MailingCity: string
Maximum Length:
60The city portion of the location???s address. -
MailingCountry: string
Maximum Length:
3The address portion of the location???s address. -
MailingCounty: string
Maximum Length:
60The county portion of the location???s address. -
MailingPostalCode: string
Maximum Length:
60The postal code portion of the location???s address. -
MailingPostalPlusFourCode: string
Maximum Length:
10The postal4 code portion of the location???s address. -
MailingProvince: string
Maximum Length:
60The province portion of the location???s address. -
MailingState: string
Maximum Length:
60The state portion of the location???s address. -
MobileBusFlag: boolean
Title:
Is this a mobile business?Maximum Length:1Default Value:falseIndicates if the business provides a mobile product or service. -
MunicipalityId: string
Maximum Length:
20The municipality in which the parcel address is located. -
OtherTaxId: string
Title:
County Tax IDMaximum Length:20Identifier for the business??? other tax. -
ParcelId: integer
(int64)
Title:
ParcelThe system generated key from the parcel parent. -
ParcelIdEntered: string
Title:
Parcel NumberMaximum Length:30The identifier given by the user for the parcel of real estate. In the USA, this is the Assessor Parcel Number. -
PostalCode: string
Title:
Postal CodeMaximum Length:60The postal code that is part of the parcel address. -
PostalPlus4Code: string
Maximum Length:
10For 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:
10The phone area code within a country. -
PrimaryPhoneCountryCode: string
Maximum Length:
10The international country code for a telephone number. -
PrimaryPhoneExtension: string
Maximum Length:
20The additional extension number after initial connection to an internal telephone system. -
PrimaryPhoneNumber: string
Maximum Length:
40The phone number of the location. -
PrimaryPhoneType: string
Title:
Primary Phone TypeMaximum Length:30The type of phone for the location. -
PrimaryRawPhoneNumber: string
Maximum Length:
60The location???s full phone number. -
Province: string
Title:
ProvinceMaximum Length:60The location information about the province in which the parcel address is located. -
RecordNumber: string
Maximum Length:
64The record number of the business location. -
SameMailAddressFlag: boolean
Title:
Is the mailing and billing address the same as the physical location?Maximum Length:1Default Value:falseIndicates that the mailing address is the same as the primary address. -
StartDate: string
(date)
Title:
Proposed Start DateThe start date of the business location. -
State: string
Title:
StateMaximum Length:60The state that is part of the parcel address. -
Status: string
Maximum Length:
10The current status of the business location. -
StQualPerNum: string
Title:
State Equalization Board NumberMaximum Length:30The state equalization board number for business. -
StreetDirection: string
Maximum Length:
10The street direction used for parcel address searches. -
StreetName: string
Maximum Length:
240The street name used for parcel address searches. -
StreetNumber: string
Maximum Length:
20The street number used for parcel address searches. -
StreetSuffix: string
Maximum Length:
20The street name that describes the street. -
StreetType: string
Maximum Length:
20The street type used for parcel address searches. -
SubjectId: string
Maximum Length:
30The attribute used to identify where the data should be displayed. -
TaxClass: string
Title:
Municipal Tax ClassMaximum Length:30The municipal tax class for the business. -
UnitNumber: string
Maximum Length:
30The apartment unit number used for parcel address searches. -
Website: string
Title:
WebsiteMaximum Length:1000The business??? primary website address. -
WithinJurisdictionFlag: boolean
Title:
Is this business physically located within the agency's jurisdiction?Maximum Length:1Default Value:trueIndicates if the location is within the agency???s jurisdiction.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.