Jump to

• Request
• Response

Get a business license expiry communication item

get

/fscmRestApi/resources/11.13.18.05/publicSectorBlExpiryCommunications/{LnpRecordKey}

Request

Path Parameters

• LnpRecordKey: integer
  The unique identifier for the record.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorBlExpiryCommunications-item

Type: object

Show Source

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

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

  Maximum Length: 240

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

  Maximum Length: 240

  The second line of the business license applicant address.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  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.
• AltPhoneAreaCode(optional): string
  Maximum Length: 10

  The alternate phone area code in the business license mailing address.
• AltPhoneCountryCode(optional): string
  Maximum Length: 10

  The alternate phone country code in the business license mailing address.
• AltPhoneExtension(optional): string
  Maximum Length: 20

  The alternate phone extension in the business license mailing address.
• AltPhoneNumber(optional): string
  Maximum Length: 40

  The alternate phone number in the business license mailing address.
• ApplAteDate(optional): string(date-time)
  The date to indicate when the application is about to expire.
• ApplExpirationDate(optional): string(date-time)
  Title: Application Expiration Date

  The date when the application expires.
• Applicant(optional): integer(int64)
  Title: Applicant

  The party identifier of the business license applicant.
• Balancedue(optional): number
  Title: Total Due

  The application balance due amount.
• BusAddress1(optional): string
  Title: Address 1

  Maximum Length: 240

  The first line of the business license location address.
• BusAddress2(optional): string
  Title: Address 2

  Maximum Length: 240

  The second line of the business license location address.
• BusagentAddress1(optional): string
  Maximum Length: 240

  The first line of the business entity authorized agent address.
• BusagentAddress2(optional): string
  Maximum Length: 240

  The second line of the business entity authorized agent address.
• BusagentCity(optional): string
  Maximum Length: 60

  The city of the business entity authorized agent address.
• BusagentCountry(optional): string
  Maximum Length: 60

  The country of the business entity authorized agent address.
• BusagentCounty(optional): string
  Maximum Length: 60

  The county of the business entity authorized agent address.
• BusagentEmailAddress(optional): string
  Maximum Length: 320

  The email address of the business entity authorized agent.
• BusagentPersonName(optional): string
  Maximum Length: 450

  The name of the business entity authorized agent.
• BusagentPhoneAreaCode(optional): string
  Maximum Length: 10

  The phone area code of the business entity authorized agent.
• BusagentPhoneCountryCode(optional): string
  Maximum Length: 10

  The phone country code of the business entity authorized agent.
• BusagentPhoneExtension(optional): string
  Maximum Length: 40

  The phone extension of the business entity authorized agent.
• BusagentPhoneNumber(optional): string
  Maximum Length: 40

  The phone number of the business entity authorized agent.
• BusagentPostalCode(optional): string
  Maximum Length: 60

  The postal code of the business entity authorized agent address.
• BusagentProvince(optional): string
  Maximum Length: 60

  The province of the business entity authorized agent address.
• BusagentState(optional): string
  Maximum Length: 60

  The state of the business entity authorized agent address.
• BusBusinessLegalName(optional): string
  Title: Legal Name

  Maximum Length: 240

  The legal name of the business entity.
• BusCategory(optional): string
  Title: Category

  Maximum Length: 50

  The category of the business location.
• BusCity(optional): string
  Title: City

  Maximum Length: 60

  The city in the business license location address.
• BusDbaBusinessName(optional): string
  Title: DBA

  Maximum Length: 100

  The DBA business name of the business location.
• BusDescription(optional): string
  Title: Business Description

  Maximum Length: 200

  The description of the business location.
• BusDisadvOwnedFlag(optional): string
  Title: Disadvantaged Enterprise Owned

  Maximum Length: 1

  Indicates if a person with disadvantage owns the business entity.
• BusExemptFlag(optional): string
  Maximum Length: 1

  The tax exempt flag of the business entity.
• BusExemptPct(optional): number
  The tax exemption percentage of the business entity.
• BusExemptType(optional): string
  Maximum Length: 30

  The tax exemption type of the business entity.
• BusFemaleOwnedFlag(optional): string
  Title: Female Owned

  Maximum Length: 1

  Indicates if a female owns the business entity.
• BuslocCountry(optional): string
  Title: Country

  Maximum Length: 3

  The country in the business license location address.
• BuslocEmailAddress(optional): string
  Maximum Length: 320

  The email address of the business location.
• BuslocPostalCode(optional): string
  Title: Postal Code

  Maximum Length: 60

  The postal code in the business license location address.
• BuslocProvince(optional): string
  Title: Province

  Maximum Length: 60

  The province in the business license applicant address.
