Jump to

• Request
• Response

Get all Business License items

get

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLicenses

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the business licenses data that matches the specified record ID.
    Finder Variables:
    • LnpRecordId; string; The unique identifier for the record.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AboutToExpireDate; string; The date when the notification about an expiring license or permit is sent.
  • AcceptanceDate; string; Identifies the accepted date for the business license application.
  • ActivityDescription; string; The description for the business license application.
  • AddressId; integer; The reference key to the TCA location table.
  • AgencyId; integer; 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.
  • AmendmentType; string; Indicates whether an inactive application should be reactivated from the amendment intake form.
  • ApplAteDate; string; Identifies the date on which an about-to-expire notification is sent for the permit application.
  • ApplExpirationDate; string; The date when the application expires.
  • Applicant; integer; The party ID of the permit applicant.
  • ApplicantAddressOne; string; The first line of the business license applicant's address.
  • ApplicantAddressTwo; string; The second line of the business license applicant's address.
  • ApplicantBizProfileId; integer; The business profile used by the applicant.
  • ApplicantCity; string; The city in the business license applicant's address.
  • ApplicantCountry; string; The country in the permit applicant's address.
  • ApplicantCounty; string; The county in the permit applicant's address.
  • ApplicantEmailAddressOne; string; The first email address of the business license applicant.
  • ApplicantEmailAddressTwo; string; The second email address of the business license applicant.
  • ApplicantPhoneAreaCode; string; The area code in the phone number of the business license applicant.
  • ApplicantPhoneCountryCode; string; The country code in the phone number of the business license applicant.
  • ApplicantPhoneExtension; string; The phone number extension for the business license applicant.
  • ApplicantPhoneNumber; string; The phone number for the business license applicant.
  • ApplicantPostalCode; string; The postal code in the permit applicant's address.
  • ApplicantProfileId; integer; The user profile of the applicant.
  • ApplicantProvince; string; The province in the business license applicant's address.
  • ApplicantState; string; The state in the permit applicant's address.
  • ApplicantUserId; string; The user ID of the business license applicant.
  • AssignedSpecialistEmail; string; The email of the specialist who is assigned to the application.
  • AssignedSpecialistName; string; The user name of the specialist who is assigned to the application.
  • AssignedSpecialistUserid; string; The user ID of the specialist who is assigned to the application.
  • AssignedSpecialistWorkPhone; string; The work phone contact of the specialist who is assigned to the application.
  • AttributeCategory; string; The category of the business license type.
  • BalanceDue; number; The total fees balance due for the license application.
  • BusAddressOne; string; The address portion of the business??? address.
  • BusAddressTwo; string; The address portion of the business??? address.
  • BusBusinessLegalName; string; The legal name of the business entity.
  • BusBusinessName; string; The name of the applicant's business. For example, a contractor enters his or her contracting business name.
  • BusCity; string; The city portion of the business??? address.
  • BusCountry; string; The address portion of the business??? address.
  • BusCounty; string; The county portion of the business??? address.
  • BusDbaBusinessName; string; The doing business as name for the business.
  • BusDescription; string; A field in the business information component of the form designer used to enter a description of the business.
  • BusOwnershipType; string; A field in the business information component of the form designer used to describe the type of business ownership.
  • BusPostalCode; string; The postal code portion of the business??? address.
  • BusProvince; string; The province portion of the business??? address.
  • BusStartDate; string; This field in the business information component of the form designer is used to enter the date of business establishment.
  • BusState; string; The state portion of the business??? address.
  • BusinessEntityId; string; The unique identifier of the business entity.
  • BusinessURL; string; The URL for the business entity.
  • Classification; string; The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
  • CompletedById; string; Name of the agency staff who processed the change.
  • CompletedByName; string; Identifies the user name of the person who completed the license application.
  • CompletedOn; string; Indicates the date the change was completed.
  • CreatedBy; string; Identifies the user ID of the person who created the business license application.
  • CreatedByName; string; The user name of the person who created the license application.
  • CreationDate; string; Identifies the date on which the business license application was created.
  • CurrencyCode; string; Identifies the currency code.
  • DelinquentDate; string; The date the license becomes delinquent.
  • EffChangeDate; string; The effective change date of a business license record.
  • EffectiveChangeDate; string; The effective date of the license inactivation.
  • ExpirationDate; string; The date the license or permit is no longer valid.
  • ExpirationGraceDate; string; Identifies the expiration grace date for the business license application.
  • ExpirationStatus; string; Identifies the expiration status of the business license application.
  • FeeDueUpdateDate; string; The identifier that captures the date when fee item with due status is added or updated.
  • InactReactLicense; string; The comma separated list of all amendment types.
  • InactivateReason; string; Indicates the reason for the inactivation.
  • IssueDate; string; The date the license or permit was issued. Used in the application information component of the Permit Designer.
  • LastUpdateDate; string; Identifies the last updated date of the business license application.
  • LastUpdatedBy; string; Identifies the user ID of the person who last updated the business license application.
  • LastUpdatedByName; string; The user name of the person who last updated the license application.
  • LicensePeriod; string; The duration in which the business license is valid.
  • LicenseStatus; string; The overall status for the business license.
  • LnpRecordId; string; The unique identifier for the record.
  • LnpRecordKey; integer; The identifier for the business license record.
  • LocAltPhoneExtn; string; The additional extension number after initial connection to an internal telephone system.
  • LocAltPhoneNumber; string; The location???s full phone number.
  • LocAltPhoneType; string; The type of phone for the location.
  • LocEmailAddress; string; The business location???s email address.
  • LocPrimaryPhoneExtn; string; The additional extension number after initial connection to an internal telephone system.
  • LocPrimaryPhoneNumber; string; The phone number of the location.
  • LocPrimaryPhoneType; string; The type of phone for the location.
  • LocationAddressOne; string; Address Line 1 as part of the parcel address.
  • LocationAddressTwo; string; Address Line 2 as part of the parcel address.
  • LocationCity; string; The city that is part of the parcel address.
  • LocationCountry; string; The country that is part of the parcel address.
  • LocationCounty; string; The county in which the parcel address is located.
  • LocationPostalCode; string; The postal code that is part of the parcel address.
  • LocationProvince; string; The location information about the province in which the parcel address is located.
  • LocationState; string; The state that is part of the parcel address.
  • MailingAddress1; string; The address portion of the location???s address.
  • MailingAddress2; string; The address portion of the location???s address.
  • MailingCity; string; The city portion of the location???s address.
  • MailingCountry; string; The country portion of the location???s address.
  • MailingCounty; string; The county portion of the location???s address.
  • MailingPostalCode; string; The postal code portion of the location???s address.
  • MailingProvince; string; The province portion of the location???s address.
  • MailingState; string; The state portion of the location???s address.
  • MobileBusFlag; string; Indicates that the business is a mobile business.
  • OrganizationName; string; The business name of the applicant. For example, a contractor enters his or her contracting business name.
  • Originator; string; Identifies the originator of the business license application.
  • ParcelId; integer; The identifier of the record parcel.
  • PermitStatus; string; The status description of the business.
  • PersonFirstName; string; The applicant's first name.
  • PersonLastName; string; The applicant's last name.
  • PersonMiddleName; string; The applicant's middle name.
  • PersonName; string; The license or business license applicant's name.
  • PersonTitle; string; The title of the contact.
  • ReactivateReason; string; Indicates the reason for the reactivation.
  • ReceivedDate; string; Identifies the received date for the license application.
  • RecordStatus; string; The status of the record.
  • RecordType; string; The user-friendly name for the record type.
  • RecordTypeId; string; The identifier for a record type.
  • RenewalDate; string; The renewal date for the license or permit.
  • RequestDetails; string; Indicates the details of the requests.
  • RequestOn; string; Indicates the date of the request.
  • RequestStatus; string; Indicates the status of the request.
  • RequestorEmail; string; Indicates the email of the person requesting the change.
  • RequestorName; string; Indicates the name of the person requesting the change.
  • RequestorPhone; string; Indicates the phone of the person requesting the change.
  • RequestorTitle; string; Indicates the title of the person requesting the change.
  • Subclassification; string; The subclassification code of the business license application type.
  • SubmitDate; string; The date the license transaction was submitted.
  • SubmittedBy; string; Identifies the user ID of the person who submitted the business license application.
  • SubmittedByName; string; The user name of the person who submitted the license application.
  • SystemStatus; string; Identifies the system status of the business license application.
  • TotalFees; integer; The total fees for the license application.
  • TotalHold; number; Identifies the total hold fee amount.
  • TotalOutstanding; number; Identifies the total outstanding fee amount.
  • TotalPaid; integer; The total fees paid for the license application.
  • TotalPayable; number; The total fees paid for the license application.
  • TotalPending; number; Identifies the total pending fee amount.
  • TotalWaived; number; Identifies the total fee waived.
  • Url; string; The URL for the license application.
  • UrlLabel; string; The URL label for the license application.
  • VersionType; string; The version of the business license application.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to 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 : publicSectorBusinessLicenses

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorBusinessLicenses-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"BusinessLicense",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorBusinessLicenses-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorBusinessLicenses-item-response"
    }
}

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 : publicSectorBusinessLicenses-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.
• AcceptanceDate: string (date-time)
  Title: Acceptance Date

  Read Only: true

  Identifies the accepted date for the business license application.
