Get a permit expiry communication item
get
/fscmRestApi/resources/11.13.18.05/publicSectorPermitExpiryCommunications/{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).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPermitExpiryCommunications-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. -
AddressKey(optional):
integer(int64)
The parcel address key.
-
AgencyId(optional):
integer(int32)
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.
-
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 permit applicant. -
ApplicantAddress1(optional):
string
Title:
Applicant Address Line 1
Maximum Length:240
The first line of the permit applicant address. -
ApplicantAddress2(optional):
string
Title:
Applicant Address Line 2
Maximum Length:240
The second line of the permit applicant address. -
ApplicantBizProfileId(optional):
integer(int64)
Title:
Adult Oriented Business
The business profile used by the applicant. -
ApplicantCity(optional):
string
Title:
Applicant City
Maximum Length:60
The city in the permit applicant address. -
ApplicantCountry(optional):
string
Maximum Length:
3
The country in the permit applicant address. -
ApplicantCounty(optional):
string
Title:
Applicant County
Maximum Length:60
The county in the permit applicant address. -
ApplicantEmailAddress1(optional):
string
Title:
Applicant Email 1
Maximum Length:320
The first email address of the permit applicant. -
ApplicantEmailAddress2(optional):
string
Title:
Applicant Email 2
Maximum Length:320
The second email address of the permit applicant. -
ApplicantPhoneAreaCode(optional):
string
Title:
Applicant Phone Area Code
Maximum Length:10
The area code in the phone number of the permit applicant. -
ApplicantPhoneCountryCode(optional):
string
Title:
Applicant Phone Country Code
Maximum Length:10
The country code in the phone number of the permit applicant. -
ApplicantPhoneExtension(optional):
string
Title:
Applicant Phone Extension
Maximum Length:20
The phone number extension of the permit applicant. -
ApplicantPhoneNumber(optional):
string
Title:
Applicant Phone Number
Maximum Length:40
The permit applicant phone number. -
ApplicantPostalCode(optional):
string
Title:
Applicant Postal Code
Maximum Length:60
The postal code in the permit applicant address. -
ApplicantProfileId(optional):
integer(int64)
Title:
Applicant Profile
The user profile of the applicant. -
ApplicantProvince(optional):
string
Title:
Applicant Province
Maximum Length:60
The province in the permit applicant address. -
ApplicantState(optional):
string
Title:
Applicant State
Maximum Length:60
The state in the permit applicant address. -
BalanceDue(optional):
number
Title:
Total Due
The application balance due amount. -
Classification(optional):
string
Title:
Classification
Maximum Length:3
The record classification. The classifications can be permit, business license, professional license, or planning and zoning. -
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. -
DistrictName(optional):
string
Title:
District
Maximum Length:50
The type of the current parcel. -
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. -
ExtensionsCount(optional):
integer(int32)
Title:
Number of Extensions
The application expiry extension count. -
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. -
InsCommenceAteDate(optional):
string(date-time)
Title:
About to Expire Date
The date when the notification about an expiring license or permit is sent. -
InsCommenceExpDate(optional):
string(date-time)
Title:
Expiration Date
The date the license or permit is no longer valid. -
InsCommenceGraceDate(optional):
string(date-time)
Title:
Grace Period Date
The application expiry grace date. -
InsCommencementDateOption(optional):
string
Title:
Date Option
Maximum Length:30
The inspection commencement date option. -
InsCommencementDuration(optional):
integer(int64)
Title:
Duration
The inspection commencement duration. -
InsCommencementDurationUom(optional):
string
Title:
Unit of Measure
Maximum Length:5
The inspection commencement unit for duration. -
IssueDate(optional):
string(date-time)
Title:
Issue Date
The date the license or permit was issued. Used in the application information component of the Permit 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. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Permit ID
Maximum Length:50
The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for the record.
-
OrganizationName(optional):
string
Title:
Organization Name
Maximum Length:360
The business name of the applicant. For example, a contractor enters his or her contracting business name. -
Owner(optional):
string
Title:
Owner
Maximum Length:150
The primary or only owner of the parcel or property. -
OwnerEmailId(optional):
string
Title:
Owner Email
Maximum Length:50
The parcel owner email address. -
ParcelAddress1(optional):
string
Title:
Parcel Address Line 1
Maximum Length:240
The first line of the parcel or property address. -
ParcelAddress2(optional):
string
Title:
Parcel Address Line 2
Maximum Length:240
The second line of the parcel or property address. -
ParcelCity(optional):
string
Maximum Length:
60
The city in the parcel or property address. -
ParcelCountry(optional):
string
Maximum Length:
60
The country in the parcel or property address. -
ParcelCounty(optional):
string
Maximum Length:
60
The county in the parcel or property address. -
ParcelId(optional):
integer(int64)
Title:
Parcel
The identifier of the record parcel. -
ParcelPostalCode(optional):
string
Maximum Length:
60
The postal code in the parcel or property address. -
ParcelProvince(optional):
string
Maximum Length:
60
The province in the parcel or property address. -
ParcelState(optional):
string
Maximum Length:
60
The state in the parcel or property address. -
ParcelType(optional):
string
Title:
Parcel Type
Maximum Length:30
The key of the record parcel. -
PermitDescription(optional):
string
Title:
Permit Description
Maximum Length:1000
The description of the permit type. -
PermitStatus(optional):
string
Title:
Permit Status
Maximum Length:100
The status of the permit record. -
PersonName(optional):
string
Title:
Applicant Name
Maximum Length:450
The permit applicant name. -
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. -
ProjectKey(optional):
integer(int64)
Title:
Project
The project name information for a permit. -
PropertyDescription(optional):
string
Title:
Property Description
Maximum Length:240
The property description. -
RecordStatus(optional):
string
Maximum Length:
15
The status of the record. -
RecordType(optional):
string
Title:
Record Type
Maximum Length:100
The permit type. Agencies define the types of permits that they administer, for example, Residential Addition. -
RenewalDate(optional):
string(date-time)
Title:
Renewal Date
The renewal date for the license or permit. -
SecondaryOwner(optional):
string
Title:
Secondary Owner
Maximum Length:150
The secondary owner of the parcel or property. -
SubmitDate(optional):
string(date-time)
Title:
Submission Date
The date the license and permit transaction was submitted. Used in the application information component of the Permit 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 permit 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.