Get all business owners
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists/{LnpRecordKey}/child/BusinessOwner
Request
Path Parameters
-
LnpRecordKey(required): integer(int64)
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 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 -
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 specified primary key criteria.
Finder Variables:- LnpBusinessOwnersKey; integer; The unique identifier for a business owner.
- PrimaryKey: Finds a business owner by the specified primary key criteria.
-
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.
-
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 -
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 fields. 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- Address1; string; The address portion of the person???s address.
- Address2; string; The address portion of the person???s address.
- Address3; string; The address portion of the person???s address.
- Address4; string; The address portion of the person???s address.
- AgencyId; integer; The identifier of the agency.
- BePersonId; string; Meaningful identifier of a responsible person for the business.
- BePersonKey; integer; The unique identifier of a responsible person for the business.
- BusinessEntityId; string; Meaningful identifier for business location.
- BusinessEntityKey; integer; The unique identifier for the business entity.
- BusinessLocationId; string; Meaningful identifier for business location.
- BusinessLocationKey; integer; The unique identifier for business location.
- CitizenshipStatus; string; The citizenship status of an owner.
- City; string; The city portion of the person???s address.
- ContactDmvLicExp; string; The responsible person???s driver???s license expiration date.
- ContactDmvLicNum; string; The responsible person???s driver???s license number.
- ContactDmvLicSt; string; The responsible person???s driver???s license issued state.
- Country; string; The address portion of the person???s address.
- County; string; The county portion of the person???s address.
- DateOfBirth; string; The responsible person???s date of birth.
- EmailAddress; string; The responsible person???s email address.
- EmergencyContactFlag; boolean; Indicates if an emergency contact phone exists.
- LnpBusinessOwnersKey; integer; The unique identifier for the transaction business owners.
- LnpBusinessOwnersPuid; string; The unique identifier of the migrated business owner record.
- LnpRecordId; string; Meaningful identifier for the transaction.
- LnpRecordKey; integer; The unique identifier for the transaction.
- MailingAddress1; string; The address portion of the person???s address.
- MailingAddress2; string; The address portion of the person???s address.
- MailingAddress3; string; The address portion of the person???s address.
- MailingAddress4; string; The address portion of the person???s address.
- MailingCity; string; The city portion of the person???s address.
- MailingCountry; string; The country portion of the person???s address.
- MailingCounty; string; The county portion of the person???s address.
- MailingPostalCode; string; The postal code portion of the person???s address.
- MailingPostalPlusFourCode; string; The postal4 code portion of the person???s address.
- MailingProvince; string; The province portion of the person???s address.
- MailingState; string; The state portion of the person???s address.
- OwnershipPct; number; The person???s ownership percentage.
- PartyId; integer; The unique identifier of a responsible person for the business.
- PersonFirstName; string; The first name of the responsible person.
- PersonLastName; string; The last name of the responsible person.
- PersonLengthAtAddress; integer; The length of time the person has been at the address.
- PersonMiddleName; string; The middle name of the responsible person.
- PersonName; string; Full concatenated name including first, middle, last, and suffix names.
- PersonNameSuffix; string; The name suffix of the responsible person.
- PersonPreNameAdjunct; string; The salutation for the responsible person.
- PersonTitle; string; The title for the responsible person.
- PhoneAreaCode; string; The contact's phone area code within a country.
- PhoneCountryCode; string; The international country code for a contact's telephone number.
- PhoneExtension; string; The person???s additional extension number after initial connection to an internal telephone system.
- PhoneNumber; string; The phone number of the user's contact.
- PhoneType; string; The type of phone for the responsible person.
- PostalCode; string; The postal code portion of the person???s address.
- PostalPlus4Code; string; The postal4 code portion of the person???s address.
- Province; string; The province portion of the person???s address.
- RawPhoneNumber; string; The responsible person???s full phone number.
- RecordNumber; string; The record number of the business owner.
- ReferencePuid; string; The unique identifier of the migrated business owner setup record.
- SameAsApplicantFlag; boolean; Indicates that the owners address is the same as the applicant???s address.
- SameMailAddressFlag; boolean; Indicates that the mailing address is the same as the primary address.
- State; string; The state portion of the person???s address.
- Status; string; The status of responsible person for the business.
- VerificationDate; string; The date the responsible person was verified.
- VerificationStatus; string; The verification status for the responsible person.
- VerifiedBy; string; The agency staff that verified the responsible person.
-
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".
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 : publicSectorRecordLists-BusinessOwner
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordLists-BusinessOwner-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address 1
Maximum Length:240
The address portion of the person???s address. -
Address2: string
Title:
Address 2
Maximum Length:240
The address portion of the person???s address. -
Address3: string
Title:
Address 3
Maximum Length:240
The address portion of the person???s address. -
Address4: string
Title:
Address 4
Maximum Length:240
The address portion of the person???s address. -
AgencyId: integer
(int32)
Default Value:
1
The identifier of the agency. -
BePersonId: string
Maximum Length:
200
Meaningful identifier of a responsible person for the business. -
BePersonKey: integer
(int64)
The unique identifier of a responsible person for the business.
-
BusinessEntityId: string
Title:
Business ID
Maximum Length:50
Meaningful identifier for business location. -
BusinessEntityKey: integer
(int64)
The unique identifier for the business entity.
-
BusinessLocationId: string
Maximum Length:
50
Meaningful identifier for business location. -
BusinessLocationKey: integer
(int64)
The unique identifier for business location.
-
CitizenshipStatus: string
Title:
Citizenship Status
Maximum Length:30
The citizenship status of an owner. -
City: string
Title:
City
Maximum Length:60
The city portion of the person???s address. -
ContactAccess: string
Maximum Length:
80
Access rights provided to the contact owner. -
ContactDmvLicExp: string
(date)
Title:
Expiration Date
The responsible person???s driver???s license expiration date. -
ContactDmvLicNum: string
Title:
Driver's License
Maximum Length:30
The responsible person???s driver???s license number. -
ContactDmvLicSt: string
Title:
Issuing State
Maximum Length:60
The responsible person???s driver???s license issued state. -
ContactPrimaryFlag: boolean
Maximum Length:
80
The unique identifier for the primary contact owner. -
ContactType: string
Maximum Length:
80
The type of the contact owner. -
Country: string
Title:
Country
Maximum Length:3
The address portion of the person???s address. -
County: string
Title:
County
Maximum Length:60
The county portion of the person???s address. -
DateOfBirth: string
(date)
Title:
Date of Birth
The responsible person???s date of birth. -
EmailAddress: string
Title:
Email
Maximum Length:320
The responsible person???s email address. -
EmergencyContactFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if an emergency contact phone exists. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpBusinessOwnersKey: integer
(int64)
The unique identifier for the transaction business owners.
-
LnpBusinessOwnersPuid: string
Maximum Length:
480
The unique identifier of the migrated business owner record. -
LnpRecordId: string
Maximum Length:
50
Meaningful identifier for the transaction. -
LnpRecordKey: integer
(int64)
The unique identifier for the transaction.
-
MailingAddress1: string
Title:
Address 1
Maximum Length:240
The address portion of the person???s address. -
MailingAddress2: string
Title:
Address 2
Maximum Length:240
The address portion of the person???s address. -
MailingAddress3: string
Title:
Address 3
Maximum Length:240
The address portion of the person???s address. -
MailingAddress4: string
Title:
Address 4
Maximum Length:240
The address portion of the person???s address. -
MailingCity: string
Title:
City
Maximum Length:60
The city portion of the person???s address. -
MailingCountry: string
Title:
Country
Maximum Length:3
The country portion of the person???s address. -
MailingCounty: string
Title:
County
Maximum Length:60
The county portion of the person???s address. -
MailingPostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code portion of the person???s address. -
MailingPostalPlusFourCode: string
Title:
Postal Plus 4 Code
Maximum Length:10
The postal4 code portion of the person???s address. -
MailingProvince: string
Title:
Province
Maximum Length:60
The province portion of the person???s address. -
MailingState: string
Title:
State
Maximum Length:60
The state portion of the person???s address. -
OwnershipPct: number
Title:
Ownership Percentage
The person???s ownership percentage. -
PartyId: integer
(int64)
The unique identifier of a responsible person for the business.
-
PersonFirstName: string
Title:
First Name
Maximum Length:150
The first name of the responsible person. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The last name of the responsible person. -
PersonLengthAtAddress: integer
(int64)
Title:
Years at This Location
The length of time the person has been at the address. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the responsible person. -
PersonName: string
Title:
Name
Maximum Length:450
Full concatenated name including first, middle, last, and suffix names. -
PersonNameSuffix: string
Title:
Suffix
Maximum Length:30
The name suffix of the responsible person. -
PersonPreNameAdjunct: string
Title:
Salutation
Maximum Length:30
The salutation for the responsible person. -
PersonTitle: string
Title:
Title
Maximum Length:60
The title for the responsible person. -
PhoneAreaCode: string
Maximum Length:
10
The contact's phone area code within a country. -
PhoneCountryCode: string
Maximum Length:
10
The international country code for a contact's telephone number. -
PhoneExtension: string
Maximum Length:
20
The person???s additional extension number after initial connection to an internal telephone system. -
PhoneNumber: string
Maximum Length:
40
The phone number of the user's contact. -
PhoneType: string
Title:
Phone Type
Maximum Length:30
The type of phone for the responsible person. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code portion of the person???s address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:10
The postal4 code portion of the person???s address. -
Province: string
Title:
Province
Maximum Length:60
The province portion of the person???s address. -
RawPhoneNumber: string
Maximum Length:
60
The responsible person???s full phone number. -
RecordNumber: string
Maximum Length:
64
The record number of the business owner. -
ReferencePuid: string
Maximum Length:
480
The unique identifier of the migrated business owner setup record. -
SameAsApplicantFlag: boolean
Title:
Is the applicant an owner or a corporate officer?
Maximum Length:1
Default Value:false
Indicates that the owners address is the same as the applicant???s address. -
SameMailAddressFlag: boolean
Title:
Is the mailing address the same as the physical address?
Maximum Length:1
Default Value:false
Indicates that the mailing address is the same as the primary address. -
State: string
Title:
State
Maximum Length:60
The state portion of the person???s address. -
Status: string
Title:
Status
Maximum Length:30
The status of responsible person for the business. -
VerificationDate: string
(date)
The date the responsible person was verified.
-
VerificationStatus: string
Maximum Length:
30
The verification status for the responsible person. -
VerifiedBy: string
Maximum Length:
200
The agency staff that 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.