Jump to

• Request
• Response

Create a set of BL workflow communication items

post

/fscmRestApi/resources/11.13.18.05/publicSectorBlWorkflowCommunications

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorBlWorkflowCommunications-item-response

Type: object

Show Source

• AboutToExpireDate: string (date-time)
  Title: About to Expire Date

  Read Only: true

  The date when the notification about an expiring license or permit is sent.
• Address1: string
  Title: Applicant Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the business license applicant address.
• Address2: string
  Title: Applicant Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of the business license applicant address.
• AddressId: integer (int64)
  Title: Location Address ID

  Read Only: true

  The reference key to the TCA location table.
• AgencyId: integer (int32)
  Read Only: true

  The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
• AppAcceptDate: string (date-time)
  Title: Acceptance Date

  Read Only: true

  Identifies the accepted date for the business license application.
• ApplAteDate: string (date-time)
  Title: Application About to Expire Date

  Read Only: true

  Identifies the date on which an about-to-expire notification is sent for the permit application.
• ApplExpirationDate: string (date-time)
  Title: Application Expiration Date

  Read Only: true

  The date the application expires.
• Applicant: integer (int64)
  Read Only: true

  The party ID of the permit applicant.
• ApplicantBizProfileId: integer (int64)
  Read Only: true

  The business profile used by the applicant.
• ApplicantPhoneAreaCode: string
  Read Only: true

  Maximum Length: 10

  The area code in the phone number of the business license applicant.
• ApplicantPhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The country code in the phone number of the business license applicant.
• ApplicantPhoneExtension: string
  Title: Applicant Phone Extension

  Read Only: true

  Maximum Length: 20

  The phone number extension for the business license applicant.
• ApplicantPhoneNumber: string
  Title: Applicant Phone Number

  Read Only: true

  Maximum Length: 61

  The license applicant phone number.
• ApplicantProfileId: integer (int64)
  Read Only: true

  The user profile of the applicant.
• ApplicantUserId: string
  Title: Applicant User ID

  Read Only: true

  Maximum Length: 255

  The user ID of the business license applicant.
• AssignedSpecialistEmail: string
  Title: Assigned Specialist Email

  Read Only: true

  Maximum Length: 255

  The email of the specialist who is assigned to the application.
• AssignedSpecialistName: string
  Title: Assigned Specialist Name

  Read Only: true

  Maximum Length: 255

  The user name of the specialist who is assigned to the application.
• AssignedSpecialistUserid: string
  Title: Assigned Specialist User ID

  Read Only: true

  Maximum Length: 64

  The user ID of the specialist who is assigned to the application.
• AssignedSpecialistWorkPhone: string
  Title: Assigned Specialist Work Phone

  Read Only: true

  Maximum Length: 255

  The work phone contact of the specialist who is assigned to the application.
• AttributeCategory: string
  Read Only: true

  Maximum Length: 30

  The category of the business license type.
• BalanceDue: number
  Title: Fees Balance Due

  Read Only: true

  The total fees balance due for the license application.
• BusAddress1: string
  Title: Business Address 1

  Read Only: true

  Maximum Length: 240

  The address portion of the business??? address.
• BusAddress2: string
  Title: Business Address 2

  Read Only: true

  Maximum Length: 240

  The address portion of the business??? address.
• BusBusinessLegalName: string
  Title: Business Legal Name

  Read Only: true

  Maximum Length: 240

  The legal name of the business entity.
• BusBusinessName: string
  Title: Business

  Read Only: true

  Maximum Length: 100

  The name of the applicant's business. For example, a contractor enters his or her contracting business name.
• BusCity: string
  Title: Business City

  Read Only: true

  Maximum Length: 60

  The city portion of the business??? address.
• BusCountry: string
  Title: Business Country

  Read Only: true

  Maximum Length: 3

  The address portion of the business??? address.
• BusCounty: string
  Title: Business County

  Read Only: true

  Maximum Length: 60

  The county portion of the business??? address.
• BusDbaBusinessName: string
  Title: Doing Business As

  Read Only: true

  Maximum Length: 100

  The doing business as name for the business.
• BusDescription: string
  Title: Location Business Description

  Read Only: true

  Maximum Length: 200

  A field in the business information component of the form designer used to enter a description of the business.
• BusinessEntityId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the business entity.
• BusinessURL: string
  Title: Business URL

  Read Only: true

  Maximum Length: 255

  The URL for the business entity.
