Get a business license expiry communication item
get
/fscmRestApi/resources/11.13.18.05/publicSectorBlExpiryCommunications/{LnpRecordKey}
Request
Path Parameters
-
LnpRecordKey(required): integer(int64)
The unique identifier for the record.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorBlExpiryCommunications-item-response
Type:
Show Source
object
-
AboutToExpireDate: string
(date-time)
Title:
About to Expire Date
Read Only:true
The date when the notification about an expiring license or permit is sent. -
Address1: string
Title:
Applicant Address Line 1
Read Only:true
Maximum Length:240
The first line of the business license applicant address. -
Address2: string
Title:
Applicant Address Line 2
Read Only:true
Maximum Length:240
The second line of the business license applicant address. -
AgencyId: integer
(int32)
Title:
Agency ID
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. -
AltPhoneAreaCode: string
Read Only:
true
Maximum Length:10
The alternate phone area code in the business license mailing address. -
AltPhoneCountryCode: string
Read Only:
true
Maximum Length:10
The alternate phone country code in the business license mailing address. -
AltPhoneExtension: string
Title:
Location Alternate Phone Extension
Read Only:true
Maximum Length:20
The alternate phone extension in the business license mailing address. -
AltPhoneNumber: string
Title:
Location Alternate Phone Number
Read Only:true
Maximum Length:40
The alternate phone number in the business license mailing address. -
ApplAteDate: string
(date-time)
Title:
Application About to Expire Date
Read Only:true
The date to indicate when the application is about to expire. -
ApplExpirationDate: string
(date-time)
Title:
Application Expiration Date
Read Only:true
The date when the application expires. -
Applicant: integer
(int64)
Title:
Applicant
Read Only:true
The party identifier of the business license applicant. -
AssignedSpecialistEmail: string
Title:
Assigned Specialist Email
Read Only:true
Maximum Length:255
The email of the specialist assigned to the application. -
AssignedSpecialistName: string
Title:
Assigned Specialist Name
Read Only:true
Maximum Length:255
The name of the specialist assigned to the application. -
AssignedSpecialistUserid: string
Title:
Assigned Specialist User ID
Read Only:true
Maximum Length:64
The user ID of the specialist assigned to the application. -
Balancedue: number
Title:
Fees Balance Due
Read Only:true
The application balance due amount. -
BusAddress1: string
Title:
Location Address Line 1
Read Only:true
Maximum Length:240
The first line of the business license location address. -
BusAddress2: string
Title:
Location Address Line 2
Read Only:true
Maximum Length:240
The second line of the business license location address. -
BusagentAddress1: string
Title:
Authorized Agent Address 1
Read Only:true
Maximum Length:240
The first line of the business entity authorized agent address. -
BusagentAddress2: string
Title:
Authorized Agent Address 2
Read Only:true
Maximum Length:240
The second line of the business entity authorized agent address. -
BusagentCity: string
Title:
Authorized Agent City
Read Only:true
Maximum Length:60
The city of the business entity authorized agent address. -
BusagentCountry: string
Title:
Authorized Agent Country
Read Only:true
Maximum Length:60
The country of the business entity authorized agent address. -
BusagentCounty: string
Title:
Authorized Agent County
Read Only:true
Maximum Length:60
The county of the business entity authorized agent address. -
BusagentEmailAddress: string
Title:
Authorized Agent Email
Read Only:true
Maximum Length:320
The email address of the business entity authorized agent. -
BusagentPersonName: string
Title:
Authorized Agent
Read Only:true
Maximum Length:450
The name of the business entity authorized agent. -
BusagentPhoneAreaCode: string
Read Only:
true
Maximum Length:10
The phone area code of the business entity authorized agent. -
BusagentPhoneCountryCode: string
Read Only:
true
Maximum Length:10
The phone country code of the business entity authorized agent. -
BusagentPhoneExtension: string
Title:
Authorized Agent Phone Extension
Read Only:true
Maximum Length:40
The phone extension of the business entity authorized agent. -
BusagentPhoneNumber: string
Title:
Authorized Agent Phone Number
Read Only:true
Maximum Length:40
The phone number of the business entity authorized agent. -
BusagentPostalCode: string
Title:
Authorized Agent Postal Code
Read Only:true
Maximum Length:60
The postal code of the business entity authorized agent address. -
BusagentProvince: string
Title:
Authorized Agent Province
Read Only:true
Maximum Length:60
The province of the business entity authorized agent address. -
BusagentState: string
Title:
Authorized Agent State
Read Only:true
Maximum Length:60
The state of the business entity authorized agent address. -
BusBusinessLegalName: string
Title:
Business Legal Name
Read Only:true
Maximum Length:240
The legal name of the business entity. -
BusCategory: string
Title:
Location Category
Read Only:true
Maximum Length:50
The category of the business location. -
BusCity: string
Title:
Location City
Read Only:true
Maximum Length:60
The city in the business license location address. -
BusDbaBusinessName: string
Title:
Doing Business As
Read Only:true
Maximum Length:100
The DBA business name of the business location. -
BusDescription: string
Title:
Business Description
Read Only:true
Maximum Length:200
The description of the business location. -
BusDisadvOwnedFlag: string
Title:
Disadvantaged Enterprise
Read Only:true
Maximum Length:1
Indicates if a person with disadvantage owns the business entity. -
BusExemptFlag: string
Title:
Tax Exempt
Read Only:true
Maximum Length:1
The tax exempt flag of the business entity. -
BusExemptPct: number
Read Only:
true
The tax exemption percentage of the business entity. -
BusExemptType: string
Title:
Exempt Type
Read Only:true
Maximum Length:30
The tax exemption type of the business entity. -
BusFemaleOwnedFlag: string
Title:
Female Owned
Read Only:true
Maximum Length:1
Indicates if a female owns the business entity. -
BuslocCountry: string
Title:
Location Country
Read Only:true
Maximum Length:3
The country in the business license location address. -
BuslocEmailAddress: string
Title:
Location Primary Email
Read Only:true
Maximum Length:320
The email address of the business location. -
BuslocPostalCode: string
Title:
Location Postal Code
Read Only:true
Maximum Length:60
The postal code in the business license location address. -
BuslocProvince: string
Title:
Location Province
Read Only:true
Maximum Length:60
The province in the business license applicant address. -
BuslocState: string
Title:
Location State
Read Only:true
Maximum Length:60
The state in the business license location address. -
BusMinorityOwnedFlag: string
Title:
Minority Owned
Read Only:true
Maximum Length:1
Indicates if a person from minority group owns the business entity. -
BusownAddress1: string
Title:
Business Owner Address 1
Read Only:true
Maximum Length:240
The first line of the business entity owner address. -
BusownAddress2: string
Title:
Business Owner Address 2
Read Only:true
Maximum Length:240
The second line of the business entity owner address. -
BusownCity: string
Title:
Business Owner City
Read Only:true
Maximum Length:60
The city of the business entity owner address. -
BusownCountry: string
Title:
Business Owner Country
Read Only:true
Maximum Length:3
The country of the business entity owner. -
BusownCounty: string
Title:
Business Owner County
Read Only:true
Maximum Length:60
The county of the business entity owner address. -
BusownEmailAddress: string
Title:
Business Owner Email
Read Only:true
Maximum Length:320
The email address of the business entity owner address. -
BusownMailingAddress1: string
Title:
Business Owner Mailing Address 1
Read Only:true
Maximum Length:240
The first line of the business entity owner mailing address. -
BusownMailingAddress2: string
Title:
Business Owner Mailing Address 2
Read Only:true
Maximum Length:240
The second line of the business entity owner mailing address. -
BusownMailingCity: string
Title:
Business Owner Mailing City
Read Only:true
Maximum Length:60
The city of the business entity owner mailing address. -
BusownMailingCountry: string
Title:
Business Owner Mailing Country
Read Only:true
Maximum Length:3
The country of the business entity owner mailing address. -
BusownMailingCounty: string
Title:
Business Owner Mailing County
Read Only:true
Maximum Length:60
The county of the business entity owner mailing address. -
BusownMailingPostalCode: string
Title:
Business Owner Mailing Postal Code
Read Only:true
Maximum Length:60
The postal code of the business entity owner mailing address. -
BusownMailingProvince: string
Title:
Business Owner Mailing Province
Read Only:true
Maximum Length:60
The province of the business entity owner mailing address. -
BusownMailingState: string
Title:
Business Owner Mailing State
Read Only:true
Maximum Length:60
The state of the business entity owner mailing address. -
BusownPersonName: string
Title:
Business Owner Name
Read Only:true
Maximum Length:450
The name of the business entity owner. -
BusownPhoneAreaCode: string
Read Only:
true
Maximum Length:10
The phone area code of the business entity owner address. -
BusownPhoneCountryCode: string
Read Only:
true
Maximum Length:10
The phone country code of the business entity owner address. -
BusownPhoneExtension: string
Title:
Business Owner Phone Extension
Read Only:true
Maximum Length:20
The phone extension of the business entity owner address. -
BusownPhoneNumber: string
Title:
Business Owner Phone
Read Only:true
Maximum Length:40
The phone number of the business entity owner address. -
BusownPostalCode: string
Title:
Business Owner Postal Code
Read Only:true
Maximum Length:60
The postal code of the business entity owner address. -
BusownProvince: string
Title:
Business Owner Province
Read Only:true
Maximum Length:60
The province of the business entity owner address. -
BusownState: string
Title:
Business Owner State
Read Only:true
Maximum Length:60
The state of the business entity owner address. -
BusSmallBusFlag: string
Title:
Small Business
Read Only:true
Maximum Length:1
Indicates if the business entity is a small business. -
BusSubCategory: string
Title:
Subcategory
Read Only:true
Maximum Length:50
The sub category of the business location. -
BusVeteranOwnedFlag: string
Title:
Veteran Owned
Read Only:true
Maximum Length:1
Indicates if a veteran owns the business entity. -
City: string
Title:
Applicant City
Read Only:true
Maximum Length:60
The city in the business license applicant address. -
Classification: string
Title:
Classification
Read Only:true
Maximum Length:3
The record classification. The classifications can be permit, business license, professional license, or planning and zoning. -
Country: string
Title:
Applicant Country
Read Only:true
Maximum Length:3
The country in the business license applicant address. -
County: string
Title:
Applicant County
Read Only:true
Maximum Length:60
The county in the business license applicant address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The user who last updated the record. -
DelinquentDate: string
(date-time)
Title:
Delinquent Date
Read Only:true
The date the license becomes delinquent. -
Description: string
Title:
Application Status
Read Only:true
Maximum Length:100
The status of the business license record. -
EmailAddress1: string
Title:
Applicant Email 1
Read Only:true
Maximum Length:320
The first email address of the business license applicant. -
EmailAddress2: string
Title:
Applicant Email 2
Read Only:true
Maximum Length:320
The second email address of the business license applicant. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Read Only:true
The date the license or permit is no longer valid. -
ExpirationGraceDate: string
(date-time)
Title:
Grace Period Date
Read Only:true
The application expiry grace date. -
GracePeriod: integer
(int64)
Title:
Grace Period
Read Only:true
The grace period for the application expiry. -
GracePeriodUom: string
Title:
Grace Period UOM
Read Only:true
Maximum Length:5
The grace period unit for the application expiry. -
IssueDate: string
(date-time)
Title:
Issued On
Read Only:true
The date the license or permit was issued. Used in the application information component of the Business License Designer. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the record was created. -
LicDescription: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the business license type. -
LicenseFinancialStatus: string
Read Only:
true
Maximum Length:30
The financial status of business license. -
LicenseStatus: string
Title:
License Status
Read Only:true
Maximum Length:30
The status of business license. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Application ID
Read Only:true
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: integer
(int64)
Read Only:
true
The unique identifier for the record. -
MailingAddress1: string
Title:
Mailing Address Line 1
Read Only:true
Maximum Length:240
The first line of the business license mailing address. -
MailingAddress2: string
Title:
Mailing Address Line 2
Read Only:true
Maximum Length:240
The second line of the business license mailing address. -
MailingCity: string
Title:
Mailing Address City
Read Only:true
Maximum Length:60
The city in the business license mailing address. -
MailingCountry: string
Title:
Mailing Address Country
Read Only:true
Maximum Length:3
The country in the business license mailing address. -
MailingCounty: string
Title:
Mailing Address County
Read Only:true
Maximum Length:60
The county in the business license mailing address. -
MailingPostalCode: string
Title:
Mailing Address Postal Code
Read Only:true
Maximum Length:60
The postal code in the business license mailing address. -
MailingPostalPlusFourCode: string
Read Only:
true
Maximum Length:10
The postal plus code in the business license mailing address. -
MailingProvince: string
Title:
Mailing Address Province
Read Only:true
Maximum Length:60
The province in the business license mailing address. -
MailingState: string
Title:
Mailing Address State
Read Only:true
Maximum Length:60
The state in the business license mailing address. -
OriginalIssueDate: string
(date-time)
Read Only:
true
The original issue date of business license. -
PersonName: string
Title:
Applicant Name
Read Only:true
Maximum Length:450
The permit applicant name. -
PhoneAreaCode: string
Read Only:
true
Maximum Length:10
The area code in the phone number of the business license applicant. -
PhoneCountryCode: string
Read Only:
true
Maximum Length:10
The country code in the phone number of the business license applicant. -
PhoneExtension: string
Title:
Applicant Phone Extension
Read Only:true
Maximum Length:20
The phone number extension of the business license applicant. -
PhoneNumber: string
Title:
Applicant Phone Number
Read Only:true
Maximum Length:40
The permit applicant phone number. -
PostalCode: string
Title:
Applicant Postal Code
Read Only:true
Maximum Length:60
The postal code in the business license applicant address. -
Primarycontactemail: string
Title:
Primary Contact Email
Read Only:true
Maximum Length:320
The application primary contact email. -
Primarycontactname: string
Title:
Primary Contact
Read Only:true
Maximum Length:450
The application primary contact name. -
Primarycontactphone: string
Title:
Primary Contact Phone Number
Read Only:true
Maximum Length:60
The application primary contact phone. -
PrimaryPhoneAreaCode: string
Read Only:
true
Maximum Length:10
The primary phone area code in the business license mailing address. -
PrimaryPhoneCountryCode: string
Read Only:
true
Maximum Length:10
The primary phone country code in the business license mailing address. -
PrimaryPhoneExtension: string
Title:
Location Primary Phone Extension
Read Only:true
Maximum Length:20
The primary phone extension in the business license mailing address. -
PrimaryPhoneNumber: string
Title:
Location Primary Phone
Read Only:true
Maximum Length:40
The primary phone number in the business license mailing address. -
ProjectKey: integer
(int64)
Title:
Project
Read Only:true
The project name information for a business license. -
Province: string
Title:
Applicant Province
Read Only:true
Maximum Length:60
The province in the business license applicant address. -
RecordStatus: string
Title:
Application Status Code
Read Only:true
Maximum Length:15
The status of the record. -
RecordType: string
Title:
License Type
Read Only:true
Maximum Length:100
The business license type. Agencies define the types of licenses that they administer. -
RenewalDate: string
(date-time)
Title:
Renewal Date
Read Only:true
The renewal date for the license or permit. -
State: string
Title:
Applicant State
Read Only:true
Maximum Length:60
The state in the business license applicant address. -
Subclassification: string
Title:
Subclassification
Read Only:true
Maximum Length:80
The record subclassification. -
SubmitDate: string
(date-time)
Title:
Submission Date
Read Only:true
The date the license and business license transaction was submitted. Used in the application information component of the Business License Designer. -
SubmittedBy: string
Title:
Submitted By
Read Only:true
Maximum Length:64
The user who submitted the application. -
Url: string
Title:
URL
Read Only:true
Maximum Length:255
The browser link for the business license application. -
UrlLabel: string
Title:
Link to Business License Activity
Read Only:true
Maximum Length:255
The label for the URL. -
Username: string
Title:
Applicant User ID
Read Only:true
Maximum Length:100
The user ID of the business license applicant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.