Get a business owner
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessOwner/{ReferenceKey}
Request
Path Parameters
-
BusinessEntityKey(required): integer(int64)
System-generated identifier for a business entity.
-
ReferenceKey(required): integer(int64)
System-generated unique identifier for an owner.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
Root Schema : publicSectorBusinessRegistrations-BusinessOwner-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address 1
Maximum Length:240
First line of the physical address. -
Address2: string
Title:
Address 2
Maximum Length:240
Second line of the physical address. -
Address3: string
Title:
Address 3
Maximum Length:240
Third line of the physical address. -
Address4: string
Title:
Address 4
Maximum Length:240
Fourth line of the physical address. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifer for the agency. -
BePersonId: string
Maximum Length:
200
Unique identifier of the business owner. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for a business entity. -
BusinessEntityKey: integer
(int64)
System-generated identifier for a business entity.
-
CitizenshipStatus: string
Title:
Citizenship Status
Maximum Length:30
The attribute used to identify the citizenship status of a owner. -
City: string
Title:
City
Maximum Length:60
Physical address city. -
ContactDmvLicExp: string
(date)
The contact DMV license expiration date.
-
ContactDmvLicNum: string
Maximum Length:
30
The contact DMV license number. -
ContactDmvLicSt: string
Maximum Length:
60
The contact DMV license state. -
ContactType: string
Maximum Length:
30
The contact type of the owner. -
Country: string
Title:
Country
Maximum Length:2
Physical address country. -
County: string
Maximum Length:
60
The physical address of the county. -
CreationDate: string
(date-time)
Read Only:
true
The date that the business owner was created. -
DateOfBirth: string
(date)
The business owner's date of birth.
-
EmailAddress: string
Title:
Email
Maximum Length:320
Email address of the business owner. -
EmergencyContactFlag: string
Indicates whether the owner is an emergency contact.
-
EmergencyContactPhone: string
Title:
Emergency Contact Phone
The phone number of the emergency contact. -
EntityAccess: string
Maximum Length:
3
The entity access of the owner. -
EntityPartyId: integer
(int64)
The entity party identifier of the owner.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the business owner was last updated. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login identifier of the person who last updated the business owner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MailingAddress1: string
Title:
Mailing Address Line 1
Maximum Length:240
First line of the location owner mailing address. -
MailingAddress2: string
Title:
Mailing Address Line 2
Maximum Length:240
Second line of the location mailing address. -
MailingAddress3: string
Maximum Length:
240
Third line of the location mailing address. -
MailingAddress4: string
Maximum Length:
240
Fourth line of the location owner mailing address. -
MailingAddressId: string
The unique identifier for the mailing address.
-
MailingCity: string
Title:
Mailing City
Maximum Length:60
Mailing address city. -
MailingCountry: string
Title:
Mailing Country
Maximum Length:2
Mailing address country. -
MailingCounty: string
Title:
Mailing County
Maximum Length:60
Mailing address county. -
MailingPostalCode: string
Title:
Mailing Postal Code
Maximum Length:60
Mailing address postal code. -
MailingPostalPlusFourCode: string
Maximum Length:
20
Location mailing postal plus 4 code. -
MailingProvince: string
Title:
Mailing Province
Maximum Length:60
Mailing address province. -
MailingState: string
Title:
Mailing State
Maximum Length:60
Mailing address state. -
ObjectVersionNumber: integer
(int32)
Workflow project revision number used to define the workflow.
-
OwnerProfileId: integer
(int64)
The owner profile identifier of the owner.
-
OwnershipPct: number
The person's percentage of ownership in the business.
-
PersonFirstName: string
Title:
First Name
Maximum Length:150
First name of the business owner. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
Last name of the business owner. -
PersonLengthAtAddress: integer
(int64)
The length of time that the person has been at this address.
-
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
Middle name of the business owner. -
PersonNameSuffix: string
Maximum Length:
30
The name suffix of the business owner. -
PersonPreNameAdjunct: string
Maximum Length:
60
Person's pre name adjunct. -
PersonTitle: string
Maximum Length:
100
The title of the business owner. -
PersonType: string
The person type for the business owner.
-
PhoneAreaCode: string
Maximum Length:
20
Phone number area code. -
PhoneCountryCode: string
Maximum Length:
10
Phone number country code. -
PhoneExtension: string
Maximum Length:
20
Phone extension number. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
Phone number. -
PhoneType: string
Title:
Phone Type
Maximum Length:30
Phone type. -
PostalCode: string
Maximum Length:
60
Physical address postal code. -
PostalPlus4Code: string
Maximum Length:
20
Physical address postal plus 4 code. -
Province: string
Title:
Province
Maximum Length:60
Physical address province. -
RawPhoneNumber: string
Maximum Length:
60
Raw phone number. -
ReferenceKey: integer
(int64)
System-generated unique identifier for an owner.
-
ReferencePartyId: integer
(int64)
Unique identifier for the reference party.
-
ReferencePuid: string
Maximum Length:
50
System-generated reference key PUID. -
RelationShipToBusiness: string
The owner's relationship to the business.
-
SameAsApplicantFlag: string
Maximum Length:
1
Indicates the mailing address is the same as the applicant's. -
SameMailAddressFlag: string
Maximum Length:
1
Indicates that the mailing address is the same as the physical address. -
State: string
Title:
State
Maximum Length:60
Physical address state. -
Status: string
Maximum Length:
30
Current status of the location. -
VerificationDate: string
(date)
The date that the responsible person was verified.
-
VerificationStatus: string
Maximum Length:
30
The verification status for the responsible person. -
VerifiedBy: string
Maximum Length:
30
Identifies who verified the responsible person.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.