Get all business entities
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations
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:- PrimaryKey: Finds the business entities that match the primary key criteria specified. Finder Variables:
- BusinessEntityKey; integer; The unique identifier for a business entity.
- PrimaryKey: Finds the business entities that match the primary key 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 : publicSectorBusinessRegistrations
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 : publicSectorBusinessRegistrations-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The unique identifier for the agency associated with the business entity.
-
ApplicantPartyId(optional):
integer(int64)
The unique identifier for the applicant party.
-
BusAddressFour(optional):
string
The fourth line of the entity address.
-
BusAddressOne(optional):
string
The first line of the entity address.
-
BusAddressThree(optional):
string
The third line of the entity address.
-
BusAddressTwo(optional):
string
The second line of the entity address.
-
BusBusinessLegalName(optional):
string
The legally registered name of the business entity.
-
BusCity(optional):
string
City of the entity address.
-
BusCountry(optional):
string
Country of the entity address.
-
BusDbaBusinessName(optional):
string
Doing business as (DBA) name of the business entity.
-
BusDisadvOwnedFlag(optional):
string
Indicates whether the business is classified as disadvantaged by the U.S. Department of Transportation.
-
BusEmployerIdNumber(optional):
string
The employer ID for the business entity.
-
BusEnabledFlag(optional):
string
Maximum Length:
1Indicates whether the business entity is enabled. -
BusExemptFlag(optional):
string
Maximum Length:
1Indicates whether the business entity is exempt from license fees. -
BusExemptPct(optional):
integer(int32)
Percentage of the exemption for the business entity.
-
BusExemptType(optional):
string
Maximum Length:
30Type of exemption for the business entity. -
BusFedTaxId(optional):
string
Taxpayer identification number, often unique identifier of person or organization. Can be SSN or income taxpayer ID in US, fiscal code or NIF in Europe.
-
BusFemaleOwnedFlag(optional):
string
Indicates whether the business is primarily owned by women.
-
BusInactiveReason(optional):
string
Maximum Length:
1000The reason that the business entity was inactivated. -
BusinessEntityId(optional):
string
Maximum Length:
50The unique identifier for the business entity. -
BusinessEntityKey(optional):
integer(int64)
System-generated identifier for a business entity.
-
BusinessLocation(optional):
array Business Locations
Title:
Business LocationsThe business registrations resource is used to create and update business entities. -
BusinessLocationId(optional):
string
Maximum Length:
50The unique identifier for a business location. -
BusinessOwner(optional):
array Business Owners
Title:
Business OwnersThe business registrations resource is used to create and update business entities. -
BusMinorityOwnedFlag(optional):
string
Indicates whether the business is primarily owned by a minority.
-
BusOwnershipType(optional):
string
Maximum Length:
15Business entity ownership type. -
BusPartyId(optional):
integer(int64)
Business entity party ID.
-
BusPostalCode(optional):
string
Business entity postal code.
-
BusPostalPlusCode(optional):
string
Business entity postal plus 4 code.
-
BusProvince(optional):
string
Business entity province.
-
BusSmallBusFlag(optional):
string
Indicates whether the business is classified as a small business according to the Small Business Administration guidelines.
-
BusState(optional):
string
Business entity state.
-
BusStatus(optional):
string
Maximum Length:
20The current status of the business entity. -
BusVeteranOwnedFlag(optional):
string
Maximum Length:
1Indicates whether the business is owned by a military veteran. -
County(optional):
string
Physical address county.
-
CreationDate(optional):
string(date-time)
The date that the business entity was created.
-
FiscalYearendDay(optional):
integer(int32)
The last day of the fiscal year for the business entity.
-
FiscalYearendMon(optional):
string
Maximum Length:
10The last month of the fiscal year for the business entity. -
links(optional):
array Items
Title:
ItemsLink Relations -
ObjectVersionNumber(optional):
integer(int32)
Workflow project revision number used to define the workflow.
Nested Schema : Business Locations
Type:
arrayTitle:
Business LocationsThe business registrations resource is used to create and update business entities.
Show Source
Nested Schema : Business Owners
Type:
arrayTitle:
Business OwnersThe business registrations resource is used to create and update business entities.
Show Source
Nested Schema : publicSectorBusinessRegistrations-BusinessLocation-item
Type:
Show Source
object-
Address1(optional):
string
First line of the physical address.
-
Address2(optional):
string
Second line of the physical address.
-
Address3(optional):
string
Third line of the physical address.
-
Address4(optional):
string
Fourth 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 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)
The unique identifier of the agency associated with the business location.
-
AltPhoneAreaCode(optional):
string
Alternate phone area code.
-
AltPhoneContactPointId(optional):
integer(int64)
Unique identifier for the alternate phone contact.
-
AltPhoneCountryCode(optional):
string
Alternate phone country code.
-
AltPhoneExtension(optional):
string
Alternate phone extension number of the location.
-
AltPhoneNumber(optional):
string
Alternate phone number of the location.
-
AltPhoneType(optional):
string
Alternate phone type of the location.
-
AltRawPhoneNumber(optional):
string
Alternate 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. -
BuildingType(optional):
string
Maximum Length:
20Building type used for parcel address searches. -
BusCategory(optional):
string
Maximum Length:
50The category for the business. -
BusDbaBusinessName(optional):
string
The operating name of the business.
-
BusDescription(optional):
string
Description of the business.
-
BusinessEntityId(optional):
string
Maximum Length:
50The unique identifier for the business entity associated with the location. -
BusinessEntityKey(optional):
integer(int64)
System-generated identifier for a business entity.
-
BusinessLocationId(optional):
string
Maximum Length:
50The unique identifier for the business location. -
BusinessLocationKey(optional):
integer(int64)
System-generated unique identifier for a business location.
-
BusinessLocationPartyId(optional):
integer(int64)
The unique identifier for the party associated with the business location.
-
BusStateTaxId(optional):
string
Maximum Length:
20State tax ID of the business location. -
BusSubCategory(optional):
string
Maximum Length:
50The subcategory for the business. -
City(optional):
string
The location address city.
-
CityTaxId(optional):
string
Maximum Length:
20The unique tax identifier issued to the business by the city. -
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
The location address country.
-
County(optional):
string
Physical address county.
-
CreationDate(optional):
string(date-time)
The date that the business location was created.
-
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. -
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
Primary emergency contact area code.
-
EcontactPhoneAreaCodeTwo(optional):
string
Secondary emergency contact area code.
-
EcontactPhoneCountryOne(optional):
string
Primary emergency contact country.
-
EcontactPhoneCountryTwo(optional):
string
Secondary emergency contact country code.
-
EcontactPhoneExtensionOne(optional):
string
Primary emergency contact phone extension number of the location.
-
EcontactPhoneExtensionTwo(optional):
string
Secondary emergency contact phone extension number of the location.
-
EcontactPhoneNumberOne(optional):
string
Primary emergency contact phone number of the location.
-
EcontactPhoneNumberTwo(optional):
string
Secondary emergency contact phone number of the location.
-
EcontactPhoneTypeOne(optional):
string
Phone type of the primary emergency contact for the location.
-
EcontactPhoneTypeTwo(optional):
string
Secondary emergency contact phone type of the location.
-
EcontactRawPhoneNumberOne(optional):
string
Primary emergency contact raw phone number of the location.
-
EcontactRawPhoneNumberTwo(optional):
string
Secondary emergency contact raw phone number of the location.
-
EmailAddress(optional):
string
Maximum Length:
320Email address of the location. -
EmployeeTotal(optional):
integer(int32)
Total number of employees in organization.
-
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)
The unique identifier for the primary phone contact.
-
ETwoPhoneContactPointId(optional):
integer(int64)
The unique identifier for the secondary phone contact.
-
Floor(optional):
string
The floor number of the physical address.
-
InactiveReason(optional):
string
Maximum Length:
1000The reason that the business location was inactivated. -
Landmark(optional):
string
Maximum Length:
200Landmark for the parcel address. -
LastUpdateDate(optional):
string(date-time)
The date that the business location was last updated.
-
LastUpdateLogin(optional):
string
Maximum Length:
32The login identifier of the person who last updated the business location. -
Latitude(optional):
number
Latitude of the location.
-
links(optional):
array Items
Title:
ItemsLink Relations -
Longitude(optional):
number
Longitude of the location.
-
MailingAddress1(optional):
string
First line of the location mailing address.
-
MailingAddress2(optional):
string
Third line of the location mailing address.
-
MailingAddress3(optional):
string
Second line of the location mailing address.
-
MailingAddress4(optional):
string
Fourth line of the location mailing address.
-
MailingCity(optional):
string
Location mailing address city.
-
MailingCountry(optional):
string
Location mailing address country.
-
MailingCounty(optional):
string
Location mailing address county.
-
MailingPostalCode(optional):
string
Location mailing address postal code.
-
MailingPostalPlusFourCode(optional):
string
Location mailing postal plus 4 code.
-
MailingProvince(optional):
string
Location mailing address province.
-
MailingState(optional):
string
Location mailing address state.
-
MobileBusFlag(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. -
ObjectVersionNumber(optional):
integer(int32)
Workflow project revision number used to define the workflow.
-
OtherTaxId(optional):
string
Maximum Length:
20The unique tax identifier issued to the business by the county. -
ParcelId(optional):
integer(int64)
The unique identifier for the parcel.
-
ParcelIdEntered(optional):
string
Maximum Length:
30The parcel number. -
PostalCode(optional):
string
Physical address postal code.
-
PostalPlus4Code(optional):
string
Physical address postal plus 4 code.
-
PrimaryPhoneAreaCode(optional):
string
Primary phone area code.
-
PrimaryPhoneCountryCode(optional):
string
Primary phone country code.
-
PrimaryPhoneExtension(optional):
string
Primary phone extension number of the location.
-
PrimaryPhoneNumber(optional):
string
Primary phone number of the location.
-
PrimaryPhoneType(optional):
string
Primary phone type of the location.
-
PrimaryRawPhoneNumber(optional):
string
Primary raw phone number of the location.
-
PrimPhoneContactPointId(optional):
integer(int64)
The unique identifier of the primary phone contact.
-
Province(optional):
string
Physical 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 mailing 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
Physical address state.
-
Status(optional):
string
Maximum Length:
20Current status of the location. -
StQualPerNum(optional):
string
Maximum Length:
30The ID number issued to the business by the State Equalization Board. -
StreetDirection(optional):
string
Street direction of the location.
-
StreetName(optional):
string
Maximum Length:
240Street name used for parcel address searches. -
StreetNumber(optional):
string
Street number of the location.
-
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 the agency's 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 : publicSectorBusinessRegistrations-BusinessOwner-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
255First line of the physical address. -
Address2(optional):
string
Second line of the physical address.
-
Address3(optional):
string
Third line of the physical address.
-
Address4(optional):
string
Fourth line of the physical address.
-
AgencyId(optional):
integer(int32)
Unique identifer for the agency.
-
BePersonId(optional):
string
Maximum Length:
200Unique identifier of the business owner. -
BusinessEntityId(optional):
string
Maximum Length:
50The unique identifier for a business entity. -
BusinessEntityKey(optional):
integer(int64)
System-generated identifier for a business entity.
-
City(optional):
string
Physical address city.
-
ContactDmvLicExp(optional):
string(date)
The contact DMV license expiration date.
-
ContactDmvLicNum(optional):
string
Maximum Length:
30The contact DMV license number. -
ContactDmvLicSt(optional):
string
Maximum Length:
60The contact DMV license state. -
Country(optional):
string
Physical address country.
-
County(optional):
string
Physical address county.
-
CreationDate(optional):
string(date-time)
The date that the business owner was created.
-
DateOfBirth(optional):
string(date)
The business owner's date of birth.
-
EmailAddress(optional):
string
Email address of the business owner.
-
EmergencyContactFlag(optional):
string
Indicates whether the owner is an emergency contact.
-
EmergencyContactPhone(optional):
string
The phone number of the emergency contact.
-
LastUpdateDate(optional):
string(date-time)
The date on which the business owner was last updated.
-
LastUpdateLogin(optional):
string
Maximum Length:
32The login identifier of the person who last updated the business owner. -
links(optional):
array Items
Title:
ItemsLink Relations -
MailingAddress1(optional):
string
First line of the location owner mailing address.
-
MailingAddress2(optional):
string
Second line of the location mailing address.
-
MailingAddress3(optional):
string
Third line of the location mailing address.
-
MailingAddress4(optional):
string
Fourth line of the location owner mailing address.
-
MailingAddressId(optional):
string
The unique identifier for the mailing address.
-
MailingCity(optional):
string
Mailing address city.
-
MailingCountry(optional):
string
Mailing address country.
-
MailingCounty(optional):
string
Mailing address county.
-
MailingPostalCode(optional):
string
Mailing address postal code.
-
MailingPostalPlusFourCode(optional):
string
Location mailing postal plus 4 code.
-
MailingProvince(optional):
string
Mailing address province.
-
MailingState(optional):
string
Mailing address state.
-
ObjectVersionNumber(optional):
integer(int32)
Workflow project revision number used to define the workflow.
-
OwnershipPct(optional):
number
The person's percentage of ownership in the business.
-
PersonFirstName(optional):
string
First name of the business owner.
-
PersonLastName(optional):
string
Last name of the business owner.
-
PersonLengthAtAddress(optional):
integer(int64)
The length of time that the person has been at this address.
-
PersonMiddleName(optional):
string
Middle name of the business owner.
-
PersonNameSuffix(optional):
string
The name suffix of the business owner.
-
PersonPreNameAdjunct(optional):
string
Person's pre name adjunct.
-
PersonTitle(optional):
string
The title of the business owner.
-
PersonType(optional):
string
The person type for the business owner.
-
PhoneAreaCode(optional):
string
Phone number area code.
-
PhoneCountryCode(optional):
string
Phone number country code.
-
PhoneExtension(optional):
string
Phone extension number.
-
PhoneNumber(optional):
string
Phone number.
-
PhoneType(optional):
string
Phone type.
-
PostalCode(optional):
string
Physical address postal code.
-
PostalPlus4Code(optional):
string
Physical address postal plus 4 code.
-
Province(optional):
string
Physical address province.
-
RawPhoneNumber(optional):
string
Raw phone number.
-
ReferenceKey(optional):
integer(int64)
System-generated unique identifier for an owner.
-
ReferencePartyId(optional):
integer(int64)
Unique identifier for the reference party.
-
ReferencePuid(optional):
string
Maximum Length:
50System-generated reference key PUID. -
RelationShipToBusiness(optional):
string
The owner's relationship to the business.
-
SameAsApplicantFlag(optional):
string
Maximum Length:
1Indicates the mailing address is the same as the applicant's. -
SameMailAddressFlag(optional):
string
Maximum Length:
1Indicates that the mailing address is the same as the physical address. -
State(optional):
string
Physical address state.
-
Status(optional):
string
Maximum Length:
30Current status of the location. -
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.