Get all business owners
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessOwner
Request
Path Parameters
-
BusinessEntityKey: integer
System-generated identifier for a business entity.
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 owners that match the primary key criteria specified. Finder Variables:
- ReferenceKey; integer; System-generated unique identifier for an owner.
- PrimaryKey: Finds the business owners 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-BusinessOwner
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 : publicSectorBusinessRegistrations-BusinessOwner-item
Type:
Show Source
object
-
AddressFour(optional):
string
Fourth line of the physical address.
-
AddressOne(optional):
string
Maximum Length:
255
First line of the physical address. -
AddressThree(optional):
string
Third line of the physical address.
-
AddressTwo(optional):
string
Second line of the physical address.
-
BePersonId(optional):
string
Maximum Length:
200
Unique identifier of the business owner. -
BePersonLengthAtAddress(optional):
integer(int64)
The number of years the owner has resided at the location.
-
BusContactDmvLicExp(optional):
string(date)
Contact DMV expiry date.
-
BusContactDmvLicNum(optional):
string
Maximum Length:
30
Contact DMV license number. -
BusContactDmvLicSt(optional):
string
Maximum Length:
60
Contact DMV license state. -
BusinessEntityId(optional):
string
Maximum Length:
50
The unique identifier for a business entity. -
BusinessEntityKey(optional):
integer(int64)
System-generated identifier for a business entity.
-
City(optional):
string
Physical address city.
-
Country(optional):
string
Physical address country.
-
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:
32
The login identifier of the person who last updated the business owner. -
links(optional):
array Items
Title:
Items
Link Relations -
MailingAddressFour(optional):
string
Fourth line of the location mailing address.
-
MailingAddressId(optional):
string
The unique identifier for the mailing address.
-
MailingAddressOne(optional):
string
First line of the location mailing address.
-
MailingAddressThree(optional):
string
Third line of the location mailing address.
-
MailingAddressTwo(optional):
string
Second line of the location 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.
-
MailingPostalPlusCode(optional):
string
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.
-
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.
-
PostalPlusCode(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.
-
RelationShipToBusiness(optional):
string
The owner's relationship to the business.
-
SameAsApplicantFlag(optional):
string
Maximum Length:
1
Indicates the mailing address is the same as the applicant's. -
SameMailAddressFlag(optional):
string
Maximum Length:
1
Indicates that the mailing address is the same as the physical address. -
State(optional):
string
Physical address state.
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.