Get all owners
get
/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BusinessOwner
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 owner by the primary key criteria. Finder Variables:
- LnpBusinessOwnersKey; integer; The unique identifier for a business owner.
- PrimaryKey: Finds a business owner by the 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 : publicSectorBlRecords-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 : publicSectorBlRecords-BusinessOwner-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
The address portion of the person's address. -
Address2(optional):
string
Maximum Length:
240
The address portion of the person's address. -
Address3(optional):
string
Maximum Length:
240
The address portion of the person's address. -
Address4(optional):
string
Maximum Length:
240
The address portion of the person's address. -
BePersonId(optional):
string
Maximum Length:
200
The identifier of a responsible person for the business. -
BePersonKey(optional):
integer(int64)
The unique identifier of a responsible person for the business.
-
BusinessEntityId(optional):
string
Maximum Length:
50
The identifier for business location. -
BusinessEntityKey(optional):
integer(int64)
The unique identifier for the business entity.
-
BusinessLocationId(optional):
string
Maximum Length:
50
The identifier for business location. -
BusinessLocationKey(optional):
integer(int64)
The unique identifier for business location.
-
City(optional):
string
Maximum Length:
60
The city portion of the person's address. -
ContactDmvLicExp(optional):
string(date)
The responsible person's driver's license expiration date.
-
ContactDmvLicNum(optional):
string
Maximum Length:
30
The responsible person's driver's license number. -
ContactDmvLicSt(optional):
string
Maximum Length:
60
The responsible person's driver's license issued state. -
Country(optional):
string
Maximum Length:
3
The country portion of the person's address. -
County(optional):
string
Maximum Length:
60
The county portion of the person's address. -
DateOfBirth(optional):
string(date)
The responsible person's date of birth.
-
EmailAddress(optional):
string
Maximum Length:
320
The responsible person's email address. -
EmergencyContactFlag(optional):
string
Maximum Length:
1
Indicates if an emergency contact phone exists. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpBusinessOwnersKey(optional):
integer(int64)
The unique identifier for the transaction business owners.
-
LnpRecordId(optional):
string
Maximum Length:
50
The identifier for the transaction. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for the transaction.
-
MailingAddress1(optional):
string
Maximum Length:
240
The address portion of the person's address. -
MailingAddress2(optional):
string
Maximum Length:
240
The address portion of the person's address. -
MailingAddress3(optional):
string
Maximum Length:
240
The address portion of the person's address. -
MailingAddress4(optional):
string
Maximum Length:
240
The address portion of the person's address. -
MailingAddressId(optional):
integer(int64)
The reference key to the TCA location table.
-
MailingCity(optional):
string
Maximum Length:
60
The city portion of the person's address. -
MailingCountry(optional):
string
Maximum Length:
3
The address portion of the person's address. -
MailingCounty(optional):
string
Maximum Length:
60
The county portion of the person's address. -
MailingPostalCode(optional):
string
Maximum Length:
60
The postal code portion of the person's address. -
MailingPostalPlusFourCode(optional):
string
Maximum Length:
10
The postal4 code portion of the person's address. -
MailingProvince(optional):
string
Maximum Length:
60
The province portion of the person's address. -
MailingState(optional):
string
Maximum Length:
60
The state portion of the person's address. -
OwnerAddressId(optional):
integer(int64)
The reference key to the TCA location table.
-
OwnershipPct(optional):
number
The person's ownership percentage.
-
PartyId(optional):
integer(int64)
The unique identifier of a responsible person for the business.
-
PersonFirstName(optional):
string
Maximum Length:
150
The first name of the responsible person. -
PersonLastName(optional):
string
Maximum Length:
150
The last name of the responsible person. -
PersonLengthAtAddress(optional):
integer(int64)
The length of time the person has been at the address.
-
PersonMiddleName(optional):
string
Maximum Length:
60
The middle name of the responsible person. -
PersonName(optional):
string
Maximum Length:
450
The full concatenated name including the first, middle, last, and suffix names. -
PersonNameSuffix(optional):
string
Maximum Length:
30
The name suffix of the responsible person. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30
The salutation for the responsible person. -
PersonTitle(optional):
string
Maximum Length:
60
The title for the responsible person. -
PhoneAreaCode(optional):
string
Maximum Length:
10
The contact's phone area code within a country. -
PhoneCountryCode(optional):
string
Maximum Length:
10
The international country code for a contact's telephone number. -
PhoneExtension(optional):
string
Maximum Length:
20
The person's additional extension number after initial connection to an internal telephone system. -
PhoneNumber(optional):
string
Maximum Length:
40
The phone number of the user's contact. -
PhoneType(optional):
string
Maximum Length:
30
The type of phone for the responsible person. -
PostalCode(optional):
string
Maximum Length:
60
The postal code portion of the person's address. -
PostalPlus4Code(optional):
string
Maximum Length:
10
The postal4 code portion of the person's address. -
Province(optional):
string
Maximum Length:
60
The province portion of the person's address. -
RawPhoneNumber(optional):
string
Maximum Length:
60
The responsible person's full phone number. -
SameAsApplicantFlag(optional):
boolean
Indicates that the mailing address is the same as the primary address. Default value is N.
-
SameMailAddressFlag(optional):
boolean
Indicates that the mailing address is the same as the primary address.
-
State(optional):
string
Maximum Length:
60
The state portion of the person's address. -
Status(optional):
string
Maximum Length:
30
The status of responsible person for the business. -
VerificationDate(optional):
string(date)
The date the responsible person was verified.
-
VerificationStatus(optional):
string
Maximum Length:
30
The verification status for the responsible person. -
VerifiedBy(optional):
string
Maximum Length:
200
The agency staff that verified the responsible person.
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.