• ActivityDescription: string
  Title: Activity Description

  Read Only: true

  Maximum Length: 1000

  The description for the business license application.
• AddressId: integer (int64)
  Title: Location Address ID

  Read Only: true

  The reference key to the TCA location table.
• AgencyId: integer
  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.
• AmendmentType: string
  Title: Amendment Type

  Read Only: true

  Maximum Length: 1000

  Indicates whether an inactive application should be reactivated from the amendment intake form.
• 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 when the application expires.
• Applicant: integer (int64)
  Read Only: true

  The party ID of the permit applicant.
• ApplicantAddressOne: string
  Title: Applicant Address Line 1

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

  The second line of the business license applicant's address.
• ApplicantBizProfileId: integer (int64)
  Read Only: true

  The business profile used by the applicant.
• ApplicantCity: string
  Title: Applicant City

  Read Only: true

  Maximum Length: 60

  The city in the business license applicant's address.
• ApplicantCountry: string
  Title: Applicant Country

  Read Only: true

  Maximum Length: 3

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

  Read Only: true

  Maximum Length: 60

  The county in the permit applicant's address.
• ApplicantEmailAddressOne: string
  Title: Applicant Email 1

  Read Only: true

  Maximum Length: 320

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

  Read Only: true

  Maximum Length: 320

  The second email address of the business license applicant.
