Update a business owner
patch
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessOwner/{ReferenceKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
BusinessEntityKey: integer
System-generated identifier for a business entity.
-
ReferenceKey: integer
System-generated unique identifier for an owner.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorBusinessRegistrations-BusinessOwner-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
255
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.
-
AgencyId(optional):
integer(int32)
Unique identifer for the agency.
-
BePersonId(optional):
string
Maximum Length:
200
Unique identifier of the business owner. -
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.
-
ContactDmvLicExp(optional):
string(date)
The contact DMV license expiration date.
-
ContactDmvLicNum(optional):
string
Maximum Length:
30
The contact DMV license number. -
ContactDmvLicSt(optional):
string
Maximum Length:
60
The 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:
32
The login identifier of the person who last updated the business owner. -
links(optional):
array Items
Title:
Items
Link 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:
50
System-generated reference key PUID. -
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.
-
Status(optional):
string
Maximum Length:
30
Current status of the location. -
VerificationDate(optional):
string(date)
The date that the responsible person was verified.
-
VerificationStatus(optional):
string
Maximum Length:
30
The verification status for the responsible person. -
VerifiedBy(optional):
string
Maximum Length:
30
Identifies who 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.
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 : publicSectorBusinessRegistrations-BusinessOwner-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
255
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.
-
AgencyId(optional):
integer(int32)
Unique identifer for the agency.
-
BePersonId(optional):
string
Maximum Length:
200
Unique identifier of the business owner. -
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.
-
ContactDmvLicExp(optional):
string(date)
The contact DMV license expiration date.
-
ContactDmvLicNum(optional):
string
Maximum Length:
30
The contact DMV license number. -
ContactDmvLicSt(optional):
string
Maximum Length:
60
The 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:
32
The login identifier of the person who last updated the business owner. -
links(optional):
array Items
Title:
Items
Link 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:
50
System-generated reference key PUID. -
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.
-
Status(optional):
string
Maximum Length:
30
Current status of the location. -
VerificationDate(optional):
string(date)
The date that the responsible person was verified.
-
VerificationStatus(optional):
string
Maximum Length:
30
The verification status for the responsible person. -
VerifiedBy(optional):
string
Maximum Length:
30
Identifies who 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.