Jump to

• Request
• Response

Get a business owner

get

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails/{BusinessEntityKey}/child/BusOwnersLists/{ReferenceKey}

Request

Path Parameters

• BusinessEntityKey(required): integer(int64)
  System generated unique 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 Top

Response

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.

Body ()

Root Schema : publicSectorBusinessEntityListDetails-BusOwnersLists-item-response

Type: object

Show Source

• 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 citizenship status of an 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 party.
• 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

  The unique identifier for an owner.
• Salutation: string
  Title: Salutation

  Read Only: true

  Maximum Length: 60

  Person's prename adjunct.
• SameAsApplicantFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the physical address is the same as the mailing address.
• 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.

{
    "type":"object",
    "properties":{
        "VerificationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The verification status for the responsible person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VerificationDate":{
            "type":"string",
            "description":"The date that the responsible person was verified.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SameMailAddressFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the physical address is the same as the mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"Middle name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityKey":{
            "type":"integer",
            "description":"System generated unique identifier for a business entity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CitizenshipStatus":{
            "title":"Citizenship Status",
            "maxLength":30,
            "type":"string",
            "description":"The citizenship status of an owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"Date of birth of the person.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Current status of the owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingPostalPlusCode":{
            "maxLength":20,
            "type":"string",
            "description":"Mailing address postal plus 4 code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferencePuid":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for an owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PercentageOwnership":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"Indicates a person's percentage of ownership in the business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingCity":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address city.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"Physical address city.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"Physical address province.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"Email address of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"Phone extension number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":20,
            "type":"string",
            "description":"Physical address postal plus 4 code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneType":{
            "title":"Phone Type",
            "maxLength":30,
            "type":"string",
            "description":"Phone type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"Physical address state.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"Physical address country.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VerifiedBy":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies who verified the responsible person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RawPhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Raw phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityId":{
            "title":"Business",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a business entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Unique identifier for the agency.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "SameAsApplicantFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the physical address is the same as the mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingCountry":{
            "maxLength":2,
            "type":"string",
            "description":"Mailing address country.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "title":"Suffix",
            "maxLength":30,
            "type":"string",
            "description":"Person name suffix.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Physical address postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BePersonLengthAtAddress":{
            "type":"integer",
            "description":"The length of time that the person has been at this address.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MailingCounty":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address county.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Title",
            "maxLength":100,
            "type":"string",
            "description":"Person title.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Salutation":{
            "title":"Salutation",
            "maxLength":60,
            "type":"string",
            "description":"Person's prename adjunct.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address county.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingState":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address state.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Country code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":20,
            "type":"string",
            "description":"Area code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityPartyId":{
            "type":"integer",
            "description":"Business entity party ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address 4",
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the physical address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the location mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the location mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusContactDmvLicExp":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Contact DMV expiry date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the location mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the location mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BePersonId":{
            "maxLength":200,
            "type":"string",
            "description":"Meaningful identifier of a responsible person for the business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingProvince":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address province.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceKey":{
            "type":"integer",
            "description":"System generated unique identifier for an owner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonName":{
            "maxLength":450,
            "type":"string",
            "description":"Name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPartyId":{
            "type":"integer",
            "description":"The unique identifier for an owner party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address 2",
            "maxLength":240,
            "type":"string",
            "description":"Second line of the physical address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address 3",
            "maxLength":240,
            "type":"string",
            "description":"Third line of the physical address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address 1",
            "maxLength":240,
            "type":"string",
            "description":"First line of the physical address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the owner's current status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusContactDmvLicNum":{
            "title":"Driver's License",
            "maxLength":30,
            "type":"string",
            "description":"Contact DMV license number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusContactDmvLicSt":{
            "title":"Issuing State",
            "maxLength":60,
            "type":"string",
            "description":"Contact DMV license state.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top