• BusOwnershipType: string
  Title: Business Ownership Type

  Read Only: true

  Maximum Length: 15

  A field in the business information component of the form designer used to describe the type of business ownership.
• BusPostalCode: string
  Title: Business Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code portion of the business??? address.
• BusProvince: string
  Title: Business Province

  Read Only: true

  Maximum Length: 60

  The province portion of the business??? address.
• BusState: string
  Title: Business State

  Read Only: true

  Maximum Length: 60

  The state portion of the business??? address.
• CancelledByName: string
  Title: Canceled by Name

  Read Only: true

  Maximum Length: 255

  Identifies the user name of the person who canceled the license application.
• Cancelledcreatedby: string
  Title: Canceled by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who canceled the business license application.
• Cancelledcreationdate: string (date-time)
  Title: Cancellation Date

  Read Only: true

  Identifies the cancelation date of the business license application.
• Cancelledreason: string
  Title: Cancellation Reason

  Read Only: true

  Maximum Length: 1000

  Identifies the reason for the cancelation of the business license application.
• City: string
  Title: Applicant City

  Read Only: true

  Maximum Length: 60

  The city in the business license applicant address.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
• ClassificationMeaning: string
  Title: Classification

  Read Only: true

  Maximum Length: 80

  Identifies the classification of the business license application type.
• Country: string
  Title: Applicant Country

  Read Only: true

  Maximum Length: 3

  The country in the permit applicant address.
• County: string
  Title: Applicant County

  Read Only: true

  Maximum Length: 60

  The county in the permit applicant address.
• CreatedBy: string
  Title: Created by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who created the business license application.
• CreatedByName: string
  Title: Created by Name

  Read Only: true

  Maximum Length: 255

  Identifies the user name of the person who created the license application.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Identifies the date on which the business license application was created.
• CurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 3

  Identifies the currency code.
• DelinquentDate: string (date-time)
  Read Only: true

  The date the license becomes delinquent.
• Description: string
  Title: Activity Description

  Read Only: true

  Maximum Length: 100

  The description for business license application.
• EmailAddress1: string
  Title: Applicant Email 1

  Read Only: true

  Maximum Length: 320

  The first email address of the business license applicant.
• EmailAddress2: string
  Title: Applicant Email 2

  Read Only: true

  Maximum Length: 320

  The second email address of the business license applicant.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Read Only: true

  The date the license or permit is no longer valid.
• ExpirationGraceDate: string (date-time)
  Title: Grace Period Date

  Read Only: true

  Identifies the expiration grace date for the business license application.
• ExpirationStatus: string
  Title: Expiration Status Code

  Read Only: true

  Maximum Length: 15

  Identifies the expiration status of the business license application.
• ExpirationStatusDescription: string
  Title: Expiration Status

  Read Only: true

  Maximum Length: 80

  The description for the expiration status.
• FeeDueUpdateDate: string (date-time)
  Title: Fees Due Updated Date

  Read Only: true

  The identifier that captures the date when fee item with due status is added or updated.
• IssueDate: string (date-time)
  Title: Issue Date

  Read Only: true

  The date the license or permit was issued. Used in the application information component of the Permit Designer.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Identifies the last updated date of the business license application.
• LastUpdatedBy: string
  Title: Last Updated by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who last updated the business license application.
• LastUpdatedByName: string
  Title: Last Updated by Name

  Read Only: true

  Maximum Length: 255

  Identifies the user name of the person who last updated the license application.
• LicensePeriod: string
  Title: License Period

  Read Only: true

  Maximum Length: 100

  The duration in which the business license is valid.
• LicenseStatus: string
  Title: License Status

  Read Only: true

  Maximum Length: 30

  The overall status for the business license.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: License ID

  Read Only: true

  Maximum Length: 50

  The identifier for the business license record.
• LnpRecordKey: integer
  Read Only: true

  The unique identifier for the record.
• LocAltPhoneExtn: string
  Title: Location Alternate Phone Extension

  Read Only: true

  Maximum Length: 20

  The additional extension number after initial connection to an internal telephone system.
• LocAltPhoneNumber: string
  Title: Location Alternate Phone Number

  Read Only: true

  Maximum Length: 61

  The location???s full phone number.
