Get all business entites
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails
Request
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:- simpleSearchFinder: Finds the business entities that matches the search criteria specified. Finder Variables:
- value; string; The value used to search for business entities.
- PrimaryKey: Finds the business entities that matches the primary key criteria specified. Finder Variables:
- BusinessEntityId; string; The unique identifier for a business entity.
- BusinessEntityKey; integer; System generated unique identifier for a business entity.
- simpleSearchFinder: Finds the business entities that matches the search criteria specified. 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 : publicSectorBusinessEntityListDetails
Type:
Show Source
object-
count(optional):
integer
Title:
CountThe number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMoreIndicates 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:
ItemsThe items in the collection. -
limit(optional):
integer
Title:
LimitThe actual paging size used by the server. -
links(optional):
array Items
Title:
ItemsThe link relations associated with the resource instance. -
offset(optional):
integer
Title:
OffsetThe offset value used in the current page.
Nested Schema : Items
Type:
arrayTitle:
ItemsThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBusinessEntityListDetails-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
240The first line of the entity address. -
Address2(optional):
string
Maximum Length:
240The second line of the entity address. -
Address3(optional):
string
Maximum Length:
240The third line of the entity address. -
Address4(optional):
string
Maximum Length:
240The fourth line of the entity address. -
BusDisadvOwnedFlag(optional):
string
Maximum Length:
30Indicates whether the business entity is disadvantaged owned. -
BusEnabledFlag(optional):
string
Maximum Length:
1Indicates whether the business entity is enabled. -
BusExemptFlag(optional):
string
Maximum Length:
1Indicates whether the business entity has an exemption. -
BusExemptPct(optional):
integer(int32)
Business entity exemption percentage.
-
BusExemptType(optional):
string
Maximum Length:
30Identifies the type of exemption for the business entity. -
BusInactiveReason(optional):
string
Maximum Length:
1000Indicates the reason the business entity was inactivated. -
BusinessEntityId(optional):
string
Maximum Length:
255The unique identifier for a business entity. -
BusinessEntityKey(optional):
integer(int64)
System generated unique identifier for a business entity.
-
BusLocationListDetails(optional):
array Business Location List Details
Title:
Business Location List DetailsThe business location list details resource is used to view detailed information about the locations associated with a business entity. -
BusOwnershipType(optional):
string
Maximum Length:
15Business entity ownership type. -
BusOwnersLists(optional):
array Business Owner List Details
Title:
Business Owner List DetailsThe business owner list details resource is used to view detailed information about the owners associated with a business entity. -
BusPartyId(optional):
integer(int64)
Business entity party ID.
-
BusStatus(optional):
string
Maximum Length:
20The current status of the business entity. -
BusStatusMeaning(optional):
string
Maximum Length:
80The current status meaning of the business entity. -
BusVeteranOwnedFlag(optional):
string
Maximum Length:
1Indicates whether the business entity is owned by a military veteran. -
City(optional):
string
Maximum Length:
60Business entity city. -
Country(optional):
string
Maximum Length:
2Business entity country. -
County(optional):
string
Maximum Length:
60Business entity county. -
FiscalYearendDay(optional):
integer(int32)
Fiscal year end day.
-
FiscalYearendMonth(optional):
string
Maximum Length:
30Fiscal year end month. -
JgzzFiscalCode(optional):
string
Maximum Length:
20Taxpayer identification number, often unique identifier of person or organization. Can be SSN or income taxpayer ID in US, fiscal code or NIF in Europe. -
LegalStatus(optional):
string
Maximum Length:
30Business entity legal status. -
links(optional):
array Items
Title:
ItemsLink Relations -
MinorityOwnedInd(optional):
string
Maximum Length:
30Indicates whether the business entity is minority owned. -
OrganizationName(optional):
string
Maximum Length:
360The name of the business entity. -
PostalCode(optional):
string
Maximum Length:
60Business entity postal code. -
PostalPlus4Code(optional):
string
Maximum Length:
20Business entity postal plus 4 code. -
Province(optional):
string
Maximum Length:
60Business entity province. -
SmallBusInd(optional):
string
Maximum Length:
30Indicates whether the entity is a small business. -
State(optional):
string
Maximum Length:
60Business entity state. -
WomanOwnedInd(optional):
string
Maximum Length:
30Indicates whether the business entity is woman owned.
Nested Schema : Business Location List Details
Type:
arrayTitle:
Business Location List DetailsThe business location list details resource is used to view detailed information about the locations associated with a business entity.
Show Source
Nested Schema : Business Owner List Details
Type:
arrayTitle:
Business Owner List DetailsThe business owner list details resource is used to view detailed information about the owners associated with a business entity.
Show Source
Nested Schema : publicSectorBusinessEntityListDetails-BusLocationListDetails-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
240First line of the physical address. -
Address2(optional):
string
Maximum Length:
240Second line of the physical address. -
Address3(optional):
string
Maximum Length:
240Third line of the physical address. -
Address4(optional):
string
Maximum Length:
240Fourth line of the physical address. -
AddressCode(optional):
string
Maximum Length:
32Unique identifier for the parcel address. -
AddressId(optional):
integer(int64)
The unique identifier for the parcel address.
-
AddressLocId(optional):
integer(int64)
Unique identifier of the physical address.
-
AddressType(optional):
string
Maximum Length:
20Attribute used for address point validation. Possible values might be main address, virtual address, shipping gate address, or others. -
AgencyId(optional):
integer(int32)
Unique identifier of the agency.
-
AltPhoneAreaCode(optional):
string
Maximum Length:
20Alternate phone area code. -
AltPhoneContactPointId(optional):
integer(int64)
Alternate phone contact point identifier.
-
AltPhoneCountryCode(optional):
string
Maximum Length:
10Alternate phone country code. -
AltPhoneExtension(optional):
string
Maximum Length:
20Alternate phone extension number of the location. -
AltPhoneNumber(optional):
string
Maximum Length:
40Alternate phone number of the location. -
AltPhoneType(optional):
string
Maximum Length:
30Alternate phone type of the location. -
AltRawPhoneNumber(optional):
string
Maximum Length:
60Alternate raw phone number of the location. -
AreaSize(optional):
number
Size of the business location.
-
AreaSizeUom(optional):
string
Maximum Length:
10Unit of measure for the business location size. -
Building(optional):
string
Maximum Length:
240Street number of the location. -
BuildingType(optional):
string
Maximum Length:
20Building type used for parcel address searches. -
BusCategory(optional):
string
Maximum Length:
50Indicates the type of business. -
BusinessEntityId(optional):
string
Maximum Length:
50The unique identifier for a business entity. -
BusinessEntityKey(optional):
integer(int64)
System generated unique identifier for a business entity.
-
BusinessLocationId(optional):
string
Maximum Length:
255The unique identifier for a business location. -
BusinessLocationKey(optional):
integer(int64)
System generated unique identifier for a business location.
-
BusinessLocationPartyId(optional):
integer(int64)
Business location party ID.
-
BusStateTaxId(optional):
string
Maximum Length:
20State tax ID of the business location. -
BusSubCategory(optional):
string
Maximum Length:
50Business subcategory. -
City(optional):
string
Maximum Length:
60Physical address city. -
CityTaxId(optional):
string
Maximum Length:
20City tax ID of the business location. -
CoordinateX(optional):
integer(int64)
Geographic X-coordinate of the parcel address location.
-
CoordinateY(optional):
integer(int64)
Geographic Y-coordinate of the parcel address location.
-
Country(optional):
string
Maximum Length:
2Physical address country. -
County(optional):
string
Maximum Length:
60Physical address county. -
CrossroadOne(optional):
string
Maximum Length:
240Cross road 1 that is part of parcel address. -
CrossroadTwo(optional):
string
Maximum Length:
240Cross road 2 that is part of parcel address. -
CtyFoodSerLicExp(optional):
string(date)
Expiration date of the county food service license associated with the business location.
-
CtyFoodSerLicNum(optional):
string
Maximum Length:
30County food service license number of the business location. -
Description(optional):
string
Maximum Length:
2000Description of the business location. -
EcontactAvailabilityOne(optional):
string
Maximum Length:
1000Availability of the primary emergency contact. -
EcontactAvailabilityTwo(optional):
string
Maximum Length:
1000Availability of the secondary emergency contact. -
EcontactEmailOne(optional):
string
Maximum Length:
320Email address of the primary emergency contact. -
EcontactEmailTwo(optional):
string
Maximum Length:
320Email address of the secondary emergency contact. -
EcontactFirstNameOne(optional):
string
Maximum Length:
150First name of the primary emergency contact. -
EcontactFirstNameTwo(optional):
string
Maximum Length:
150First name of the secondary emergency contact. -
EcontactLastNameOne(optional):
string
Maximum Length:
150Last name of the primary emergency contact. -
EcontactLastNameTwo(optional):
string
Maximum Length:
150Last name of the secondary emergency contact. -
EcontactPhoneAreaCodeOne(optional):
string
Maximum Length:
20Primary emergency contact area code. -
EcontactPhoneAreaCodeTwo(optional):
string
Maximum Length:
20Secondary emergency contact area code. -
EcontactPhoneCountryOne(optional):
string
Maximum Length:
10Primary emergency contact country. -
EcontactPhoneCountryTwo(optional):
string
Maximum Length:
10Secondary emergency contact country code. -
EcontactPhoneExtensionOne(optional):
string
Maximum Length:
20Primary emergency contact phone extension number of the location. -
EcontactPhoneExtensionTwo(optional):
string
Maximum Length:
20Secondary emergency contact phone extension number of the location. -
EcontactPhoneNumberOne(optional):
string
Maximum Length:
40Primary emergency contact phone number of the location. -
EcontactPhoneNumberTwo(optional):
string
Maximum Length:
40Secondary emergency contact phone number of the location. -
EcontactPhoneTypeOne(optional):
string
Maximum Length:
30Phone type of the primary emergency contact for the location. -
EcontactPhoneTypeTwo(optional):
string
Maximum Length:
30Secondary emergency contact phone type of the location. -
EcontactRawPhoneNumberOne(optional):
string
Maximum Length:
60Primary emergency contact raw phone number of the location. -
EcontactRawPhoneNumberTwo(optional):
string
Maximum Length:
60Secondary emergency contact raw phone number of the location. -
EffectiveEndDate(optional):
string(date)
Effective end date of the location.
-
EffectiveStartDate(optional):
string(date)
Effective start date of the location.
-
EmailAddress(optional):
string
Maximum Length:
320Email address of the location. -
EmployeesTotal(optional):
number
Total number of employees for the business location.
-
EnabledFlag(optional):
string
Maximum Length:
1Indicates whether the business location has been enabled. -
EndDate(optional):
string(date)
The end date of the business location.
-
EOnePhoneContactPointId(optional):
integer(int64)
Unique identifier of the primary emergency phone contact.
-
ETwoPhoneContactPointId(optional):
integer(int64)
Unique identifier of the secondary emergency phone contact.
-
FloorNumber(optional):
string
Maximum Length:
40The floor number of the physical address. -
InactiveReason(optional):
string
Maximum Length:
1000The reason that the business location was inactivated. -
JgzzFiscalCode(optional):
string
Maximum Length:
20Taxpayer identification number, often unique identifier of person or organization. Can be SSN or income taxpayer ID in US, fiscal code or NIF in Europe. -
Landmark(optional):
string
Maximum Length:
200Landmark for the parcel address. -
Latitude(optional):
number
Latitude of the location.
-
LineOfBusiness(optional):
string
Maximum Length:
240Line of business. -
links(optional):
array Items
Title:
ItemsLink Relations -
Longitude(optional):
number
Longitude of the location.
-
MailAddress1(optional):
string
Maximum Length:
240First line of the location mailing address. -
MailAddress2(optional):
string
Maximum Length:
240Second line of the location mailing address. -
MailAddress3(optional):
string
Maximum Length:
240Third line of the location mailing address. -
MailAddress4(optional):
string
Maximum Length:
240Fourth line of the location mailing address. -
MailAddrsLocId(optional):
integer(int64)
Unique identifier of the mailing address for the business location.
-
MailCity(optional):
string
Maximum Length:
60Location mailing city. -
MailCountry(optional):
string
Maximum Length:
2Location mailing country. -
MailCounty(optional):
string
Maximum Length:
60Location mailing county. -
MailPostalCode(optional):
string
Maximum Length:
60Location mailing postal code. -
MailPostalPlusCode(optional):
string
Maximum Length:
20Location mailing postal plus 4 code. -
MailProvince(optional):
string
Maximum Length:
60Location mailing province. -
MailState(optional):
string
Maximum Length:
60Location mailing state. -
MobileBusinessFlag(optional):
string
Maximum Length:
1Indicates whether the business is a mobile product or provides mobile service. -
MunicipalityId(optional):
string
Maximum Length:
20Municipality in which the parcel address is located. -
OrganizationName(optional):
string
Maximum Length:
360Doing business as name. -
OrgProfilesStatus(optional):
string
Maximum Length:
1Organization profile status. -
OtherTaxId(optional):
string
Maximum Length:
20County tax ID of the business location. -
ParcelId(optional):
integer(int64)
The unique identifier for the parcel.
-
ParcelIdEntered(optional):
string
Maximum Length:
30The parcel number. -
Position(optional):
string
Maximum Length:
50Street direction of the location. -
PostalCode(optional):
string
Maximum Length:
60Physical address postal code. -
PostalPlus4Code(optional):
string
Maximum Length:
20Physical address postal plus 4 code. -
PrimaryPhoneAreaCode(optional):
string
Maximum Length:
20Primary phone area code. -
PrimaryPhoneCountryCode(optional):
string
Maximum Length:
10Primary phone country code. -
PrimaryPhoneExtension(optional):
string
Maximum Length:
20Primary phone extension number of the location. -
PrimaryPhoneNumber(optional):
string
Maximum Length:
40Primary phone number of the location. -
PrimaryPhoneType(optional):
string
Maximum Length:
30Primary phone type of the location. -
PrimaryRawPhoneNumber(optional):
string
Maximum Length:
60Primary raw phone number of the location. -
PrimPhoneContactPointId(optional):
integer(int64)
Primary phone contact point identifier.
-
Province(optional):
string
Maximum Length:
60Physical address province. -
RentalUnitNum(optional):
integer(int64)
Number of rental units for the business location.
-
SameMailAddressFlag(optional):
string
Maximum Length:
1Indicates whether the mailing address is same as the location address. -
SellPerNum(optional):
string
Maximum Length:
30Business sellers permit number of the location. -
SellPerNumExp(optional):
string(date)
Expiration date of the business sellers permit number associated with the location.
-
StartDate(optional):
string(date)
The start date of the business location.
-
State(optional):
string
Maximum Length:
60Physical address state. -
Status(optional):
string
Maximum Length:
20Current status of the location. -
StatusMeaning(optional):
string
Maximum Length:
80Current status meaning of the location. -
StQualPerNum(optional):
string
Maximum Length:
30State equalization board number of the business location. -
StreetName(optional):
string
Maximum Length:
240Street name used for parcel address searches. -
StreetSuffix(optional):
string
Maximum Length:
20Street name that describes the street. -
StreetType(optional):
string
Maximum Length:
20Street type used for parcel address searches. -
TaxClass(optional):
string
Maximum Length:
30Municipal tax class of the business location. -
UnitNumber(optional):
string
Maximum Length:
30Apartment unit number used for parcel address searches. -
Website(optional):
string
Maximum Length:
1000Website address of the location. -
WithinJurisdictionFlag(optional):
string
Maximum Length:
1Indicates whether the business is located within agency jurisdiction.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorBusinessEntityListDetails-BusOwnersLists-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
240First line of the physical address. -
Address2(optional):
string
Maximum Length:
240Second line of the physical address. -
Address3(optional):
string
Maximum Length:
240Third line of the physical address. -
Address4(optional):
string
Maximum Length:
240Fourth line of the physical address. -
AgencyId(optional):
integer(int32)
Unique identifier for the agency.
-
BePersonId(optional):
string
Maximum Length:
200Meaningful identifier of a responsible person for the business. -
BePersonLengthAtAddress(optional):
integer(int64)
The length of time that the person has been at this address.
-
BusContactDmvLicExp(optional):
string(date)
Contact DMV expiry date.
-
BusContactDmvLicNum(optional):
string
Maximum Length:
30Contact DMV license number. -
BusContactDmvLicSt(optional):
string
Maximum Length:
60Contact DMV license state. -
BusinessEntityId(optional):
string
Maximum Length:
50The unique identifier for a business entity. -
BusinessEntityKey(optional):
integer(int64)
System generated unique identifier for a business entity.
-
City(optional):
string
Maximum Length:
60Physical address city. -
Country(optional):
string
Maximum Length:
2Physical address country. -
County(optional):
string
Maximum Length:
60Physical address county. -
DateOfBirth(optional):
string(date)
Date of birth of the person.
-
EmailAddress(optional):
string
Maximum Length:
320Email address of the person. -
EntityPartyId(optional):
integer(int64)
Business entity party ID.
-
JobTitle(optional):
string
Maximum Length:
100Person title. -
links(optional):
array Items
Title:
ItemsLink Relations -
MailingAddress1(optional):
string
Maximum Length:
240First line of the location mailing address. -
MailingAddress2(optional):
string
Maximum Length:
240Second line of the location mailing address. -
MailingAddress3(optional):
string
Maximum Length:
240Third line of the location mailing address. -
MailingAddress4(optional):
string
Maximum Length:
240Fourth line of the location mailing address. -
MailingCity(optional):
string
Maximum Length:
60Mailing address city. -
MailingCountry(optional):
string
Maximum Length:
2Mailing address country. -
MailingCounty(optional):
string
Maximum Length:
60Mailing address county. -
MailingPostalCode(optional):
string
Maximum Length:
60Mailing address postal code. -
MailingPostalPlusCode(optional):
string
Maximum Length:
20Mailing address postal plus 4 code. -
MailingProvince(optional):
string
Maximum Length:
60Mailing address province. -
MailingState(optional):
string
Maximum Length:
60Mailing address state. -
OwnerPartyId(optional):
integer(int64)
The unique identifier for an owner party.
-
PercentageOwnership(optional):
number
Indicates a person's percentage of ownership in the business.
-
PersonFirstName(optional):
string
Maximum Length:
150First name of the person. -
PersonLastName(optional):
string
Maximum Length:
150Last name of the person. -
PersonMiddleName(optional):
string
Maximum Length:
60Middle name of the person. -
PersonName(optional):
string
Maximum Length:
450Name of the person. -
PersonNameSuffix(optional):
string
Maximum Length:
30Person name suffix. -
PhoneAreaCode(optional):
string
Maximum Length:
20Area code. -
PhoneCountryCode(optional):
string
Maximum Length:
10Country code. -
PhoneExtension(optional):
string
Maximum Length:
20Phone extension number. -
PhoneNumber(optional):
string
Maximum Length:
40Phone number. -
PhoneType(optional):
string
Maximum Length:
30Phone type. -
PostalCode(optional):
string
Maximum Length:
60Physical address postal code. -
PostalPlus4Code(optional):
string
Maximum Length:
20Physical address postal plus 4 code. -
Province(optional):
string
Maximum Length:
60Physical address province. -
RawPhoneNumber(optional):
string
Maximum Length:
60Raw phone number. -
ReferenceKey(optional):
integer(int64)
System generated unique identifier for an owner.
-
ReferencePuid(optional):
string
Maximum Length:
50The unique identifier for an owner. -
Salutation(optional):
string
Maximum Length:
60Person's prename adjunct. -
SameAsApplicantFlag(optional):
string
Maximum Length:
1Indicates whether the physical address is the same as the mailing address. -
SameMailAddressFlag(optional):
string
Maximum Length:
1Indicates whether the physical address is the same as the mailing address. -
State(optional):
string
Maximum Length:
60Physical address state. -
Status(optional):
string
Maximum Length:
30Current status of the owner. -
StatusMeaning(optional):
string
Maximum Length:
80The meaning of the owner's current status. -
VerificationDate(optional):
string(date)
The date that the responsible person was verified.
-
VerificationStatus(optional):
string
Maximum Length:
30The verification status for the responsible person. -
VerifiedBy(optional):
string
Maximum Length:
30Identifies who verified the responsible person.