Get all business owners
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessOwnerListDetails
Request
Query Parameters
-
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 the business owners that matches the primary key criteria specified.
Finder Variables:- ReferenceKey; integer; System generated unique identifier for an owner.
- simpleSearchFinder: Finds the business owners that matches the search criteria specified.
Finder Variables:- value; string; The value used to search for business owners.
- PrimaryKey: Finds the business owners that matches the primary key criteria specified.
-
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; First line of the physical address.
- Address2; string; Second line of the physical address.
- Address3; string; Third line of the physical address.
- Address4; string; Fourth line of the physical address.
- AgencyId; integer; Unique identifier for the agency.
- BePersonId; string; Meaningful identifier of a responsible person for the business.
- BePersonLengthAtAddress; integer; The length of time that the person has been at this address.
- BusContactDmvLicExp; string; Contact DMV expiry date.
- BusContactDmvLicNum; string; Contact DMV license number.
- BusContactDmvLicSt; string; Contact DMV license state.
- BusinessEntityId; string; The unique identifier for a business entity.
- BusinessEntityKey; integer; System generated unique identifier for a business entity.
- CitizenshipStatus; string; The attribute used to identify the citizenship status of a owner.
- City; string; Physical address city.
- Country; string; Physical address country.
- County; string; Physical address county.
- DateOfBirth; string; Date of birth of the person.
- EmailAddress; string; Email address of the person.
- EntityPartyId; integer; Business entity party ID.
- JobTitle; string; Person title.
- MailingAddress1; string; First line of the location mailing address.
- MailingAddress2; string; Second line of the location mailing address.
- MailingAddress3; string; Third line of the location mailing address.
- MailingAddress4; string; Fourth line of the location mailing address.
- MailingCity; string; Mailing address city.
- MailingCountry; string; Mailing address country.
- MailingCounty; string; Mailing address county.
- MailingPostalCode; string; Mailing address postal code.
- MailingPostalPlusCode; string; Mailing address postal plus 4 code.
- MailingProvince; string; Mailing address province.
- MailingState; string; Mailing address state.
- OwnerPartyId; integer; The unique identifier for an owner.
- PercentageOwnership; number; Indicates a person's percentage of ownership in the business.
- PersonFirstName; string; First name of the person.
- PersonLastName; string; Last name of the person.
- PersonMiddleName; string; Middle name of the person.
- PersonName; string; Name of the person.
- PersonNameSuffix; string; Person name suffix.
- PhoneAreaCode; string; Area code.
- PhoneCountryCode; string; Country code.
- PhoneExtension; string; Phone extension number.
- PhoneNumber; string; Phone number.
- PhoneType; string; Phone type.
- PostalCode; string; Physical address postal code.
- PostalPlus4Code; string; Physical address postal plus 4 code.
- Province; string; Physical address province.
- RawPhoneNumber; string; Raw phone number.
- ReferenceKey; integer; System generated unique identifier for an owner.
- ReferencePuid; string; System-generated reference key PUID.
- Salutation; string; Persons prename adjunct.
- SameAsApplicantFlag; string; Indicates whether the contact information is the same as the applicant's.
- SameMailAddressFlag; string; Indicates whether the physical address is the same as the mailing address.
- State; string; Physical address state.
- Status; string; Current status of the owner.
- StatusMeaning; string; The meaning of the owner's current status.
- VerificationDate; string; The date that the responsible person was verified.
- VerificationStatus; string; The verification status for the responsible person.
- VerifiedBy; string; Identifies who 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 : publicSectorBusinessOwnerListDetails
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 : publicSectorBusinessOwnerListDetails-item-response
Type:
Show Source
object
-
Address1: string
Title:
Address 1
Read Only:true
Maximum Length:240
First line of the physical address. -
Address2: string
Title:
Address 2
Read Only:true
Maximum Length:240
Second line of the physical address. -
Address3: string
Title:
Address 3
Read Only:true
Maximum Length:240
Third line of the physical address. -
Address4: string
Title:
Address 4
Read Only:true
Maximum Length:240
Fourth line of the physical address. -
AgencyId: integer
(int32)
Read Only:
true
Unique identifier for the agency. -
BePersonId: string
Read Only:
true
Maximum Length:200
Meaningful identifier of a responsible person for the business. -
BePersonLengthAtAddress: integer
(int64)
Read Only:
true
The length of time that the person has been at this address. -
BusContactDmvLicExp: string
(date)
Title:
Expiration Date
Read Only:true
Contact DMV expiry date. -
BusContactDmvLicNum: string
Title:
Driver's License
Read Only:true
Maximum Length:30
Contact DMV license number. -
BusContactDmvLicSt: string
Title:
Issuing State
Read Only:true
Maximum Length:60
Contact DMV license state. -
BusinessEntityId: string
Title:
Business
Read Only:true
Maximum Length:50
The unique identifier for a business entity. -
BusinessEntityKey: integer
(int64)
Read Only:
true
System generated unique identifier for a business entity. -
CitizenshipStatus: string
Title:
Citizenship Status
Read Only:true
Maximum Length:30
The attribute used to identify the citizenship status of a owner. -
City: string
Title:
City
Read Only:true
Maximum Length:60
Physical address city. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
Physical address country. -
County: string
Read Only:
true
Maximum Length:60
Physical address county. -
DateOfBirth: string
(date)
Title:
Date of Birth
Read Only:true
Date of birth of the person. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
Email address of the person. -
EntityPartyId: integer
(int64)
Read Only:
true
Business entity party ID. -
JobTitle: string
Title:
Title
Read Only:true
Maximum Length:100
Person title. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MailingAddress1: string
Read Only:
true
Maximum Length:240
First line of the location mailing address. -
MailingAddress2: string
Read Only:
true
Maximum Length:240
Second line of the location mailing address. -
MailingAddress3: string
Read Only:
true
Maximum Length:240
Third line of the location mailing address. -
MailingAddress4: string
Read Only:
true
Maximum Length:240
Fourth line of the location mailing address. -
MailingCity: string
Read Only:
true
Maximum Length:60
Mailing address city. -
MailingCountry: string
Read Only:
true
Maximum Length:2
Mailing address country. -
MailingCounty: string
Read Only:
true
Maximum Length:60
Mailing address county. -
MailingPostalCode: string
Read Only:
true
Maximum Length:60
Mailing address postal code. -
MailingPostalPlusCode: string
Read Only:
true
Maximum Length:20
Mailing address postal plus 4 code. -
MailingProvince: string
Read Only:
true
Maximum Length:60
Mailing address province. -
MailingState: string
Read Only:
true
Maximum Length:60
Mailing address state. -
OwnerPartyId: integer
Read Only:
true
The unique identifier for an owner. -
PercentageOwnership: number
Title:
Ownership Percentage
Read Only:true
Indicates a person's percentage of ownership in the business. -
PersonFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
First name of the person. -
PersonLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
Last name of the person. -
PersonMiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
Middle name of the person. -
PersonName: string
Read Only:
true
Maximum Length:450
Name of the person. -
PersonNameSuffix: string
Title:
Suffix
Read Only:true
Maximum Length:30
Person name suffix. -
PhoneAreaCode: string
Read Only:
true
Maximum Length:20
Area code. -
PhoneCountryCode: string
Read Only:
true
Maximum Length:10
Country code. -
PhoneExtension: string
Read Only:
true
Maximum Length:20
Phone extension number. -
PhoneNumber: string
Read Only:
true
Maximum Length:40
Phone number. -
PhoneType: string
Title:
Phone Type
Read Only:true
Maximum Length:30
Phone type. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
Physical address postal code. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:20
Physical address postal plus 4 code. -
Province: string
Title:
Province
Read Only:true
Maximum Length:60
Physical address province. -
RawPhoneNumber: string
Read Only:
true
Maximum Length:60
Raw phone number. -
ReferenceKey: integer
(int64)
Read Only:
true
System generated unique identifier for an owner. -
ReferencePuid: string
Read Only:
true
Maximum Length:50
System-generated reference key PUID. -
Salutation: string
Title:
Salutation
Read Only:true
Maximum Length:60
Persons prename adjunct. -
SameAsApplicantFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the contact information is the same as the applicant's. -
SameMailAddressFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the physical address is the same as the mailing address. -
State: string
Title:
State
Read Only:true
Maximum Length:60
Physical address state. -
Status: string
Read Only:
true
Maximum Length:30
Current status of the owner. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the owner's current status. -
VerificationDate: string
(date)
Read Only:
true
The date that the responsible person was verified. -
VerificationStatus: string
Read Only:
true
Maximum Length:30
The verification status for the responsible person. -
VerifiedBy: string
Read Only:
true
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.