• LocAltPhoneType: string
  Title: Location Alternate Phone Type

  Read Only: true

  Maximum Length: 30

  The type of phone for the location.
• LocationAddressOne: string
  Title: Location Address Line 1

  Read Only: true

  Maximum Length: 240

  Address Line 1 as part of the parcel address.
• LocationAddressTwo: string
  Title: Location Address Line 2

  Read Only: true

  Maximum Length: 240

  Address Line 2 as part of the parcel address.
• LocationCity: string
  Title: Location City

  Read Only: true

  Maximum Length: 60

  The city that is part of the parcel address.
• LocationCountry: string
  Title: Location Country

  Read Only: true

  Maximum Length: 3

  The country that is part of the parcel address.
• LocationCounty: string
  Title: Location County

  Read Only: true

  Maximum Length: 60

  The county in which the parcel address is located.
• LocationPostalCode: string
  Title: Location Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code that is part of the parcel address.
• LocationProvince: string
  Title: Location Province

  Read Only: true

  Maximum Length: 60

  The location information about the province in which the parcel address is located.
• LocationState: string
  Title: Location State

  Read Only: true

  Maximum Length: 60

  The state that is part of the parcel address.
• LocationType: string
  Title: Location Type

  Read Only: true

  Maximum Length: 30

  The location type for the license application.
• LocEmailAddress: string
  Title: Location Primary Email

  Read Only: true

  Maximum Length: 320

  The business location???s email address.
• LocPrimaryPhoneExtn: string
  Title: Location Primary Phone Extension

  Read Only: true

  Maximum Length: 20

  The additional extension number after initial connection to an internal telephone system.
• LocPrimaryPhoneNumber: string
  Title: Location Primary Phone

  Read Only: true

  Maximum Length: 61

  The phone number of the location.
• LocPrimaryPhoneType: string
  Title: Location Primary Phone Type

  Read Only: true

  Maximum Length: 30

  The type of phone for the location.
• MailingAddress1: string
  Title: Mailing Address Line 1

  Read Only: true

  Maximum Length: 240

  The address portion of the location???s address.
• MailingAddress2: string
  Title: Mailing Address Line 2

  Read Only: true

  Maximum Length: 240

  The address portion of the location???s address.
• MailingCity: string
  Title: Mailing Address City

  Read Only: true

  Maximum Length: 60

  The city portion of the location???s address.
• MailingCountry: string
  Title: Mailing Address Country

  Read Only: true

  Maximum Length: 3

  The country portion of the location???s address.
• MailingCounty: string
  Title: Mailing Address County

  Read Only: true

  Maximum Length: 60

  The county portion of the location???s address.
• MailingPostalCode: string
  Title: Mailing Address Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code portion of the location???s address.
• MailingProvince: string
  Title: Mailing Address Province

  Read Only: true

  Maximum Length: 60

  The province portion of the location???s address.
• MailingState: string
  Title: Mailing Address State

  Read Only: true

  Maximum Length: 60

  The state portion of the location???s address.
• MobileBusFlag: string
  Title: Mobile Business

  Read Only: true

  Maximum Length: 1

  Indicates that the business is a mobile business.
• NaicsCodes: string
  Title: NAICS Code

  Read Only: true

  Maximum Length: 4000

  Indicates comma separated list of NAICS codes.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The system attribute that notes the incremental version number for an object.
• OrganizationName: string
  Title: Applicant Business Name

  Read Only: true

  Maximum Length: 360

  The business name of the applicant. For example, a contractor enters his or her contracting business name.
• Originator: string
  Title: Originator

  Read Only: true

  Maximum Length: 3

  Identifies the originator of the business license application.
• ParcelId: integer (int64)
  Title: Location Parcel ID

  Read Only: true

  The identifier of the record parcel.
• PersonFirstName: string
  Title: Applicant First Name

  Read Only: true

  Maximum Length: 150

  The applicant first name.
• PersonLastName: string
  Title: Applicant Last Name

  Read Only: true

  Maximum Length: 150

  The applicant last name.
• PersonMiddleName: string
  Title: Applicant Middle Name

  Read Only: true

  Maximum Length: 60

  The applicant middle name.
• PersonName: string
  Title: Applicant Full Name

  Read Only: true

  Maximum Length: 450

  The license or business license applicant name.
• PersonTitle: string
  Title: Applicant Title

  Read Only: true

  Maximum Length: 60

  The title of the contact.