• ApplicantPhoneAreaCode: string
  Title: Applicant Phone Area Code

  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 phone number for the business license applicant.
• ApplicantPostalCode: string
  Title: Applicant Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the permit applicant's address.
• ApplicantProfileId: integer (int64)
  Read Only: true

  The user profile of the applicant.
• ApplicantProvince: string
  Title: Applicant Province

  Read Only: true

  Maximum Length: 60

  The province in the business license applicant's address.
• ApplicantState: string
  Title: Applicant State

  Read Only: true

  Maximum Length: 60

  The state in the permit applicant's address.
• 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: 240

  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.
• BusAddressOne: string
  Title: Business Address 1

  Read Only: true

  Maximum Length: 240

  The address portion of the business??? address.
• BusAddressTwo: 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
  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.
• BusStartDate: string (date-time)
  Title: Proposed Effective Date

  Read Only: true

  This field in the business information component of the form designer is used to enter the date of business establishment.
• BusState: string
  Title: Business State

  Read Only: true

  Maximum Length: 60

  The state portion of the business??? address.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 80

  The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
• CompletedById: string
  Read Only: true

  Maximum Length: 64

  Name of the agency staff who processed the change.
• CompletedByName: string
  Title: Inactivated By

  Read Only: true

  Maximum Length: 255

  Identifies the user name of the person who completed the license application.
