Jump to

• Request
• Response

Update a business owner

patch

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

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.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• Address1: string
  Maximum Length: 240

  First line of the physical address.
• Address2: string
  Maximum Length: 240

  Second line of the physical address.
• Address3: string
  Maximum Length: 240

  Third line of the physical address.
• Address4: string
  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.
• City: string
  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
  Maximum Length: 2

  Physical address country.
• County: string
  Maximum Length: 60

  The physical address of the county.
• DateOfBirth: string (date)
  The business owner's date of birth.
• EmailAddress: string
  Maximum Length: 320

  Email address of the business owner.
• EmergencyContactFlag: string
  Indicates whether the owner is an emergency contact.
• EmergencyContactPhone: string
  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.
• MailingAddress1: string
  Maximum Length: 240

  First line of the location owner mailing address.
• MailingAddress2: string
  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
  Maximum Length: 60

  Mailing address city.
• MailingCountry: string
  Maximum Length: 2

  Mailing address country.
• MailingCounty: string
  Maximum Length: 60

  Mailing address county.
• MailingPostalCode: string
  Maximum Length: 60

  Mailing address postal code.
• MailingPostalPlusFourCode: string
  Maximum Length: 20

  Location mailing postal plus 4 code.
• MailingProvince: string
  Maximum Length: 60

  Mailing address province.
• MailingState: string
  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
  Maximum Length: 150

  First name of the business owner.
• PersonLastName: string
  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
  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
  Maximum Length: 40

  Phone number.
• PhoneType: string
  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
  Maximum Length: 60

  Physical address province.
• RawPhoneNumber: string
  Maximum Length: 60

  Raw phone number.
• 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
  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.

{
    "type":"object",
    "properties":{
        "VerificationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The verification status for the responsible person.",
            "nullable":true
        },
        "VerificationDate":{
            "type":"string",
            "description":"The date that the responsible person was verified.",
            "format":"date",
            "nullable":true
        },
        "ContactType":{
            "maxLength":30,
            "type":"string",
            "description":"The contact type of the owner.",
            "nullable":true
        },
        "SameMailAddressFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the mailing address is the same as the physical address.",
            "nullable":true
        },
        "PersonType":{
            "type":"string",
            "description":"The person type for the business owner.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"Middle name of the business owner.",
            "nullable":true
        },
        "PersonTitle":{
            "maxLength":100,
            "type":"string",
            "description":"The title of the business owner.",
            "nullable":true
        },
        "MailingPostalPlusFourCode":{
            "maxLength":20,
            "type":"string",
            "description":"Location mailing postal plus 4 code.",
            "nullable":true
        },
        "EmergencyContactFlag":{
            "type":"string",
            "description":"Indicates whether the owner is an emergency contact.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactDmvLicSt":{
            "maxLength":60,
            "type":"string",
            "description":"The contact DMV license state.",
            "nullable":true
        },
        "DateOfBirth":{
            "type":"string",
            "description":"The business owner's date of birth.",
            "format":"date",
            "nullable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Current status of the location.",
            "nullable":true
        },
        "EntityAccess":{
            "maxLength":3,
            "type":"string",
            "description":"The entity access of the owner.",
            "nullable":true
        },
        "ReferencePuid":{
            "maxLength":50,
            "type":"string",
            "description":"System-generated reference key PUID.",
            "nullable":true
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"Last name of the business owner.",
            "nullable":true
        },
        "MailingCity":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address city.",
            "nullable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address city.",
            "nullable":true
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"First name of the business owner.",
            "nullable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the business owner.",
            "nullable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address province.",
            "nullable":true
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"Phone extension number.",
            "nullable":true
        },
        "PostalPlus4Code":{
            "maxLength":20,
            "type":"string",
            "description":"Physical address postal plus 4 code.",
            "nullable":true
        },
        "PhoneType":{
            "maxLength":30,
            "type":"string",
            "description":"Phone type.",
            "nullable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address state.",
            "nullable":true
        },
        "Country":{
            "maxLength":2,
            "type":"string",
            "description":"Physical address country.",
            "nullable":true
        },
        "VerifiedBy":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies who verified the responsible person.",
            "nullable":true
        },
        "PersonLengthAtAddress":{
            "type":"integer",
            "description":"The length of time that the person has been at this address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContactDmvLicNum":{
            "maxLength":30,
            "type":"string",
            "description":"The contact DMV license number.",
            "nullable":true
        },
        "RawPhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Raw phone number.",
            "nullable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifer for the agency.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "MailingAddressId":{
            "type":"string",
            "description":"The unique identifier for the mailing address.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnershipPct":{
            "type":"number",
            "description":"The person's percentage of ownership in the business.",
            "nullable":true,
            "x-hints":{
                "precision":10,
                "scale":7
            }
        },
        "MailingCountry":{
            "maxLength":2,
            "type":"string",
            "description":"Mailing address country.",
            "nullable":true
        },
        "SameAsApplicantFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the mailing address is the same as the applicant's.",
            "nullable":true
        },
        "PersonNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"The name suffix of the business owner.",
            "nullable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address postal code.",
            "nullable":true
        },
        "MailingCounty":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address county.",
            "nullable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The physical address of the county.",
            "nullable":true
        },
        "MailingState":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address state.",
            "nullable":true
        },
        "PhoneAreaCode":{
            "maxLength":20,
            "type":"string",
            "description":"Phone number area code.",
            "nullable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Phone number country code.",
            "nullable":true
        },
        "RelationShipToBusiness":{
            "type":"string",
            "description":"The owner's relationship to the business.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactDmvLicExp":{
            "type":"string",
            "description":"The contact DMV license expiration date.",
            "format":"date",
            "nullable":true
        },
        "EntityPartyId":{
            "type":"integer",
            "description":"The entity party identifier of the owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Workflow project revision number used to define the workflow.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the physical address.",
            "nullable":true
        },
        "MailingPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address postal code.",
            "nullable":true
        },
        "MailingAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the location mailing address.",
            "nullable":true
        },
        "MailingAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the location owner mailing address.",
            "nullable":true
        },
        "MailingAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the location owner mailing address.",
            "nullable":true
        },
        "MailingAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the location mailing address.",
            "nullable":true
        },
        "BePersonId":{
            "maxLength":200,
            "type":"string",
            "description":"Unique identifier of the business owner.",
            "nullable":true
        },
        "PersonPreNameAdjunct":{
            "maxLength":60,
            "type":"string",
            "description":"Person's pre name adjunct.",
            "nullable":true
        },
        "MailingProvince":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address province.",
            "nullable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the physical address.",
            "nullable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the physical address.",
            "nullable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the physical address.",
            "nullable":true
        },
        "EmergencyContactPhone":{
            "type":"string",
            "description":"The phone number of the emergency contact.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerProfileId":{
            "type":"integer",
            "description":"The owner profile identifier of the owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Phone number.",
            "nullable":true
        }
    }
}

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 : publicSectorBusinessRegistrations-BusinessOwner-item-response

