Get a permit
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}
Request
Path Parameters
-
LnpRecordKey: integer
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
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 : publicSectorRecordQueries-item
Type:
Show Source
object
-
AboutToExpireDate(optional):
string(date-time)
The date to indicate when the permit application is about to expire.
-
Address1(optional):
string
Title:
Address Line 1
Maximum Length:240
The first or main address. -
Address2(optional):
string
Maximum Length:
240
The second address, if present. -
Address3(optional):
string
Maximum Length:
240
The third address, if present. -
Address4(optional):
string
Maximum Length:
240
The fourth address, if present. -
Applicant(optional):
integer(int64)
The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.
-
ApplicantBizProfileId(optional):
integer(int64)
The unique identifier of the applicant business profile when the applicant is a business entity.
-
ApplicantProfileId(optional):
integer(int64)
Title:
Applicant Profile
The unique identifier of the applicant user profile. -
City(optional):
string
Maximum Length:
60
The city in the parcel address. -
Classification(optional):
string
Maximum Length:
3
The classification of the permit type. -
Country(optional):
string
Maximum Length:
3
The country in the address. -
County(optional):
string
Maximum Length:
60
The county in the parcel 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 date when the record was created. -
CurrencyCode(optional):
string
Maximum Length:
3
The currency code used for applying payments. -
DateOfBirth(optional):
string(date-time)
The applicant date of birth.
-
DepartmentId(optional):
string
Maximum Length:
30
The unique identifier for a department. -
Description(optional):
string
Title:
Description
Maximum Length:300
The record description. -
DocGroupId(optional):
string
Maximum Length:
30
Indicates the document group used by the application. The document group is defined by a set of attachment document categories. -
EmailAddress1(optional):
string
Title:
Email
Maximum Length:320
The applicant main email address. -
EmailAddress2(optional):
string
Maximum Length:
320
The applicant secondary email address. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration Date
The date when the permit expires. -
FullAddress(optional):
string
Title:
Address
Maximum Length:15
The full address of the permit applicant. -
Gender(optional):
string
Maximum Length:
30
The applicant sex. Values are male or female. -
InsCommenceAteDate(optional):
string(date-time)
Indicates the date that the inspection commencement will be about to expire.
-
InsCommenceExpDate(optional):
string(date-time)
Indicates the date that the inspection commencement will expire.
-
InspectionGroup(optional):
string
Maximum Length:
15
The group of inspections if multiple inspections are required for the permit type. -
IssueDate(optional):
string(date-time)
Title:
Issue Date
The date when the permit was issued. -
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 user who last updated the record. -
LicensePeriod(optional):
string
Maximum Length:
100
Indicates the period of license application. -
LicenseStatus(optional):
string
Maximum Length:
30
Indicates the status of license application. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Maximum Length:
50
The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
-
OrganizationName(optional):
string
Maximum Length:
360
The name of the applicant organization. -
PersonFirstName(optional):
string
Maximum Length:
150
The applicant first name. -
PersonLastName(optional):
string
Maximum Length:
150
The applicant last name. -
PersonMiddleName(optional):
string
Maximum Length:
60
The applicant middle name. -
PersonName(optional):
string
Title:
Name
Maximum Length:450
The applicant full name. -
PersonNameSuffix(optional):
string
Maximum Length:
30
The applicant name suffix, such as Junior or Senior. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30
The salutation for the applicant, such as Mr. or Mrs. -
PersonTitle(optional):
string
Maximum Length:
60
The applicant title. -
PhoneAreaCode(optional):
string
Maximum Length:
10
The area code in the applicant telephone number. -
PhoneCountryCode(optional):
string
Maximum Length:
10
The country code in the applicant telephone number. -
PhoneExtension(optional):
string
Maximum Length:
20
The extension for the applicant telephone number. -
PhoneNumber(optional):
string
Maximum Length:
40
The applicant telephone number. -
PostalCode(optional):
string
Maximum Length:
60
The postal code in the parcel address. -
PostalPlus4Code(optional):
string
Maximum Length:
10
The extended postal code in the parcel address. -
ProjectKey(optional):
integer(int64)
The project to which this permit belongs.
-
Province(optional):
string
Maximum Length:
60
The province in the parcel address. -
RecordParcel(optional):
array Record Parcel Queries
Title:
Record Parcel Queries
The record queries resource is used to capture all application records and display the application information to the user, including application type, application ID, applicant name or the user who created the record, workflow process ID, department, and so on. -
RecordType(optional):
string
Maximum Length:
100
The user-friendly name for the permit type. -
RecordTypeCode(optional):
string
Maximum Length:
20
The unique alphanumeric code or short name for the permit type. -
RecordTypeId(optional):
string
Maximum Length:
30
The unique identifier for a permit type. -
RenewalDate(optional):
string(date-time)
Title:
Renewal Date
The date when the permit was renewed. -
State(optional):
string
Maximum Length:
60
The state in the parcel address. -
Status(optional):
string
Title:
Status
Maximum Length:15
The permit status. -
Subclassification(optional):
string
Maximum Length:
10
The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process. -
SubmitDate(optional):
string(date-time)
Title:
Submission Date
The date when the application was submitted. -
SubmittedBy(optional):
string
Title:
Submitted By
Maximum Length:64
The user who submitted the application. -
SubmittedByName(optional):
string
The name of the person who submitted the application.
-
SystemStatus(optional):
string
Title:
System Status
Maximum Length:15
The predefined system status to which the record status maps. -
VersionType(optional):
string
Maximum Length:
1
The version of the permit. Values are original, amendment, and renewal. -
WfProcessId(optional):
integer(int64)
The workflow process ID.
Nested Schema : Record Parcel Queries
Type:
array
Title:
Record Parcel Queries
The record queries resource is used to capture all application records and display the application information to the user, including application type, application ID, applicant name or the user who created the record, workflow process ID, department, and so on.
Show Source
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.
Nested Schema : publicSectorRecordQueries-RecordParcel-item
Type:
Show Source
object
-
AdditionalStructure(optional):
string
Maximum Length:
200
The information about additional structures located on the parcel. -
AgencyId(optional):
integer(int64)
Title:
Agency ID
The unique identifier for the public sector agency associated with the parcel. -
Bathrooms(optional):
string
Maximum Length:
20
The number of bathrooms in the building on the parcel. -
Bedrooms(optional):
string
Maximum Length:
20
The number of bedrooms in the building on the parcel. -
BlockNumber(optional):
string
Title:
Block
Maximum Length:30
The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
BookNumber(optional):
string
Title:
Book
Maximum Length:30
The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
BoundaryDescription(optional):
string
Title:
Boundary Description
Maximum Length:480
A textual description of the property boundaries. This is not a listing of coordinates. For example, SMITH LOT - COME E 155 FT FROM SW CORNER OF LOT 206 THEN 77.5 FT N TO A LINE WHICH EXTENDS FROM A PT N 309.91 FT AND E 55.25 FT FROM BEG TO A PT E 155 FT FROM LOT 206. -
CensusBlock(optional):
string
Maximum Length:
100
The neighborhood information related to the location of the parcel. -
CensusTract(optional):
string
Maximum Length:
100
The neighborhood information related to the location of the parcel. -
ClimateZone(optional):
string
Maximum Length:
200
The climate zone information of the parcel. -
CoordinateX(optional):
number
Title:
Coordinate X
The x-axis coordinate for the record parcel. -
CoordinateY(optional):
number
Title:
Coordinate Y
The y-axis coordinate for the record parcel. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the record parcel. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the record parcel was created. -
DistrictName(optional):
string
Title:
District
Maximum Length:50
The district name of the parcel. -
DwellingUnitCount(optional):
integer(int64)
The count of dwelling units in the record parcel.
-
FireRisk(optional):
string
Maximum Length:
200
The fire risk information related to the parcel. -
FloodInsRateMap(optional):
string
Maximum Length:
200
The Flood Insurance Rate Map related to the parcel. -
FloodZone(optional):
string
Maximum Length:
200
The detailed land information of the parcel. -
GeneralPlanTwo(optional):
string
Maximum Length:
30
The alternate plan information of the parcel. -
Jurisdiction(optional):
string
Title:
Jurisdiction
Maximum Length:50
The name of the city, if incorporated, or the name of the county, if unincorporated. -
LandslideRisk(optional):
string
Maximum Length:
200
The landslide risk information related to the parcel. -
LandUseCode(optional):
string
Title:
Land Use
Maximum Length:30
The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the record parcel was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record parcel. -
Latitude(optional):
number
Title:
Latitude
The geographic location of the parcel that is north or south of the equator. -
links(optional):
array Items
Title:
Items
Link Relations -
LiquefactionRisk(optional):
string
Maximum Length:
200
The liquefaction risk information of the parcel. -
LnpRecordId(optional):
string
Title:
Record ID
Maximum Length:50
The unique identifier for the application record. -
LnpRecordKey(optional):
integer(int64)
Title:
Record
The unique identifier for the record associated with the parcel. -
Longitude(optional):
number
Title:
Longitude
The geographic location of the parcel address that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance. -
LotNumber(optional):
string
Title:
Lot
Maximum Length:30
The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
MapBookPage(optional):
string
Title:
Map Book Page
Maximum Length:50
The recorded map book and page. -
MapName(optional):
string
Title:
Map Name
Maximum Length:50
The recorded map name. For example, Public Works. -
PageNumber(optional):
string
Title:
Page
Maximum Length:30
The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
ParcelId(optional):
integer(int64)
Title:
Parcel
The identifier of the record parcel. -
ParcelIdEntered(optional):
string
Title:
Parcel
Maximum Length:30
The Assessor Parcel Number (APN) as entered by the user. -
ParcelKey(optional):
integer(int64)
Title:
Parcel Key
The unique identifier for the parcel associated with a parcel address. -
ParcelSizeOne(optional):
number
The first parcel size.
-
ParcelSizeOneUnit(optional):
string
Maximum Length:
10
The unit of measure for the first parcel size. -
ParcelSizeTwo(optional):
number
The second parcel size.
-
ParcelSizeTwoUnit(optional):
string
Maximum Length:
10
The unit of measure for the second parcel size. -
ParcelStatus(optional):
string
Maximum Length:
20
The status of the parcel, which is Final or Provisional. -
ParcelType(optional):
string
Title:
Parcel Type
Maximum Length:30
The type of the parcel. For example, commercial, residential, or government. -
ParentParcelId(optional):
integer(int64)
Title:
Parent Parcel
The unique identifier of the parent record parcel. -
Patio(optional):
string
Maximum Length:
200
The information about patios located on the parcel. -
Pool(optional):
string
Maximum Length:
200
The information about pools located on the parcel. -
PrimaryFlag(optional):
boolean
Title:
Primary
Indicates the primary parcel address. If the value is Y, then the parcel address is the primary parcel address. The default value is N. -
PrimaryZoningId(optional):
string
Title:
Primary Zone
Maximum Length:30
The primary zoning ID of the zoning for the parcel. -
PropertyDescription(optional):
string
Title:
Property Description
Maximum Length:240
The property description. -
SectionNumber(optional):
string
Title:
Section
Maximum Length:30
The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
ShapeJson(optional):
string
The transient string field of a record parcel, which is the shape's JSON data from the ESRI GIS server.
-
SoilType(optional):
string
Maximum Length:
200
The soil type information of the parcel. -
Srid(optional):
integer(int64)
Title:
SRID
The GIS coordinate system in use. -
StructureSizeOne(optional):
number
The first structure size.
-
StructureSizeOneUnit(optional):
string
Maximum Length:
10
The unit of measure for the first structure size. -
StructureSizeTwo(optional):
number
The second structure size.
-
StructureSizeTwoUnit(optional):
string
Maximum Length:
10
The unit of measure for the second structure size. -
Subdivision(optional):
string
Title:
Subdivision
Maximum Length:30
The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
TaxRateArea(optional):
string
Maximum Length:
100
The area Identifier of the parcel location for tax purposes. -
UnitNumber(optional):
string
Title:
Unit
Maximum Length:30
The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
YearBuilt(optional):
string
Maximum Length:
4
The year in which the building on the parcel was built. -
ZoningCodeTwo(optional):
string
Maximum Length:
30
The secondary zoning code of the parcel. -
ZoningDescription(optional):
string
Title:
Zone Description
Maximum Length:240
The zoning description.