• CompletedOn: string (date-time)
  Title: Inactivated On

  Read Only: true

  Indicates the date the change was completed.
• 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

  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.
• EffChangeDate: string (date-time)
  Title: Approved Effective Date

  Read Only: true

  The effective change date of a business license record.
• EffectiveChangeDate: string (date)
  Title: Effective Inactivation Date

  Read Only: true

  The effective date of the license inactivation.
• 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

  Read Only: true

  Maximum Length: 15

  Identifies the expiration status of the business license application.
• 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.
• InactivateReason: string
  Title: Reason for Inactivation

  Read Only: true

  Maximum Length: 30

  Indicates the reason for the inactivation.
• InactReactLicense: string
  Read Only: true

  Maximum Length: 30

  The comma separated list of all amendment types.
• 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

  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 unique identifier for the record.
• LnpRecordKey: integer (int64)
  Read Only: true

  The identifier for the business license 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.
• 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.
• 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.
• PermitStatus: string
  Title: Activity Status

  Read Only: true

  Maximum Length: 100

  The status description of the business.
• PersonFirstName: string
  Title: Applicant First Name

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 450

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

  Read Only: true

  Maximum Length: 60

  The title of the contact.
• ReactivateReason: string
  Read Only: true

  Maximum Length: 30

  Indicates the reason for the reactivation.
• 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
  Title: Record Type ID

  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.
• RequestDetails: string
  Title: Additional Details

  Read Only: true

  Maximum Length: 1000

  Indicates the details of the requests.
• RequestOn: string (date-time)
  Title: Created On

  Read Only: true

  Indicates the date of the request.
• RequestorEmail: string
  Title: Requester Email

  Read Only: true

  Maximum Length: 320

  Indicates the email of the person requesting the change.
• RequestorName: string
  Title: Requester Name

  Read Only: true

  Maximum Length: 450

  Indicates the name of the person requesting the change.
• RequestorPhone: string
  Title: Requester Phone

  Read Only: true

  Maximum Length: 40

  Indicates the phone of the person requesting the change.
• RequestorTitle: string
  Title: Requester Title

  Read Only: true

  Maximum Length: 60

  Indicates the title of the person requesting the change.
• RequestStatus: string
  Read Only: true

  Maximum Length: 30

  Indicates the status of the request.
• Subclassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 80

  The subclassification code 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

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

  Read Only: true

  Maximum Length: 15

  Identifies the system status 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.

