Get all business license expiry communication items
get
/fscmRestApi/resources/11.13.18.05/publicSectorBlExpiryCommunications
Request
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 -
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 license expiry communication data that matches the specified record key. Finder Variables:
- LnpRecordKey; integer; The unique identifier for the record key.
- PrimaryKey: Finds the business license expiry communication data that matches the specified record key. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorBlExpiryCommunications
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBlExpiryCommunications-item
Type:
Show Source
object
-
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:
Doing Business As
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.
Nested Schema : link
Type:
Show Source
object
-
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.