• BuslocState(optional): string
  Title: State

  Maximum Length: 60

  The state in the business license location address.
• BusMinorityOwnedFlag(optional): string
  Title: Minority Owned

  Maximum Length: 1

  Indicates if a person from minority group owns the business entity.
• BusNaicsCode(optional): string
  Maximum Length: 30

  The NAICS code of business license.
• BusownAddress1(optional): string
  Maximum Length: 240

  The first line of the business entity owner address.
• BusownAddress2(optional): string
  Maximum Length: 240

  The second line of the business entity owner address.
• BusownCity(optional): string
  Maximum Length: 60

  The city of the business entity owner address.
• BusownCountry(optional): string
  Maximum Length: 3

  The country of the business entity owner.
• BusownCounty(optional): string
  Maximum Length: 60

  The county of the business entity owner address.
• BusownEmailAddress(optional): string
  Maximum Length: 320

  The email address of the business entity owner address.
• BusownMailingAddress1(optional): string
  Maximum Length: 240

  The first line of the business entity owner mailing address.
• BusownMailingAddress2(optional): string
  Maximum Length: 240

  The second line of the business entity owner mailing address.
• BusownMailingCity(optional): string
  Maximum Length: 60

  The city of the business entity owner mailing address.
• BusownMailingCountry(optional): string
  Maximum Length: 3

  The country of the business entity owner mailing address.
• BusownMailingCounty(optional): string
  Maximum Length: 60

  The county of the business entity owner mailing address.
• BusownMailingPostalCode(optional): string
  Maximum Length: 60

  The postal code of the business entity owner mailing address.
• BusownMailingProvince(optional): string
  Maximum Length: 60

  The province of the business entity owner mailing address.
• BusownMailingState(optional): string
  Maximum Length: 60

  The state of the business entity owner mailing address.
• BusownPersonName(optional): string
  Maximum Length: 450

  The name of the business entity owner.
• BusownPhoneAreaCode(optional): string
  Maximum Length: 10

  The phone area code of the business entity owner address.
• BusownPhoneCountryCode(optional): string
  Maximum Length: 10

  The phone country code of the business entity owner address.
• BusownPhoneExtension(optional): string
  Maximum Length: 20

  The phone extension of the business entity owner address.
• BusownPhoneNumber(optional): string
  Maximum Length: 40

  The phone number of the business entity owner address.
• BusownPostalCode(optional): string
  Maximum Length: 60

  The postal code of the business entity owner address.
• BusownProvince(optional): string
  Maximum Length: 60

  The province of the business entity owner address.
• BusownState(optional): string
  Maximum Length: 60

  The state of the business entity owner address.
• BusSmallBusFlag(optional): string
  Maximum Length: 1

  Indicates if the business entity is a small business.
• BusSubCategory(optional): string
  Title: Subcategory

  Maximum Length: 50

  The sub category of the business location.
• BusVeteranOwnedFlag(optional): string
  Maximum Length: 1

  Indicates if a veteran owns the business entity.
• City(optional): string
  Title: Applicant City

  Maximum Length: 60

  The city in the business license applicant address.
• Classification(optional): string
  Title: Classification

  Maximum Length: 3

  The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
• Country(optional): string
  Title: Applicant Country

  Maximum Length: 3

  The country in the business license applicant address.
• County(optional): string
  Title: Applicant County

  Maximum Length: 60

  The county in the business license applicant address.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the record.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The user who last updated the record.
• DelinquentDate(optional): string(date-time)
  Title: Delinquent Date

  The date the license becomes delinquent.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The status of the business license record.
• EmailAddress1(optional): string
  Title: Applicant Email 1

  Maximum Length: 320

  The first email address of the business license applicant.
• EmailAddress2(optional): string
  Maximum Length: 320

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

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

  The application expiry grace date.
• GracePeriod(optional): integer(int64)
  Title: Grace Period

  The grace period for the application expiry.
• GracePeriodUom(optional): string
  Title: Grace Period UOM

  Maximum Length: 5

  The grace period unit for the application expiry.
• IssueDate(optional): string(date-time)
  Title: Issued On

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

  The date when the record was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The date when the record was created.
• LicDescription(optional): string
  Title: Description

  Maximum Length: 1000

  The description of the business license type.
• LicenseFinancialStatus(optional): string
  Maximum Length: 30

  The financial status of business license.
• LicenseStatus(optional): string
  Title: Status

  Maximum Length: 30

  The status of business license.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Permit ID

  Maximum Length: 50

  The identifier for the business license record. For example, a license number with a value such as Business License ID RA-2017-00029.
