Get a business location
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/BusinessLocation/{LnpBusinessLocationKey}
Request
Path Parameters
-
LnpBusinessLocationKey(required): integer(int64)
The unique identifier for the transaction business location.
-
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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorRecordLists-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
This 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
Meaningful identifier for the business entity. -
BusinessEntityKey: integer
(int64)
The unique identifier for the business entity.
-
BusinessLocationId: string
Maximum Length:
50
Meaningful identifier for business location. -
BusinessLocationKey: integer
(int64)
The unique identifier for business location.
-
BusinessLocationPartyId: integer
(int64)
The unique identifier for 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
This 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 for the migrated business location record. -
LnpRecordId: string
Maximum Length:
50
Meaningful identifier for the transaction. -
LnpRecordKey: integer
(int64)
The unique identifier for the transaction.
-
LocationType: string
Title:
Location Type
Maximum Length:30
The type of location. -
Longitude: number
The geographical longitude location of the parcel address.
-
MailingAddress1: string
Maximum Length:
240
The address portion of the location???s address. -
MailingAddress2: string
Maximum Length:
240
The address portion of the location???s address. -
MailingAddress3: string
Maximum Length:
240
The address portion of the location???s address. -
MailingAddress4: string
Maximum Length:
240
The address portion 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.