Get all business locations
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/BusinessLocation
Request
Path Parameters
-
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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 a business location by the specified primary key criteria. Finder Variables:
- LnpBusinessLocationKey; integer; The unique identifier for a business location.
- PrimaryKey: Finds a business location by the specified primary key criteria. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorRecordLists-BusinessLocation
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordLists-BusinessLocation-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
The address Line 1 that is part of the parcel address. -
Address2(optional):
string
Maximum Length:
240
The address Line 2 that is part of the parcel address. -
Address3(optional):
string
Maximum Length:
240
The address Line 3 that is part of the parcel address. -
Address4(optional):
string
Maximum Length:
240
The address Line 4 that is part of the parcel address. -
AddressCode(optional):
string
Maximum Length:
32
The unique identifier for the parcel address. -
AddressId(optional):
integer(int64)
The system generated sequence key for the parcel address.
-
AddressType(optional):
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(optional):
integer(int32)
The identifier of the agency.
-
AltPhoneAreaCode(optional):
string
Maximum Length:
10
The phone area code within a country. -
AltPhoneCountryCode(optional):
string
Maximum Length:
10
The international country code for a telephone number. -
AltPhoneExtension(optional):
string
Maximum Length:
20
The additional extension number after initial connection to an internal telephone system. -
AltPhoneNumber(optional):
string
Maximum Length:
40
The phone number of the location. -
AltPhoneType(optional):
string
Maximum Length:
30
The type of phone for the location. -
AltRawPhoneNumber(optional):
string
Maximum Length:
60
The location's full phone number. -
BuildingType(optional):
string
Maximum Length:
20
The building type used for parcel address searches. -
BusCategory(optional):
string
Maximum Length:
50
This indicates the type of business category. -
BusDbaBusinessName(optional):
string
Maximum Length:
100
The doing business as name for the business. -
BusDescription(optional):
string
Title:
Business Description
Maximum Length:200
The description of the business. -
BusinessEntityId(optional):
string
Maximum Length:
50
Meaningful identifier for the business entity. -
BusinessEntityKey(optional):
integer(int64)
The unique identifier for the business entity.
-
BusinessLocationId(optional):
string
Maximum Length:
50
Meaningful identifier for business location. -
BusinessLocationKey(optional):
integer(int64)
The unique identifier for business location.
-
BusinessLocationPartyId(optional):
integer(int64)
The unique identifier for business location's TCA party.
-
BusStateTaxId(optional):
string
Maximum Length:
20
The business' state tax identifier. -
BusSubCategory(optional):
string
Maximum Length:
50
This indicates the type of Business sub category. -
City(optional):
string
Maximum Length:
60
The city that is part of the parcel address. -
CityTaxId(optional):
string
Maximum Length:
20
The business' city tax identifier. -
CoordinateX(optional):
number
The geographic x coordinate of the parcel address location.
-
CoordinateY(optional):
number
The geographic y coordinate of the parcel address location.
-
Country(optional):
string
Maximum Length:
3
The country that is part of the parcel address. -
County(optional):
string
Title:
County
Maximum Length:60
The county in which the parcel address is located. -
CrossroadOne(optional):
string
Maximum Length:
240
The cross road 1 that is part of parcel address. -
CrossroadTwo(optional):
string
Maximum Length:
240
The cross road 2 that is part of parcel address. -
EcontactAvailabilityOne(optional):
string
Maximum Length:
1000
The availability of the emergency contact. -
EcontactAvailabilityTwo(optional):
string
Maximum Length:
1000
The availability of the emergency contact. -
EcontactEmailOne(optional):
string
Maximum Length:
320
The email of the emergency contact. -
EcontactEmailTwo(optional):
string
Maximum Length:
320
The email of the emergency contact. -
EcontactFirstNameOne(optional):
string
Maximum Length:
150
The first name of the emergency contact. -
EcontactFirstNameTwo(optional):
string
Maximum Length:
150
The first name of the emergency contact. -
EcontactLastNameOne(optional):
string
Maximum Length:
150
The last name of the emergency contact. -
EcontactLastNameTwo(optional):
string
Maximum Length:
150
The last name of the emergency contact. -
EcontactPhoneAreaCodeOne(optional):
string
Maximum Length:
10
The phone area code within a country. -
EcontactPhoneAreaCodeTwo(optional):
string
Maximum Length:
10
The phone area code within a country. -
EcontactPhoneCountryOne(optional):
string
Maximum Length:
10
The international country code for a telephone number. -
EcontactPhoneCountryTwo(optional):
string
Maximum Length:
10
The international country code for a telephone number. -
EcontactPhoneExtensionOne(optional):
string
Maximum Length:
20
The additional extension number after initial connection to an internal telephone system. -
EcontactPhoneExtensionTwo(optional):
string
Maximum Length:
20
The additional extension number after initial connection to an internal telephone system. -
EcontactPhoneNumberOne(optional):
string
Maximum Length:
40
The first phone number of the emergency contact. -
EcontactPhoneNumberTwo(optional):
string
Maximum Length:
40
The second phone number of the emergency contact. -
EcontactPhoneTypeOne(optional):
string
Maximum Length:
30
The phone type of the emergency contact. -
EcontactPhoneTypeTwo(optional):
string
Maximum Length:
30
The phone type of the emergency contact. -
EcontactRawPhoneNumberOne(optional):
string
Maximum Length:
60
The first phone number of the emergency contact. -
EcontactRawPhoneNumberTwo(optional):
string
Maximum Length:
60
The second phone number of the emergency contact. -
EmailAddress(optional):
string
Maximum Length:
320
The business location's email address. -
EmployeesTotal(optional):
integer(int64)
Indicates the total number of employees in that business location.
-
EnabledFlag(optional):
string
Maximum Length:
1
Indicates if the business location is enabled. -
EndDate(optional):
string(date)
The end date of the business location.
-
Floor(optional):
string
Maximum Length:
20
The floor number used for parcel address searches. -
InactiveReason(optional):
string
Maximum Length:
1000
The reason why the business location was changed to inactive. -
Landmark(optional):
string
Maximum Length:
200
The landmark for the parcel address. -
Latitude(optional):
number
The geographical latitude location of the parcel address.
-
links(optional):
array Items
Title:
Items
Link Relations -
LnpBusinessLocationKey(optional):
integer(int64)
The unique identifier for the transaction business location.
-
LnpRecordId(optional):
string
Maximum Length:
50
Meaningful identifier for the transaction. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for the transaction.
-
Longitude(optional):
number
The geographical longitude location of the parcel address.
-
MailingAddress1(optional):
string
Maximum Length:
240
The address portion of the location's address. -
MailingAddress2(optional):
string
Maximum Length:
240
The address portion of the location's address. -
MailingAddress3(optional):
string
Maximum Length:
240
The address portion of the location's address. -
MailingAddress4(optional):
string
Maximum Length:
240
The address portion of the location's address. -
MailingCity(optional):
string
Maximum Length:
60
The city portion of the location's address. -
MailingCountry(optional):
string
Maximum Length:
3
The address portion of the location's address. -
MailingCounty(optional):
string
Maximum Length:
60
The county portion of the location's address. -
MailingPostalCode(optional):
string
Maximum Length:
60
The postal code portion of the location's address. -
MailingPostalPlusFourCode(optional):
string
Maximum Length:
10
The postal4 code portion of the location's address. -
MailingProvince(optional):
string
Maximum Length:
60
The province portion of the location's address. -
MailingState(optional):
string
Maximum Length:
60
The state portion of the location's address. -
MobileBusFlag(optional):
string
Maximum Length:
1
Indicates if the business provides a mobile product or service. -
MunicipalityId(optional):
string
Maximum Length:
20
The municipality in which the parcel address is located. -
OtherTaxId(optional):
string
Maximum Length:
20
Identifier for the business' other tax. -
ParcelId(optional):
integer(int64)
The system generated key from the parcel parent.
-
ParcelIdEntered(optional):
string
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(optional):
string
Maximum Length:
60
The postal code that is part of the parcel address. -
PostalPlus4Code(optional):
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(optional):
string
Maximum Length:
10
The phone area code within a country. -
PrimaryPhoneCountryCode(optional):
string
Maximum Length:
10
The international country code for a telephone number. -
PrimaryPhoneExtension(optional):
string
Maximum Length:
20
The additional extension number after initial connection to an internal telephone system. -
PrimaryPhoneNumber(optional):
string
Maximum Length:
40
The phone number of the location. -
PrimaryPhoneType(optional):
string
Maximum Length:
30
The type of phone for the location. -
PrimaryRawPhoneNumber(optional):
string
Maximum Length:
60
The location's full phone number. -
Province(optional):
string
Maximum Length:
60
The location information about the province in which the parcel address is located. -
SameMailAddressFlag(optional):
boolean
Indicates that the mailing address is the same as the primary address.
-
StartDate(optional):
string(date)
The start date of the business location.
-
State(optional):
string
Maximum Length:
60
The state that is part of the parcel address. -
Status(optional):
string
Maximum Length:
10
The current status of the business location. -
StQualPerNum(optional):
string
Maximum Length:
30
The state equalization board number for business. -
StreetDirection(optional):
string
Maximum Length:
10
The street Direction used for parcel address searches. -
StreetName(optional):
string
Maximum Length:
240
The street Name used for parcel address searches. -
StreetNumber(optional):
string
Maximum Length:
20
The street number used for parcel address searches. -
StreetSuffix(optional):
string
Maximum Length:
20
The street name that describes the street. -
StreetType(optional):
string
Maximum Length:
20
The street Type used for parcel address searches. -
SubjectId(optional):
string
Maximum Length:
30
The attribute used to identify where the data should be displayed. -
TaxClass(optional):
string
Maximum Length:
30
The municipal tax class for the business. -
UnitNumber(optional):
string
Maximum Length:
30
The apartment unit number used for parcel address searches. -
Website(optional):
string
Maximum Length:
1000
The business' primary website address. -
WithinJurisdictionFlag(optional):
string
Maximum Length:
1
Indicates if the location is within the agency's jurisdiction.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.