• LnpRecordKey(optional): integer(int64)
  The unique identifier for the record.
• MailingAddress1(optional): string
  Maximum Length: 240

  The first line of the business license mailing address.
• MailingAddress2(optional): string
  Maximum Length: 240

  The second line of the business license mailing address.
• MailingCity(optional): string
  Maximum Length: 60

  The city in the business license mailing address.
• MailingCountry(optional): string
  Maximum Length: 3

  The country in the business license mailing address.
• MailingCounty(optional): string
  Maximum Length: 60

  The county in the business license mailing address.
• MailingPostalCode(optional): string
  Maximum Length: 60

  The postal code in the business license mailing address.
• MailingPostalPlusFourCode(optional): string
  Maximum Length: 10

  The postal plus code in the business license mailing address.
• MailingProvince(optional): string
  Maximum Length: 60

  The province in the business license mailing address.
• MailingState(optional): string
  Maximum Length: 60

  The state in the business license mailing address.
• OriginalIssueDate(optional): string(date-time)
  The original issue date of business license.
• PersonName(optional): string
  Title: Applicant Name

  Maximum Length: 450

  The permit applicant name.
• PhoneAreaCode(optional): string
  Title: Applicant Phone Area Code

  Maximum Length: 10

  The area code in the phone number of the business license applicant.
• PhoneCountryCode(optional): string
  Title: Applicant Phone Country Code

  Maximum Length: 10

  The country code in the phone number of the business license applicant.
• PhoneExtension(optional): string
  Title: Applicant Phone Extension

  Maximum Length: 20

  The phone number extension of the business license applicant.
• PhoneNumber(optional): string
  Title: Applicant Phone Number

  Maximum Length: 40

  The permit applicant phone number.
• PostalCode(optional): string
  Title: Applicant Postal Code

  Maximum Length: 60

  The postal code in the business license applicant address.
• Primarycontactemail(optional): string
  Title: Contact Email

  Maximum Length: 320

  The application primary contact email.
• Primarycontactname(optional): string
  Title: Location Contact

  Maximum Length: 450

  The application primary contact name.
• Primarycontactphone(optional): string
  Title: Contact Phone Number

  Maximum Length: 60

  The application primary contact phone.
• PrimaryPhoneAreaCode(optional): string
  Maximum Length: 10

  The primary phone area code in the business license mailing address.
• PrimaryPhoneCountryCode(optional): string
  Maximum Length: 10

  The primary phone country code in the business license mailing address.
• PrimaryPhoneExtension(optional): string
  Maximum Length: 20

  The primary phone extension in the business license mailing address.
• PrimaryPhoneNumber(optional): string
  Maximum Length: 40

  The primary phone number in the business license mailing address.
• ProjectKey(optional): integer(int64)
  Title: Project

  The project name information for a business license.
• Province(optional): string
  Title: Applicant Province

  Maximum Length: 60

  The province in the business license applicant address.
• RecordStatus(optional): string
  Title: Status

  Maximum Length: 15

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

  Maximum Length: 100

  The business license type. Agencies define the types of licenses that they administer.
• RenewalDate(optional): string(date-time)
  Title: Renewal Date

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

  Maximum Length: 60

  The state in the business license applicant address.
• SubmitDate(optional): string(date-time)
  Title: Submission Date

  The date the license and business license transaction was submitted. Used in the application information component of the Business License Designer.
• SubmittedBy(optional): string
  Title: Submitted By

  Maximum Length: 64

  The user who submitted the application.
• Username(optional): string
  Title: Applicant User ID

  Maximum Length: 100

  The user ID of the business license applicant.