• PostalCode: string
  Title: Applicant Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the permit applicant address.
• Province: string
  Title: Applicant Province

  Read Only: true

  Maximum Length: 60

  The province in the business license applicant address.
• ReceivedDate: string (date-time)
  Title: Received Date

  Read Only: true

  Identifies the received date for the license application.
• RecordStatus: string
  Read Only: true

  Maximum Length: 15

  The status of the record.
• RecordType: string
  Title: License Type

  Read Only: true

  Maximum Length: 100

  The user-friendly name for the record type.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  The identifier for a record type.
• RenewalDate: string (date-time)
  Title: Renewal Date

  Read Only: true

  The renewal date for the license or permit.
• State: string
  Title: Applicant State

  Read Only: true

  Maximum Length: 60

  The state in the permit applicant address.
• Status: string
  Read Only: true

  Maximum Length: 15

  The status of the business license application.
• StatusDescription: string
  Title: Activity Status

  Read Only: true

  Maximum Length: 100

  The status description of the business.
• Subclassification: string
  Read Only: true

  Maximum Length: 10

  The subclassification code of the business license application type.
• SubclassificationMeaning: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 80

  Identifies the subclassification of the business license application type.
• SubmitDate: string (date-time)
  Title: Submission Date

  Read Only: true

  The date the license transaction was submitted.
• SubmittedBy: string
  Title: Submitted by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who submitted the business license application.
• SubmittedByName: string
  Title: Submitted by Name

  Read Only: true

  Maximum Length: 255

  Identifies the user name of the person who submitted the license application.
• SystemStatus: string
  Title: Activity System Status Code

  Read Only: true

  Maximum Length: 15

  Identifies the system status of the business license application.
• SystemStatusDescription: string
  Title: Activity System Status

  Read Only: true

  Maximum Length: 80

  The system status description of the business license application.
• TotalFees: integer (int64)
  Title: Fees Total Amount

  Read Only: true

  The total fees for the license application.
• TotalHold: number
  Title: Fees on Hold

  Read Only: true

  Identifies the total hold fee amount.
• TotalOutstanding: number
  Title: Fees Outstanding Balance

  Read Only: true

  Identifies the total outstanding fee amount.
• TotalPaid: integer (int64)
  Title: Fees Total Paid

  Read Only: true

  The total fees paid for the license application.
• TotalPayable: number
  Title: Fees Total Payable

  Read Only: true

  The total fees paid for the license application.
• TotalPending: number
  Title: Fees in Pending Status

  Read Only: true

  Identifies the total pending fee amount.
• TotalWaived: number
  Title: Fees Waived

  Read Only: true

  Identifies the total fee waived.
• Url: string
  Title: URL

  Read Only: true

  Maximum Length: 255

  The URL for the license application.
• UrlLabel: string
  Title: Link to Business License Activity

  Read Only: true

  Maximum Length: 255

  The URL label for the license application.
• VersionType: string
  Title: Version Type

  Read Only: true

  Maximum Length: 1

  The version of the business license application.
• WfProcessId: number
  Read Only: true

  The unique identifier for a workflow process.
• WithdrawnByName: string
  Title: Withdrawn by Name

  Read Only: true

  Maximum Length: 255

  Identifies the user name of the person who withdrew the license application.
• Withdrawncreatedby: string
  Title: Withdrawn by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who withdrew the business license application.
• Withdrawncreateddate: string (date-time)
  Title: Withdrawal Date

  Read Only: true

  Identifies the withdrawal date of the business license application.
• Withdrawnreason: string
  Title: Withdrawal Reason

  Read Only: true

  Maximum Length: 1000

  Identifies the reason for the withdrawal of the business license application.

