Get a business owner
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails/{publicSectorBusinessEntityListDetailsUniqID}/child/BusOwnersLists/{BusOwnersListsUniqID}
Request
Path Parameters
-
BusOwnersListsUniqID: integer
This is the hash key of the attributes which make up the composite key--- ReferenceKey and OwnerPartyId ---for the Business Owner List Details resource and used to uniquely identify an instance of Business Owner List Details. The client should not generate the hash key value. Instead, the client should query on the Business Owner List Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Business Owner List Details.
For example: BusOwnersLists?q=ReferenceKey=<value1>;OwnerPartyId=<value2> -
publicSectorBusinessEntityListDetailsUniqID: integer
This is the hash key of the attributes which make up the composite key--- BusinessEntityKey and BusinessEntityId ---for the Business Entity List Details resource and used to uniquely identify an instance of Business Entity List Details. The client should not generate the hash key value. Instead, the client should query on the Business Entity List Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Business Entity List Details.
For example: publicSectorBusinessEntityListDetails?q=BusinessEntityKey=<value1>;BusinessEntityId=<value2>
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root 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.
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.