{
    "properties":{
        "AboutToExpireDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the notification about an expiring license or permit is sent.",
            "title":"About to Expire Date"
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the business license applicant address.",
            "title":"Applicant Address Line 1"
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the business license applicant address.",
            "title":"Applicant Address Line 2"
        },
        "AgencyId":{
            "format":"int32",
            "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.",
            "title":"Agency ID"
        },
        "AltPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The alternate phone area code in the business license mailing address."
        },
        "AltPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The alternate phone country code in the business license mailing address."
        },
        "AltPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The alternate phone extension in the business license mailing address."
        },
        "AltPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The alternate phone number in the business license mailing address."
        },
        "ApplAteDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date to indicate when the application is about to expire."
        },
        "ApplExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the application expires.",
            "title":"Application Expiration Date"
        },
        "Applicant":{
            "format":"int64",
            "type":"integer",
            "description":"The party identifier of the business license applicant.",
            "title":"Applicant"
        },
        "Balancedue":{
            "type":"number",
            "description":"The application balance due amount.",
            "title":"Total Due"
        },
        "BusAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the business license location address.",
            "title":"Address 1"
        },
        "BusAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the business license location address.",
            "title":"Address 2"
        },
        "BusBusinessLegalName":{
            "maxLength":240,
            "type":"string",
            "description":"The legal name of the business entity.",
            "title":"Legal Name"
        },
        "BusCategory":{
            "maxLength":50,
            "type":"string",
            "description":"The category of the business location.",
            "title":"Category"
        },
        "BusCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the business license location address.",
            "title":"City"
        },
        "BusDbaBusinessName":{
            "maxLength":100,
            "type":"string",
            "description":"The DBA business name of the business location.",
            "title":"DBA"
        },
        "BusDescription":{
            "maxLength":200,
            "type":"string",
            "description":"The description of the business location.",
            "title":"Business Description"
        },
        "BusDisadvOwnedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if a person with disadvantage owns the business entity.",
            "title":"Disadvantaged Enterprise Owned"
        },
        "BusExemptFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The tax exempt flag of the business entity."
        },
        "BusExemptPct":{
            "type":"number",
            "description":"The tax exemption percentage of the business entity."
        },
        "BusExemptType":{
            "maxLength":30,
            "type":"string",
            "description":"The tax exemption type of the business entity."
        },
        "BusFemaleOwnedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if a female owns the business entity.",
            "title":"Female Owned"
        },
        "BusMinorityOwnedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if a person from minority group owns the business entity.",
            "title":"Minority Owned"
        },
        "BusNaicsCode":{
            "maxLength":30,
            "type":"string",
            "description":"The NAICS code of business license."
        },
        "BusSmallBusFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the business entity is a small business."
        },
        "BusSubCategory":{
            "maxLength":50,
            "type":"string",
            "description":"The sub category of the business location.",
            "title":"Subcategory"
        },
        "BusVeteranOwnedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if a veteran owns the business entity."
        },
        "BusagentAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the business entity authorized agent address."
        },
        "BusagentAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the business entity authorized agent address."
        },
        "BusagentCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the business entity authorized agent address."
        },
        "BusagentCountry":{
            "maxLength":60,
            "type":"string",
            "description":"The country of the business entity authorized agent address."
        },
        "BusagentCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the business entity authorized agent address."
        },
        "BusagentEmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the business entity authorized agent."
        },
        "BusagentPersonName":{
            "maxLength":450,
            "type":"string",
            "description":"The name of the business entity authorized agent."
        },
        "BusagentPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code of the business entity authorized agent."
        },
        "BusagentPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code of the business entity authorized agent."
        },
        "BusagentPhoneExtension":{
            "maxLength":40,
            "type":"string",
            "description":"The phone extension of the business entity authorized agent."
        },
        "BusagentPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the business entity authorized agent."
        },
        "BusagentPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the business entity authorized agent address."
        },
        "BusagentProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the business entity authorized agent address."
        },
        "BusagentState":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the business entity authorized agent address."
        },
        "BuslocCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country in the business license location address.",
            "title":"Country"
        },
        "BuslocEmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the business location."
        },
        "BuslocPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the business license location address.",
            "title":"Postal Code"
        },
        "BuslocProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the business license applicant address.",
            "title":"Province"
        },
        "BuslocState":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the business license location address.",
            "title":"State"
        },
        "BusownAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the business entity owner address."
        },
        "BusownAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the business entity owner address."
        },
        "BusownCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the business entity owner address."
        },
        "BusownCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the business entity owner."
        },
        "BusownCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the business entity owner address."
        },
        "BusownEmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the business entity owner address."
        },
        "BusownMailingAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the business entity owner mailing address."
        },
        "BusownMailingAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the business entity owner mailing address."
        },
        "BusownMailingCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the business entity owner mailing address."
        },
        "BusownMailingCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the business entity owner mailing address."
        },
        "BusownMailingCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the business entity owner mailing address."
        },
        "BusownMailingPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the business entity owner mailing address."
        },
        "BusownMailingProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the business entity owner mailing address."
        },
        "BusownMailingState":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the business entity owner mailing address."
        },
        "BusownPersonName":{
            "maxLength":450,
            "type":"string",
            "description":"The name of the business entity owner."
        },
        "BusownPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code of the business entity owner address."
        },
        "BusownPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code of the business entity owner address."
        },
        "BusownPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone extension of the business entity owner address."
        },
        "BusownPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the business entity owner address."
        },
        "BusownPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the business entity owner address."
        },
        "BusownProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the business entity owner address."
        },
        "BusownState":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the business entity owner address."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the business license applicant address.",
            "title":"Applicant City"
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The record classification. The classifications can be permit, business license, professional license, or planning and zoning.",
            "title":"Classification"
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country in the business license applicant address.",
            "title":"Applicant Country"
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county in the business license applicant address.",
            "title":"Applicant County"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who last updated the record.",
            "title":"Creation Date"
        },
        "DelinquentDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license becomes delinquent.",
            "title":"Delinquent Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The status of the business license record.",
            "title":"Description"
        },
        "EmailAddress1":{
            "maxLength":320,
            "type":"string",
            "description":"The first email address of the business license applicant.",
            "title":"Applicant Email 1"
        },
        "EmailAddress2":{
            "maxLength":320,
            "type":"string",
            "description":"The second email address of the business license applicant."
        },
        "ExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license or permit is no longer valid.",
            "title":"Expiration Date"
        },
        "ExpirationGraceDate":{
            "format":"date-time",
            "type":"string",
            "description":"The application expiry grace date.",
            "title":"Grace Period End Date"
        },
        "GracePeriod":{
            "format":"int64",
            "type":"integer",
            "description":"The grace period for the application expiry.",
            "title":"Grace Period"
        },
        "GracePeriodUom":{
            "maxLength":5,
            "type":"string",
            "description":"The grace period unit for the application expiry.",
            "title":"Grace Period UOM"
        },
        "IssueDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license or permit was issued. Used in the application information component of the Business License Designer.",
            "title":"Issued On"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date when the record was created.",
            "title":"Last Updated By"
        },
        "LicDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the business license type.",
            "title":"Description"
        },
        "LicenseFinancialStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The financial status of business license."
        },
        "LicenseStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of business license.",
            "title":"Status"
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier for the business license record. For example, a license number with a value such as Business License ID RA-2017-00029.",
            "title":"Permit ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the record."
        },
        "MailingAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the business license mailing address."
        },
        "MailingAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the business license mailing address."
        },
        "MailingCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the business license mailing address."
        },
        "MailingCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country in the business license mailing address."
        },
        "MailingCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county in the business license mailing address."
        },
        "MailingPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the business license mailing address."
        },
        "MailingPostalPlusFourCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code in the business license mailing address."
        },
        "MailingProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the business license mailing address."
        },
        "MailingState":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the business license mailing address."
        },
        "OriginalIssueDate":{
            "format":"date-time",
            "type":"string",
            "description":"The original issue date of business license."
        },
        "PersonName":{
            "maxLength":450,
            "type":"string",
            "description":"The permit applicant name.",
            "title":"Applicant Name"
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code in the phone number of the business license applicant.",
            "title":"Applicant Phone Area Code"
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code in the phone number of the business license applicant.",
            "title":"Applicant Phone Country Code"
        },
        "PhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone number extension of the business license applicant.",
            "title":"Applicant Phone Extension"
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The permit applicant phone number.",
            "title":"Applicant Phone Number"
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the business license applicant address.",
            "title":"Applicant Postal Code"
        },
        "PrimaryPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The primary phone area code in the business license mailing address."
        },
        "PrimaryPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The primary phone country code in the business license mailing address."
        },
        "PrimaryPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The primary phone extension in the business license mailing address."
        },
        "PrimaryPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The primary phone number in the business license mailing address."
        },
        "Primarycontactemail":{
            "maxLength":320,
            "type":"string",
            "description":"The application primary contact email.",
            "title":"Contact Email"
        },
        "Primarycontactname":{
            "maxLength":450,
            "type":"string",
            "description":"The application primary contact name.",
            "title":"Location Contact"
        },
        "Primarycontactphone":{
            "maxLength":60,
            "type":"string",
            "description":"The application primary contact phone.",
            "title":"Contact Phone Number"
        },
        "ProjectKey":{
            "format":"int64",
            "type":"integer",
            "description":"The project name information for a business license.",
            "title":"Project"
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the business license applicant address.",
            "title":"Applicant Province"
        },
        "RecordStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the record.",
            "title":"Status"
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The business license type. Agencies define the types of licenses that they administer.",
            "title":"License Type"
        },
        "RenewalDate":{
            "format":"date-time",
            "type":"string",
            "description":"The renewal date for the license or permit.",
            "title":"Renewal Date"
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the business license applicant address.",
            "title":"Applicant State"
        },
        "SubmitDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license and business license transaction was submitted. Used in the application information component of the Business License Designer.",
            "title":"Submission Date"
        },
        "SubmittedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who submitted the application.",
            "title":"Submitted By"
        },
        "Username":{
            "maxLength":100,
            "type":"string",
            "description":"The user ID of the business license applicant.",
            "title":"Applicant User ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top