{
    "type":"object",
    "properties":{
        "BusDescription":{
            "title":"Location Business Description",
            "maxLength":"200",
            "type":"string",
            "description":"A field in the business information component of the form designer used to enter a description of the business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Identifies the date on which the business license application was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AboutToExpireDate":{
            "title":"About to Expire Date",
            "type":"string",
            "description":"The date when the notification about an expiring license or permit is sent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantUserId":{
            "title":"Applicant User ID",
            "maxLength":"255",
            "type":"string",
            "description":"The user ID of the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AppAcceptDate":{
            "title":"Acceptance Date",
            "type":"string",
            "description":"Identifies the accepted date for the business license application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The date the license transaction was submitted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationStatusDescription":{
            "title":"Expiration Status",
            "maxLength":"80",
            "type":"string",
            "description":"The description for the expiration status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalHold":{
            "title":"Fees on Hold",
            "type":"number",
            "description":"Identifies the total hold fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Applicant Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The applicant middle name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AssignedSpecialistUserid":{
            "title":"Assigned Specialist User ID",
            "maxLength":"64",
            "type":"string",
            "description":"The user ID of the specialist who is assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"Identifies the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AssignedSpecialistWorkPhone":{
            "title":"Assigned Specialist Work Phone",
            "maxLength":"255",
            "type":"string",
            "description":"The work phone contact of the specialist who is assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Originator":{
            "title":"Originator",
            "maxLength":"3",
            "type":"string",
            "description":"Identifies the originator of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The record classification. The classifications can be permit, business license, professional license, or planning and zoning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocEmailAddress":{
            "title":"Location Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The business location???s email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "TotalPaid":{
            "title":"Fees Total Paid",
            "type":"integer",
            "description":"The total fees paid for the license application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"255",
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "UrlLabel":{
            "title":"Link to Business License Activity",
            "maxLength":"255",
            "type":"string",
            "description":"The URL label for the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URLLabel":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusinessURL":{
            "title":"Business URL",
            "maxLength":"255",
            "type":"string",
            "description":"The URL for the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URL":"Y"
            },
            "x-queryable":true
        },
        "Status":{
            "maxLength":"15",
            "type":"string",
            "description":"The status of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated by User ID",
            "maxLength":"64",
            "type":"string",
            "description":"Identifies the user ID of the person who last updated the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Withdrawnreason":{
            "title":"Withdrawal Reason",
            "maxLength":"1000",
            "type":"string",
            "description":"Identifies the reason for the withdrawal of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created by User ID",
            "maxLength":"64",
            "type":"string",
            "description":"Identifies the user ID of the person who created the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantProfileId":{
            "type":"integer",
            "description":"The user profile of the applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Cancelledreason":{
            "title":"Cancellation Reason",
            "maxLength":"1000",
            "type":"string",
            "description":"Identifies the reason for the cancelation of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Applicant Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The applicant last name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusBusinessLegalName":{
            "title":"Business Legal Name",
            "maxLength":"240",
            "type":"string",
            "description":"The legal name of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted by User ID",
            "maxLength":"64",
            "type":"string",
            "description":"Identifies the user ID of the person who submitted the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "MailingCity":{
            "title":"Mailing Address City",
            "maxLength":"60",
            "type":"string",
            "description":"The city portion of the location???s address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"Applicant First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The applicant first name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"1"
            },
            "x-queryable":true
        },
        "ClassificationMeaning":{
            "title":"Classification",
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the classification of the business license application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"The renewal date for the license or permit.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NaicsCodes":{
            "title":"NAICS Code",
            "maxLength":"4000",
            "type":"string",
            "description":"Indicates comma separated list of NAICS codes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WithdrawnByName":{
            "title":"Withdrawn by Name",
            "maxLength":"255",
            "type":"string",
            "description":"Identifies the user name of the person who withdrew the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ExpirationGraceDate":{
            "title":"Grace Period Date",
            "type":"string",
            "description":"Identifies the expiration grace date for the business license application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeDueUpdateDate":{
            "title":"Fees Due Updated Date",
            "type":"string",
            "description":"The identifier that captures the date when fee item with due status is added or updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Applicant Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The party ID of the permit applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplicantPhoneExtension":{
            "title":"Applicant Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The phone number extension for the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocationProvince":{
            "title":"Location Province",
            "maxLength":"60",
            "type":"string",
            "description":"The location information about the province in which the parcel address is located.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusinessEntityId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Activity Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description for business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"8",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusAddress2":{
            "title":"Business Address 2",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusAddress1":{
            "title":"Business Address 1",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AttributeCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The category of the business license type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingCountry":{
            "title":"Mailing Address Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country portion of the location???s address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "MailingCounty":{
            "title":"Mailing Address County",
            "maxLength":"60",
            "type":"string",
            "description":"The county portion of the location???s address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocationAddressOne":{
            "title":"Location Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"Address Line 1 as part of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplExpirationDate":{
            "title":"Application Expiration Date",
            "type":"string",
            "description":"The date the application expires.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Cancelledcreatedby":{
            "title":"Canceled by User ID",
            "maxLength":"64",
            "type":"string",
            "description":"Identifies the user ID of the person who canceled the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "MailingState":{
            "title":"Mailing Address State",
            "maxLength":"60",
            "type":"string",
            "description":"The state portion of the location???s address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"URL",
            "maxLength":"255",
            "type":"string",
            "description":"The URL for the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true",
                "URL":"Y"
            },
            "x-queryable":true
        },
        "DelinquentDate":{
            "type":"string",
            "description":"The date the license becomes delinquent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for a record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Withdrawncreateddate":{
            "title":"Withdrawal Date",
            "type":"string",
            "description":"Identifies the withdrawal date of the business license application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusState":{
            "title":"Business State",
            "maxLength":"60",
            "type":"string",
            "description":"The state portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "MailingAddress1":{
            "title":"Mailing Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the location???s address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "MailingAddress2":{
            "title":"Mailing Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The address portion of the location???s address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated by Name",
            "maxLength":"255",
            "type":"string",
            "description":"Identifies the user name of the person who last updated the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RecordStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The status of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingProvince":{
            "title":"Mailing Address Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province portion of the location???s address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocationState":{
            "title":"Location State",
            "maxLength":"60",
            "type":"string",
            "description":"The state that is part of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusDbaBusinessName":{
            "title":"Doing Business As",
            "maxLength":"100",
            "type":"string",
            "description":"The doing business as name for the business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusCounty":{
            "title":"Business County",
            "maxLength":"60",
            "type":"string",
            "description":"The county portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date the license or permit was issued. Used in the application information component of the Permit Designer.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneCountryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The country code in the phone number of the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplAteDate":{
            "title":"Application About to Expire Date",
            "type":"string",
            "description":"Identifies the date on which an about-to-expire notification is sent for the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationStatus":{
            "title":"Expiration Status Code",
            "maxLength":"15",
            "type":"string",
            "description":"Identifies the expiration status of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionType":{
            "title":"Version Type",
            "maxLength":"1",
            "type":"string",
            "description":"The version of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantBizProfileId":{
            "type":"integer",
            "description":"The business profile used by the applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date the license or permit is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Withdrawncreatedby":{
            "title":"Withdrawn by User ID",
            "maxLength":"64",
            "type":"string",
            "description":"Identifies the user ID of the person who withdrew the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Identifies the last updated date of the business license application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocAltPhoneExtn":{
            "title":"Location Alternate Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The additional extension number after initial connection to an internal telephone system.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Subclassification":{
            "maxLength":"10",
            "type":"string",
            "description":"The subclassification code of the business license application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress1":{
            "title":"Applicant Email 1",
            "maxLength":"320",
            "type":"string",
            "description":"The first email address of the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "EmailAddress2":{
            "title":"Applicant Email 2",
            "maxLength":"320",
            "type":"string",
            "description":"The second email address of the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Applicant Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusBusinessName":{
            "title":"Business",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the applicant's business. For example, a contractor enters his or her contracting business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusDescription":{
            "title":"Activity Status",
            "maxLength":"100",
            "type":"string",
            "description":"The status description of the business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WfProcessId":{
            "type":"number",
            "description":"The unique identifier for a workflow process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicensePeriod":{
            "title":"License Period",
            "maxLength":"100",
            "type":"string",
            "description":"The duration in which the business license is valid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusCity":{
            "title":"Business City",
            "maxLength":"60",
            "type":"string",
            "description":"The city portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AddressId":{
            "title":"Location Address ID",
            "type":"integer",
            "description":"The reference key to the TCA location table.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplicantPhoneAreaCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The area code in the phone number of the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubclassificationMeaning":{
            "title":"Subclassification",
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the subclassification of the business license application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MobileBusFlag":{
            "title":"Mobile Business",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the business is a mobile business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusOwnershipType":{
            "title":"Business Ownership Type",
            "maxLength":"15",
            "type":"string",
            "description":"A field in the business information component of the form designer used to describe the type of business ownership.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationAddressTwo":{
            "title":"Location Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"Address Line 2 as part of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocPrimaryPhoneNumber":{
            "title":"Location Primary Phone",
            "maxLength":"61",
            "type":"string",
            "description":"The phone number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocationCity":{
            "title":"Location City",
            "maxLength":"60",
            "type":"string",
            "description":"The city that is part of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SubmittedByName":{
            "title":"Submitted by Name",
            "maxLength":"255",
            "type":"string",
            "description":"Identifies the user name of the person who submitted the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "City":{
            "title":"Applicant City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocPrimaryPhoneType":{
            "title":"Location Primary Phone Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of phone for the location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocAltPhoneType":{
            "title":"Location Alternate Phone Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of phone for the location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CancelledByName":{
            "title":"Canceled by Name",
            "maxLength":"255",
            "type":"string",
            "description":"Identifies the user name of the person who canceled the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Applicant Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "TotalOutstanding":{
            "title":"Fees Outstanding Balance",
            "type":"number",
            "description":"Identifies the total outstanding fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "LocationPostalCode":{
            "title":"Location Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code that is part of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ReceivedDate":{
            "title":"Received Date",
            "type":"string",
            "description":"Identifies the received date for the license application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"Applicant State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LicenseStatus":{
            "title":"License Status",
            "maxLength":"30",
            "type":"string",
            "description":"The overall status for the business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusCountry":{
            "title":"Business Country",
            "maxLength":"3",
            "type":"string",
            "description":"The address portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BusPostalCode":{
            "title":"Business Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Applicant Business Name",
            "maxLength":"360",
            "type":"string",
            "description":"The business name of the applicant. For example, a contractor enters his or her contracting business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByName":{
            "title":"Created by Name",
            "maxLength":"255",
            "type":"string",
            "description":"Identifies the user name of the person who created the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocAltPhoneNumber":{
            "title":"Location Alternate Phone Number",
            "maxLength":"61",
            "type":"string",
            "description":"The location???s full phone number.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocationCountry":{
            "title":"Location Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country that is part of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Applicant Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "TotalPayable":{
            "title":"Fees Total Payable",
            "type":"number",
            "description":"The total fees paid for the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "TotalWaived":{
            "title":"Fees Waived",
            "type":"number",
            "description":"Identifies the total fee waived.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "County":{
            "title":"Applicant County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RecordType":{
            "title":"License Type",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly name for the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The system attribute that notes the incremental version number for an object.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"9"
            },
            "x-queryable":true
        },
        "MailingPostalCode":{
            "title":"Mailing Address Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code portion of the location???s address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AssignedSpecialistName":{
            "title":"Assigned Specialist Name",
            "maxLength":"255",
            "type":"string",
            "description":"The user name of the specialist who is assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AssignedSpecialistEmail":{
            "title":"Assigned Specialist Email",
            "maxLength":"255",
            "type":"string",
            "description":"The email of the specialist who is assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SystemStatusDescription":{
            "title":"Activity System Status",
            "maxLength":"80",
            "type":"string",
            "description":"The system status description of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocPrimaryPhoneExtn":{
            "title":"Location Primary Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The additional extension number after initial connection to an internal telephone system.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SystemStatus":{
            "title":"Activity System Status Code",
            "maxLength":"15",
            "type":"string",
            "description":"Identifies the system status of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"License ID",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier for the business license record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Condition:ObjectType":"LNP",
                "brf:Condition:ObjectSubType":"BL"
            },
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Location Parcel ID",
            "type":"integer",
            "description":"The identifier of the record parcel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Applicant Full Name",
            "maxLength":"450",
            "type":"string",
            "description":"The license or business license applicant name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "TotalPending":{
            "title":"Fees in Pending Status",
            "type":"number",
            "description":"Identifies the total pending fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "ApplicantPhoneNumber":{
            "title":"Applicant Phone Number",
            "maxLength":"61",
            "type":"string",
            "description":"The license applicant phone number.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Cancelledcreationdate":{
            "title":"Cancellation Date",
            "type":"string",
            "description":"Identifies the cancelation date of the business license application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Applicant Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Address1":{
            "title":"Applicant Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LocationCounty":{
            "title":"Location County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in which the parcel address is located.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Fees Total Amount",
            "type":"integer",
            "description":"The total fees for the license application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"255",
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "BusProvince":{
            "title":"Business Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province portion of the business??? address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "BalanceDue":{
            "title":"Fees Balance Due",
            "type":"number",
            "description":"The total fees balance due for the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "LocationType":{
            "title":"Location Type",
            "maxLength":"30",
            "type":"string",
            "description":"The location type for the license application.",
            "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