1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Business License
  4. Business Entity List Details

Get all business entities

get

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails

Request

Query Parameters
  • 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).
  • 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
  • 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 matches the primary key criteria specified.
      Finder Variables:
      • BusinessEntityKey; integer; System generated unique identifier for a business entity.
    • simpleSearchFinder: Finds the business entities that matches the search criteria specified.
      Finder Variables:
      • value; string; The value used to search for business entities.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. 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
  • 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

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • Address1; string; The first line of the entity address.
    • Address2; string; The second line of the entity address.
    • Address3; string; The third line of the entity address.
    • Address4; string; The fourth line of the entity address.
    • BusDisadvOwnedFlag; string; Indicates whether the business entity is disadvantaged owned.
    • BusEnabledFlag; string; Indicates whether the business entity is enabled.
    • BusExemptFlag; string; Indicates whether the business entity has an exemption.
    • BusExemptPct; integer; Business entity exemption percentage.
    • BusExemptType; string; Identifies the type of exemption for the business entity.
    • BusHideInfoFlag; string; The business to show or hide the information to public users.
    • BusInactiveReason; string; Indicates the reason the business entity was inactivated.
    • BusOwnershipType; string; Business entity ownership type.
    • BusPartyId; integer; Business entity party ID.
    • BusStatus; string; The current status of the business entity.
    • BusStatusMeaning; string; The current status meaning of the business entity.
    • BusVeteranOwnedFlag; string; Indicates whether the business entity is owned by a military veteran.
    • BusinessEntityId; string; The unique identifier for a business entity.
    • BusinessEntityKey; integer; System generated unique identifier for a business entity.
    • City; string; Business entity city.
    • ContactAccess; string; The contact has full access for a particular business entity or not.
    • Country; string; Business entity country.
    • County; string; Business entity county.
    • FiscalYearendDay; integer; Fiscal year end day.
    • FiscalYearendMonth; string; Fiscal year end month.
    • JgzzFiscalCode; 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.
    • LegalStatus; string; Business entity legal status.
    • MinorityOwnedInd; string; Indicates whether the business entity is minority owned.
    • OrganizationName; string; The name of the business entity.
    • PostalCode; string; Business entity postal code.
    • PostalPlus4Code; string; Business entity postal plus 4 code.
    • Province; string; Business entity province.
    • SmallBusInd; string; Indicates whether the entity is a small business.
    • State; string; Business entity state.
    • WomanOwnedInd; string; Indicates whether the business entity is woman owned.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorBusinessEntityListDetails
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorBusinessEntityListDetails-item-response
Type: object
Show Source
Nested Schema : Business Location List Details
Type: array
Title: Business Location List Details
The 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: array
Title: Business Owner List Details
The 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-response
Type: object
Show Source
Nested Schema : publicSectorBusinessEntityListDetails-BusOwnersLists-item-response
Type: object
Show Source
Back to Top