Type: object

Show Source

• Address1: string
  Maximum Length: 240

  First line of the physical address.
• Address2: string
  Maximum Length: 240

  Second line of the physical address.
• Address3: string
  Maximum Length: 240

  Third line of the physical address.
• Address4: string
  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.
• City: string
  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
  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
  Maximum Length: 320

  Email address of the business owner.
• EmergencyContactFlag: string
  Indicates whether the owner is an emergency contact.
• EmergencyContactPhone: string
  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
  Maximum Length: 240

  First line of the location owner mailing address.
• MailingAddress2: string
  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
  Maximum Length: 60

  Mailing address city.
• MailingCountry: string
  Maximum Length: 2

  Mailing address country.
• MailingCounty: string
  Maximum Length: 60

  Mailing address county.
• MailingPostalCode: string
  Maximum Length: 60

  Mailing address postal code.
• MailingPostalPlusFourCode: string
  Maximum Length: 20

  Location mailing postal plus 4 code.
• MailingProvince: string
  Maximum Length: 60

  Mailing address province.
• MailingState: string
  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
  Maximum Length: 150

  First name of the business owner.
• PersonLastName: string
  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
  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
  Maximum Length: 40

  Phone number.
• PhoneType: string
  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
  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
  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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date that the business owner was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VerificationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The verification status for the responsible person.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationDate":{
            "type":"string",
            "description":"The date that the responsible person was verified.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ContactType":{
            "maxLength":30,
            "type":"string",
            "description":"The contact type of the owner.",
            "nullable":true,
            "x-queryable":true
        },
        "SameMailAddressFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the mailing address is the same as the physical address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonType":{
            "type":"string",
            "description":"The person type for the business owner.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"Middle name of the business owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "maxLength":100,
            "type":"string",
            "description":"The title of the business owner.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessEntityKey":{
            "type":"integer",
            "description":"System-generated identifier for a business entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MailingPostalPlusFourCode":{
            "maxLength":20,
            "type":"string",
            "description":"Location mailing postal plus 4 code.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EmergencyContactFlag":{
            "type":"string",
            "description":"Indicates whether the owner is an emergency contact.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactDmvLicSt":{
            "maxLength":60,
            "type":"string",
            "description":"The contact DMV license state.",
            "nullable":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "type":"string",
            "description":"The business owner's date of birth.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Current status of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "EntityAccess":{
            "maxLength":3,
            "type":"string",
            "description":"The entity access of the owner.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferencePuid":{
            "maxLength":50,
            "type":"string",
            "description":"System-generated reference key PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"Last name of the business owner.",
            "nullable":true,
            "x-queryable":true
        },
        "MailingCity":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address city.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address city.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"First name of the business owner.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the business owner.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address province.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"Phone extension number.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":20,
            "type":"string",
            "description":"Physical address postal plus 4 code.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneType":{
            "maxLength":30,
            "type":"string",
            "description":"Phone type.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address state.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":2,
            "type":"string",
            "description":"Physical address country.",
            "nullable":true,
            "x-queryable":true
        },
        "VerifiedBy":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies who verified the responsible person.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLengthAtAddress":{
            "type":"integer",
            "description":"The length of time that the person has been at this address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactDmvLicNum":{
            "maxLength":30,
            "type":"string",
            "description":"The contact DMV license number.",
            "nullable":true,
            "x-queryable":true
        },
        "RawPhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Raw phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login identifier of the person who last updated the business owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a business entity.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifer for the agency.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "MailingAddressId":{
            "type":"string",
            "description":"The unique identifier for the mailing address.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnershipPct":{
            "type":"number",
            "description":"The person's percentage of ownership in the business.",
            "nullable":true,
            "x-hints":{
                "precision":10,
                "scale":7
            },
            "x-queryable":true
        },
        "MailingCountry":{
            "maxLength":2,
            "type":"string",
            "description":"Mailing address country.",
            "nullable":true,
            "x-queryable":true
        },
        "SameAsApplicantFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the mailing address is the same as the applicant's.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"The name suffix of the business owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address postal code.",
            "nullable":true,
            "x-queryable":true
        },
        "MailingCounty":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address county.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The physical address of the county.",
            "nullable":true,
            "x-queryable":true
        },
        "MailingState":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address state.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":20,
            "type":"string",
            "description":"Phone number area code.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Phone number country code.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationShipToBusiness":{
            "type":"string",
            "description":"The owner's relationship to the business.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactDmvLicExp":{
            "type":"string",
            "description":"The contact DMV license expiration date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EntityPartyId":{
            "type":"integer",
            "description":"The entity party identifier of the owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Workflow project revision number used to define the workflow.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the physical address.",
            "nullable":true,
            "x-queryable":true
        },
        "MailingPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address postal code.",
            "nullable":true,
            "x-queryable":true
        },
        "MailingAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the location mailing address.",
            "nullable":true,
            "x-queryable":true
        },
        "MailingAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the location owner mailing address.",
            "nullable":true,
            "x-queryable":true
        },
        "MailingAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the location owner mailing address.",
            "nullable":true,
            "x-queryable":true
        },
        "MailingAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the location mailing address.",
            "nullable":true,
            "x-queryable":true
        },
        "BePersonId":{
            "maxLength":200,
            "type":"string",
            "description":"Unique identifier of the business owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonPreNameAdjunct":{
            "maxLength":60,
            "type":"string",
            "description":"Person's pre name adjunct.",
            "nullable":true,
            "x-queryable":true
        },
        "MailingProvince":{
            "maxLength":60,
            "type":"string",
            "description":"Mailing address province.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceKey":{
            "type":"integer",
            "description":"System-generated unique identifier for an owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the physical address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the physical address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the physical address.",
            "nullable":true,
            "x-queryable":true
        },
        "EmergencyContactPhone":{
            "type":"string",
            "description":"The phone number of the emergency contact.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerProfileId":{
            "type":"integer",
            "description":"The owner profile identifier of the owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReferencePartyId":{
            "type":"integer",
            "description":"Unique identifier for the reference party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the business owner was last updated.",
            "format":"date-time",
            "nullable":false,
            "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