{
    "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
        },
        "SubmitDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The date the license transaction was submitted.",
            "format":"date-time",
            "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's middle name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CompletedOn":{
            "title":"Inactivated On",
            "type":"string",
            "description":"Indicates the date the change was completed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":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":{
            "title":"Classification",
            "maxLength":"80",
            "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
        },
        "ApplicantProvince":{
            "title":"Applicant Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the business license applicant's address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "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
        },
        "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
        },
        "ApplicantEmailAddressTwo":{
            "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
        },
        "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",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Applicant Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The applicant's 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
        },
        "BusAddressOne":{
            "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
        },
        "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
        },
        "ApplicantAddressTwo":{
            "title":"Applicant Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the business license applicant's address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "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's first name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantCounty":{
            "title":"Applicant County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the permit applicant's address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The identifier for the business license record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AcceptanceDate":{
            "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
        },
        "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
        },
        "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
        },
        "Applicant":{
            "type":"integer",
            "description":"The party ID of the permit applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "brf:Hide":"true"
            },
            "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
        },
        "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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantAddressOne":{
            "title":"Applicant Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the business license applicant's 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-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CompletedById":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the agency staff who processed the change.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"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
        },
        "CompletedByName":{
            "title":"Inactivated By",
            "maxLength":"255",
            "type":"string",
            "description":"Identifies the user name of the person who completed the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "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
        },
        "BusAddressTwo":{
            "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
        },
        "ApplExpirationDate":{
            "title":"Application Expiration Date",
            "type":"string",
            "description":"The date when the application expires.",
            "format":"date-time",
            "nullable":true,
            "readOnly":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-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "EffectiveChangeDate":{
            "title":"Effective Inactivation Date",
            "type":"string",
            "description":"The effective date of the license inactivation.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Record Type ID",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for a record type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"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":"The user name of the person who last updated the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RecordStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The status of the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantEmailAddressOne":{
            "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
        },
        "RequestOn":{
            "title":"Created On",
            "type":"string",
            "description":"Indicates the date of the request.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusStartDate":{
            "title":"Proposed Effective Date",
            "type":"string",
            "description":"This field in the business information component of the form designer is used to enter the date of business establishment.",
            "format":"date-time",
            "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":{
            "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-hints":{
                "brf:Hide":"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
        },
        "ApplicantCountry":{
            "title":"Applicant Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country in the permit applicant's address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"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
        },
        "ExpirationStatus":{
            "title":"Expiration Status",
            "maxLength":"15",
            "type":"string",
            "description":"Identifies the expiration status 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",
                "brf:Hide":"true"
            },
            "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
        },
        "PermitStatus":{
            "title":"Activity Status",
            "maxLength":"100",
            "type":"string",
            "description":"The status description of the business.",
            "nullable":true,
            "readOnly":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
        },
        "RequestorTitle":{
            "title":"Requester Title",
            "maxLength":"60",
            "type":"string",
            "description":"Indicates the title of the person requesting the change.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RequestStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the status of the request.",
            "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":{
            "title":"Subclassification",
            "maxLength":"80",
            "type":"string",
            "description":"The subclassification code of the business license application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InactReactLicense":{
            "maxLength":"30",
            "type":"string",
            "description":"The comma separated list of all amendment types.",
            "nullable":true,
            "readOnly":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
        },
        "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"
            }
        },
        "RequestorPhone":{
            "title":"Requester Phone",
            "maxLength":"40",
            "type":"string",
            "description":"Indicates the phone of the person requesting the change.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "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":{
            "title":"Applicant Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"The area code in the phone number of the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"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
        },
        "AmendmentType":{
            "title":"Amendment Type",
            "maxLength":"1000",
            "type":"string",
            "description":"Indicates whether an inactive application should be reactivated from the amendment intake form.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantState":{
            "title":"Applicant State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the permit applicant's 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":"The user name of the person who submitted the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "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
        },
        "InactivateReason":{
            "title":"Reason for Inactivation",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the reason for the inactivation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestDetails":{
            "title":"Additional Details",
            "maxLength":"1000",
            "type":"string",
            "description":"Indicates the details of the requests.",
            "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
        },
        "ReactivateReason":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the reason for the reactivation.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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":"The user name of the person who created the license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ActivityDescription":{
            "title":"Activity Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description for the business 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
        },
        "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
        },
        "ApplicantCity":{
            "title":"Applicant City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the business license applicant's address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "EffChangeDate":{
            "title":"Approved Effective Date",
            "type":"string",
            "description":"The effective change date of a business license record.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "RecordType":{
            "title":"License Type",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly name for the record type.",
            "nullable":true,
            "readOnly":true,
            "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":"240",
            "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
        },
        "ApplicantPostalCode":{
            "title":"Applicant Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the permit applicant's address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RequestorName":{
            "title":"Requester Name",
            "maxLength":"450",
            "type":"string",
            "description":"Indicates the name of the person requesting the change.",
            "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",
            "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 unique identifier for the record.",
            "nullable":true,
            "readOnly":true,
            "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's 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 phone number for the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RequestorEmail":{
            "title":"Requester Email",
            "maxLength":"320",
            "type":"string",
            "description":"Indicates the email of the person requesting the change.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "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
        }
    }
}

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