Get a permit
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}
Request
Path Parameters
-
LnpRecordKey(required): 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 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:
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.
Root Schema : publicSectorRecordQueries-item-response
Type:
Show Source
object-
AboutToExpireDate: string
(date-time)
Title:
About to Expire DateRead Only:trueThe date to indicate when the permit application is about to expire. -
Address1: string
Title:
Applicant Address Line 1Read Only:trueMaximum Length:240The first or main address. -
Address2: string
Title:
Applicant Address Line 2Read Only:trueMaximum Length:240The second address, if present. -
Address3: string
Title:
Applicant Address Line 3Read Only:trueMaximum Length:240The third address, if present. -
Address4: string
Title:
Applicant Address Line 4Read Only:trueMaximum Length:240The fourth address, if present. -
Applicant: integer
(int64)
Title:
Applicant Party IDRead Only:trueThe party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit. -
ApplicantBizProfileId: integer
(int64)
Read Only:
trueThe unique identifier of the applicant business profile when the applicant is a business entity. -
ApplicantProfileId: integer
(int64)
Title:
Applicant ProfileRead Only:trueThe unique identifier of the applicant user profile. -
ApplicantUserId: string
Title:
Applicant User IDRead Only:trueMaximum Length:20The user ID of the applicant. -
City: string
Title:
Applicant CityRead Only:trueMaximum Length:60The city in the parcel address. -
Classification: string
Title:
ClassificationRead Only:trueMaximum Length:3The classification of the permit type. -
ContactLists: array
Record Contact Lists
Title:
Record Contact ListsThe contact list resource is used to find attributes related to the contacts that are added to the permit application. -
Country: string
Title:
Applicant CountryRead Only:trueMaximum Length:3The country in the address. -
County: string
Title:
Applicant CountyRead Only:trueMaximum Length:60The county in the parcel address. -
CreatedByName: string
Read Only:
trueMaximum Length:255Used to indicate the name of the person who created the application. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
CurrencyCode: string
Title:
CurrencyRead Only:trueMaximum Length:3The currency code used for applying payments. -
DateOfBirth: string
(date-time)
Read Only:
trueThe applicant date of birth. -
DepartmentId: string
Title:
DepartmentRead Only:trueMaximum Length:30The unique identifier for a department. -
Description: string
Title:
DescriptionRead Only:trueMaximum Length:300The record description. -
DocGroupId: string
Read Only:
trueMaximum Length:30Indicates the document group used by the application. The document group is defined by a set of attachment document categories. -
EmailAddress1: string
Title:
EmailRead Only:trueMaximum Length:320The applicant main email address. -
EmailAddress2: string
Title:
Email 2Read Only:trueMaximum Length:320The applicant secondary email address. -
ExpirationDate: string
(date-time)
Title:
Expiration DateRead Only:trueThe date when the permit expires. -
ExpirationGraceDate: string
(date-time)
Read Only:
trueIndicates the date that the application can be extended to. -
ExpirationGroupId: string
Read Only:
trueMaximum Length:50Identifies the expiration group associated with the record type. -
FullAddress: string
Title:
AddressRead Only:trueMaximum Length:15The full address of the permit applicant. -
Gender: string
Read Only:
trueMaximum Length:30The applicant sex. Values are male or female. -
InsCommenceAteDate: string
(date-time)
Read Only:
trueIndicates the date that the inspection commencement will be about to expire. -
InsCommenceExpDate: string
(date-time)
Read Only:
trueIndicates the date that the inspection commencement will expire. -
InsCommenceGraceDate: string
(date-time)
Read Only:
trueIndicates the date that the inspection commencement can be extended to. -
InspectionGroup: string
Read Only:
trueMaximum Length:15The group of inspections if multiple inspections are required for the permit type. -
IssueDate: string
(date-time)
Title:
Issue DateRead Only:trueThe date when the permit was issued. -
LastAction: string
Read Only:
trueMaximum Length:30The last action performed on a transaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the record was last updated. -
LayoutVersion: string
Read Only:
trueMaximum Length:30The layout version used for this record. -
LicensePeriod: string
Title:
License PeriodRead Only:trueMaximum Length:100Indicates the period of license application. -
LicenseStatus: string
Title:
License StatusRead Only:trueMaximum Length:30Indicates the status of license application. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LnpRecordId: string
Title:
Transaction NumberRead Only:trueMaximum Length:50The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey: integer
Title:
Transaction KeyRead Only:trueThe 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: string
Title:
Organization NameRead Only:trueMaximum Length:360The name of the applicant organization. -
PersonFirstName: string
Title:
Applicant First NameRead Only:trueMaximum Length:150The applicant first name. -
PersonLastName: string
Title:
Applicant Last NameRead Only:trueMaximum Length:150The applicant last name. -
PersonMiddleName: string
Title:
Applicant Middle NameRead Only:trueMaximum Length:60The applicant middle name. -
PersonName: string
Title:
NameRead Only:trueMaximum Length:450The applicant full name. -
PersonNameSuffix: string
Read Only:
trueMaximum Length:30The applicant name suffix, such as Junior or Senior. -
PersonPreNameAdjunct: string
Read Only:
trueMaximum Length:30The salutation for the applicant, such as Mr. or Mrs. -
PersonTitle: string
Title:
Applicant TitleRead Only:trueMaximum Length:60The applicant title. -
PhoneAreaCode: string
Title:
Applicant Phone Area CodeRead Only:trueMaximum Length:10The area code in the applicant telephone number. -
PhoneCountryCode: string
Title:
Applicant Phone Country CodeRead Only:trueMaximum Length:10The country code in the applicant telephone number. -
PhoneExtension: string
Title:
ExtensionRead Only:trueMaximum Length:20The extension for the applicant telephone number. -
PhoneNumber: string
Title:
Applicant Phone NumberRead Only:trueMaximum Length:40The applicant telephone number. -
PostalCode: string
Title:
Applicant Postal CodeRead Only:trueMaximum Length:60The postal code in the parcel address. -
PostalPlus4Code: string
Read Only:
trueMaximum Length:10The extended postal code in the parcel address. -
PrimaryFlag: string
Read Only:
trueMaximum Length:1Indicates whether the record is primary. -
PrimaryRecordId: string
Read Only:
trueMaximum Length:50Used to store the parent record ID for a sub-record. -
PrimaryRecordKey: string
Read Only:
trueMaximum Length:18Used to store the primary record key for a sub-record. -
ProjectKey: integer
(int64)
Read Only:
trueThe project to which this permit belongs. -
Province: string
Title:
Applicant ProvinceRead Only:trueMaximum Length:60The province in the parcel address. -
ReceivedDate: string
(date-time)
Read Only:
trueThe date on which the transaction was received. -
RecordGISObjects: array
Record GIS Objects
Title:
Record GIS ObjectsThe record GIS object resource is used to view the gis objects that are associated with the application. -
RecordNumber: string
Title:
Record NumberRead Only:trueMaximum Length:64The public unique identifier of the parent record used in the import process. -
RecordParcel: array
Record Parcel Queries
Title:
Record Parcel QueriesThe record parcel queries resource is used to view the parcels that are associated with the application. -
RecordType: string
Title:
Transaction TypeRead Only:trueMaximum Length:100The user-friendly name for the permit type. -
RecordTypeCode: string
Read Only:
trueMaximum Length:20The unique alphanumeric code or short name for the permit type. -
RecordTypeId: string
Read Only:
trueMaximum Length:30The unique identifier for a permit type. -
ReissueDate: string
(date-time)
Title:
Reissue DateRead Only:trueThe date when the permit was reissued. -
RenewalDate: string
(date-time)
Title:
Renewal DateRead Only:trueThe date when the permit was renewed. -
State: string
Title:
Applicant StateRead Only:trueMaximum Length:60The state in the parcel address. -
Status: string
Title:
StatusRead Only:trueMaximum Length:15The permit status. -
SubapplicationFlag: string
Read Only:
trueMaximum Length:1Indicates whether the record is a sub application. -
Subclassification: string
Title:
SubclassificationRead Only:trueMaximum Length:10The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process. -
SubmitDate: string
(date-time)
Title:
Submission DateRead Only:trueThe date when the application was submitted. -
SubmittedByName: string
Title:
Submitted ByRead Only:trueThe name of the person who submitted the application. -
SystemStatus: string
Title:
System StatusRead Only:trueMaximum Length:15The predefined system status to which the record status maps. -
VersionType: string
Read Only:
trueMaximum Length:1The version of the permit. Values are original, amendment, and renewal. -
WfNoAmendFlag: string
Read Only:
trueMaximum Length:1Indicates that the transaction type does not contain an amendment workflow. If the value is Y, the workflow is disabled for amendment. The default value is N. -
WfNoOrigFlag: string
Read Only:
trueMaximum Length:1Indicates that the transaction type does not contain an original workflow. If the value is Y, the workflow is disabled for origination. The default value is N. -
WfNoRenewFlag: string
Read Only:
trueMaximum Length:1Indicates that the transaction type does not contain a renewal workflow. If the value is Y, the workflow is disabled for renewal. The default value is N. -
WfProcessId: integer
Read Only:
trueThe workflow process ID.
Nested Schema : Record Contact Lists
Type:
arrayTitle:
Record Contact ListsThe contact list resource is used to find attributes related to the contacts that are added to the permit application.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Record GIS Objects
Type:
arrayTitle:
Record GIS ObjectsThe record GIS object resource is used to view the gis objects that are associated with the application.
Show Source
Nested Schema : Record Parcel Queries
Type:
arrayTitle:
Record Parcel QueriesThe record parcel queries resource is used to view the parcels that are associated with the application.
Show Source
Nested Schema : publicSectorRecordQueries-ContactLists-item-response
Type:
Show Source
object-
ActiveLastUpdateBy: string
Maximum Length:
64Indicates the user who last updated the contact???s active status. -
ActiveLastUpdateDate: string
(date)
Indicates the date when the contact???s active status was last updated.
-
Address1: string
Title:
Address Line 1Maximum Length:240The first address line for the contact person. -
Address2: string
Title:
Address Line 2Maximum Length:240The second address line for the contact person. -
Address3: string
Title:
Address Line 3Maximum Length:240The third address line for the contact person. -
Address4: string
Title:
Address Line 4Maximum Length:240The fourth address line for the contact person. -
AgencyId: integer
Title:
Agency IDDefault Value:1The 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. -
ApplicantFlag: string
Title:
ApplicantMaximum Length:1Default Value:NThis field indicates if the contact is an applicant. -
AuthorizeAgentFlag: string
Maximum Length:
1Default Value:NIndicates whether the contact person is an authorized user of the license. -
City: string
Title:
CityMaximum Length:60The city for the contact person's address. -
ContactAccess: string
Maximum Length:
30Indicates whether the contact is granted access to the application. -
ContactActive: string
Maximum Length:
1Default Value:YThe contact status of the person. -
ContactBizPartyId: integer
(int64)
Title:
Contact Business PartyThe contact list business party ID. -
ContactBizProfileId: integer
(int64)
The unique identifier of the contact's business profile when the contact ID is a business entity.
-
ContactId: integer
(int64)
The unique identifier of the contact.
-
ContactKey: integer
(int64)
Title:
Contact KeyThe unique identifier for the contact. -
ContactPartyId: integer
(int64)
Title:
Contact PartyThe contact list party ID. -
ContactProfileId: integer
(int64)
The profile ID of the contact.
-
ContactPuid: string
Maximum Length:
480The parent unique identifier, which is an alternate key used by the CRM Import process. -
ContactRole: string
The role assigned to the contact. Indicates whether the contact is an applicant, business owner, or previous owner.
-
ContactType: string
Title:
Contact TypeMaximum Length:30Identifies the contact type of the primary contact of the permit application. -
Country: string
Title:
CountryMaximum Length:3The country for the contact person. -
County: string
Title:
CountyMaximum Length:60The county for the contact person's address. -
DateOfBirth: string
(date)
Title:
Date of BirthThe date of birth of the contact person's address. -
EmailAddress1: string
Title:
EmailMaximum Length:320The email for the contact person's address. -
Gender: string
Title:
GenderMaximum Length:30The gender for the contact person's gender. -
JobTitle: string
Maximum Length:
60The job title of the person associated with the contact. -
LicenseHolderFlag: string
Maximum Length:
1Indicates the person to whom the contractor license was issued. -
LicenseNumber: string
Maximum Length:
30The license number for the applicant when the contact is an applicant. -
LicenseSetupCode: string
Maximum Length:
30The setup code for the applicant when the contact is an applicant. -
LicenseType: string
Maximum Length:
30The license type for the applicant when the contact is an applicant. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LnpBusinessOwnersKey: integer
(int64)
Unique identifier for the business owner.
-
LnpBusinessOwnersPuid: string
Maximum Length:
480The unique identifier for the business owner in the legacy system. -
LnpRecordId: string
Title:
Record IDMaximum Length:50The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029. -
LnpRecordKey: integer
(int64)
Title:
RecordThe unique identifier for a permit type. -
MakeApplicantDate: string
(date)
The date when the contact was made a previous applicant.
-
OrganizationName: string
Title:
OrganizationMaximum Length:360The name of the applicant's organization. -
OwnerFlag: string
Maximum Length:
1Default Value:NIndicates whether the contact person is a business owner. -
PersonFirstName: string
Title:
First NameMaximum Length:150The contact person's first name. -
PersonLastName: string
Title:
Last NameMaximum Length:150The contact person's last name. -
PersonMiddleName: string
Title:
Middle NameMaximum Length:60The contact person's middle name. -
PersonName: string
Title:
Display NameMaximum Length:450The contact person's name. -
PersonNameSuffix: string
Title:
SuffixMaximum Length:30The contact name suffix, such as Junior or Senior. -
PersonPreNameAdjunct: string
Title:
SalutationMaximum Length:30The salutation for the contact such as Mr. or Mrs. -
PersonTitle: string
Title:
TitleMaximum Length:60The title of the contact person. -
PhoneAreaCode: string
Title:
Area CodeMaximum Length:10The area code in the contact telephone number. -
PhoneAreaCodeAlt: string
Maximum Length:
10The alternate area code in the contact person's telephone number. -
PhoneCountryCode: string
Title:
Country CodeMaximum Length:10The country code in the contact telephone number. -
PhoneCountryCodeAlt: string
Maximum Length:
10The alternate country code in the contact person telephone number. -
PhoneExtension: string
Title:
ExtensionMaximum Length:20The extension for the contact's telephone number. -
PhoneNumber: string
Title:
PhoneMaximum Length:40The contact person's phone number. -
PhoneNumberAlt: string
Maximum Length:
40The contact person's telephone number. -
PostalCode: string
Title:
Postal CodeMaximum Length:60The postal code for the contact person's address. -
PostalPlus4Code: string
Title:
Postal Plus 4 CodeMaximum Length:10The extended postal code in the contact list. -
PreviousApplicantFlag: string
Maximum Length:
1Default Value:NIndicates whether the contact is the previous applicant. The default value is N. -
PrimaryFlag: boolean
Title:
PrimaryMaximum Length:1Indicates the primary contact in the contact details. -
PrimaryFlagYN: string
The primary contact in the contact details. It's a read-only attribute.
-
Province: string
Title:
ProvinceMaximum Length:60The province in the contact person's address. -
RecordNumber: string
Maximum Length:
64The public unique identifier of the parent record. -
State: string
Title:
StateMaximum Length:60The state in the contact person's address.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : publicSectorRecordQueries-RecordGISObjects-item-response
Type:
Show Source
object-
AgencyId: integer
(int32)
Default Value:
1The unique identifier for a public sector agency. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the GIS object was created. -
GeometryJson: string
(byte)
The transient geometry string field of a record GIS object, which is the geometry's JSON data from the ESRI GIS server.
-
GisLayerName: string
Maximum Length:
100The unique identifier for the layer that the GIS object belongs to. -
GisObjDisplayAttrs: string
Maximum Length:
4000The collection of display attributes for the GIS object. -
GisObjIdAttrs: string
Maximum Length:
2000The collection of unique identifier attributes for the GIS object. -
GisObjKey: integer
(int64)
The unique identifier for the GIS object associated with the record.
-
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the GIS object was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LnpRecordId: string
Maximum Length:
50The unique identifier for the application record. -
LnpRecordKey: integer
(int64)
The unique identifier for the record associated with the GIS object.
-
Shape: object
Shape
The Oracle spatial field of a record parcel, which is the storage field for shape data.
-
ShapeJson: string
The transient string field of a record parcel, which is the shape's JSON data from the ESRI GIS server.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Shape
Type:
objectThe Oracle spatial field of a record parcel, which is the storage field for shape data.
Nested Schema : publicSectorRecordQueries-RecordParcel-item-response
Type:
Show Source
object-
AdditionalStructure: string
Maximum Length:
200The information about additional structures located on the parcel. -
AgencyId: integer
(int32)
Title:
Agency IDDefault Value:1The unique identifier for the public sector agency associated with the parcel. -
Bathrooms: string
Maximum Length:
20The number of bathrooms in the building on the parcel. -
Bedrooms: string
Maximum Length:
20The number of bedrooms in the building on the parcel. -
BlockNumber: string
Title:
BlockMaximum Length:30The block number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
BookNumber: string
Title:
BookMaximum Length:30The book number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
BoundaryDescription: string
Title:
Boundary DescriptionMaximum Length:480A 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: string
Maximum Length:
100The neighborhood information related to the location of the parcel. -
CensusTract: string
Maximum Length:
100The neighborhood information related to the location of the parcel. -
ClimateZone: string
Maximum Length:
200The climate zone information of the parcel. -
CoordinateX: number
Title:
Coordinate XThe x-axis coordinate for the record parcel. -
CoordinateY: number
Title:
Coordinate YThe y-axis coordinate for the record parcel. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record parcel was created. -
DistrictName: string
Title:
DistrictMaximum Length:50The district name of the parcel. -
DwellingUnitCount: integer
(int64)
The count of dwelling units in the record parcel.
-
FireRisk: string
Maximum Length:
200The fire risk information related to the parcel. -
FloodInsRateMap: string
Maximum Length:
200The Flood Insurance Rate Map related to the parcel. -
FloodZone: string
Maximum Length:
200The detailed land information of the parcel. -
GeneralPlanTwo: string
Maximum Length:
30The alternate plan information of the parcel. -
Jurisdiction: string
Title:
JurisdictionMaximum Length:50The name of the city, if incorporated, or the name of the county, if unincorporated. -
LandslideRisk: string
Maximum Length:
200The landslide risk information related to the parcel. -
LandUseCode: string
Title:
Land UseMaximum Length:30The land use code of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the record parcel was last updated. -
Latitude: number
Title:
LatitudeThe geographic location of the parcel that is north or south of the equator. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LiquefactionRisk: string
Maximum Length:
200The liquefaction risk information of the parcel. -
LnpRecordId: string
Title:
Record IDMaximum Length:50The unique identifier for the application record. -
LnpRecordKey: integer
(int64)
Title:
RecordThe unique identifier for the record associated with the parcel. -
Longitude: number
Title:
LongitudeThe 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: string
Title:
LotMaximum Length:30The lot number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
MapBookPage: string
Title:
Map Book PageMaximum Length:50The recorded map book and page. -
MapName: string
Title:
Map NameMaximum Length:50The recorded map name. For example, Public Works. -
PageNumber: string
Title:
PageMaximum Length:30The page number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
ParcelAddress: array
Parcel Addresses
Title:
Parcel AddressesThe parcel addresses resource is used to view the parcel addresses. -
ParcelId: integer
(int64)
Title:
ParcelThe identifier of the record parcel. -
ParcelIdEntered: string
Title:
ParcelMaximum Length:30The Assessor Parcel Number (APN) as entered by the user. -
ParcelKey: integer
(int64)
Title:
Parcel KeyThe unique identifier for the parcel associated with a parcel address. -
ParcelOwner: array
Parcel Owners
Title:
Parcel OwnersThe parcel owners resource is used to view the parcel owners. -
ParcelSizeOne: number
The first parcel size.
-
ParcelSizeOneUnit: string
Maximum Length:
10The unit of measure for the first parcel size. -
ParcelSizeTwo: number
The second parcel size.
-
ParcelSizeTwoUnit: string
Maximum Length:
10The unit of measure for the second parcel size. -
ParcelStatus: string
Maximum Length:
20Default Value:ORA_FINThe status of the parcel, which is Final or Provisional. -
ParcelType: string
Title:
Parcel TypeMaximum Length:30The type of the parcel. For example, commercial, residential, or government. -
ParentParcelId: integer
(int64)
Title:
Parent ParcelThe unique identifier of the parent record parcel. -
Patio: string
Maximum Length:
200The information about patios located on the parcel. -
Pool: string
Maximum Length:
200The information about pools located on the parcel. -
PrimaryFlag: boolean
Title:
PrimaryMaximum Length:1Indicates the primary parcel address. If the value is Y, then the parcel address is the primary parcel address. The default value is N. -
PrimaryZoningId: string
Title:
Primary ZoneMaximum Length:30The primary zoning ID of the zoning for the parcel. -
PropertyDescription: string
Title:
Property DescriptionMaximum Length:240The property description. -
SectionNumber: string
Title:
SectionMaximum Length:30The section number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
Shape: object
Shape
The Oracle spatial field of a record parcel, which is the storage field for shape data.
-
ShapeJson: string
The transient string field of a record parcel, which is the shape's JSON data from the ESRI GIS server.
-
SoilType: string
Maximum Length:
200The soil type information of the parcel. -
Srid: integer
(int64)
Title:
SRIDThe GIS coordinate system in use. -
StructureSizeOne: number
The first structure size.
-
StructureSizeOneUnit: string
Maximum Length:
10The unit of measure for the first structure size. -
StructureSizeTwo: number
The second structure size.
-
StructureSizeTwoUnit: string
Maximum Length:
10The unit of measure for the second structure size. -
Subdivision: string
Title:
SubdivisionMaximum Length:30The subdivision of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
TaxRateArea: string
Maximum Length:
100The area Identifier of the parcel location for tax purposes. -
UnitNumber: string
Title:
UnitMaximum Length:30The unit number of the parcel in the Detail Land Information, which is part of the Assessor Parcel Number (APN). -
YearBuilt: string
Maximum Length:
4The year in which the building on the parcel was built. -
ZoningCodeTwo: string
Maximum Length:
30The secondary zoning code of the parcel. -
ZoningDescription: string
Title:
Zone DescriptionMaximum Length:240The zoning description.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Parcel Addresses
Type:
arrayTitle:
Parcel AddressesThe parcel addresses resource is used to view the parcel addresses.
Show Source
Nested Schema : Parcel Owners
Type:
arrayTitle:
Parcel OwnersThe parcel owners resource is used to view the parcel owners.
Show Source
Nested Schema : Shape
Type:
objectThe Oracle spatial field of a record parcel, which is the storage field for shape data.
Nested Schema : publicSectorRecordQueries-RecordParcel-ParcelAddress-item-response
Type:
Show Source
object-
Address1: string
Title:
Address Line 1Maximum Length:240 -
Address2: string
Title:
Address Line 2Maximum Length:240 -
Address3: string
Title:
Address Line 3Maximum Length:240 -
Address4: string
Title:
Address Line 4Maximum Length:240 -
AddressId: integer
(int64)
Title:
Address -
AddressKey: integer
(int64)
Title:
Address Key -
AddressType: string
Title:
Address TypeMaximum Length:20 -
AgencyId: integer
(int32)
Title:
Agency IDDefault Value:1 -
BuildingType: string
Title:
BuildingMaximum Length:20 -
CellPhoneCountry: string
Title:
Cell Phone CountryMaximum Length:10 -
CellPhoneNumber: string
Title:
Cell PhoneMaximum Length:40 -
City: string
Title:
CityMaximum Length:60 -
CoordinateX: number
Title:
Coordinate X -
CoordinateY: number
Title:
Coordinate Y -
Country: string
Title:
CountryMaximum Length:60 -
County: string
Title:
CountyMaximum Length:60 -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
CrossroadOne: string
Maximum Length:
240 -
CrossroadTwo: string
Maximum Length:
240 -
EmailId: string
Title:
EmailMaximum Length:50 -
FaxCountry: string
Title:
Fax CountryMaximum Length:10 -
FaxNumber: string
Title:
FaxMaximum Length:40 -
Floor: string
Title:
FloorMaximum Length:20 -
HomePhoneCountry: string
Title:
Home Phone CountryMaximum Length:10 -
HomePhoneNumber: string
Title:
Home PhoneMaximum Length:40 -
InputSource: string
Title:
SourceMaximum Length:1 -
Landmark: string
Maximum Length:
200 -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:true -
Latitude: number
Title:
Latitude -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record IDMaximum Length:50 -
LnpRecordKey: integer
(int64)
Title:
Record -
Longitude: number
Title:
Longitude -
MunicipalityId: string
Title:
MunicipalityMaximum Length:20 -
ParcelId: integer
(int64)
Title:
Parcel -
ParcelKey: integer
(int64)
Title:
Parcel Key -
PostalCode: string
Title:
Postal CodeMaximum Length:60 -
PostalPlus4Code: string
Title:
Postal Plus 4 CodeMaximum Length:20 -
PrimaryFlag: boolean
Title:
PrimaryMaximum Length:1 -
PrimaryTransAddress: boolean
Title:
Primary Transaction AddressMaximum Length:1 -
Province: string
Title:
ProvinceMaximum Length:60 -
Srid: integer
(int64)
Title:
SRID -
State: string
Title:
StateMaximum Length:60 -
StreetDirection: string
Title:
DirectionMaximum Length:10 -
StreetName: string
Title:
StreetMaximum Length:240 -
StreetNameConcat: string
Maximum Length:
350 -
StreetNumber: string
Title:
Street NumberMaximum Length:20 -
StreetSuffix: string
Maximum Length:
20 -
StreetType: string
Title:
Street TypeMaximum Length:20 -
UnitNumber: string
Title:
UnitMaximum Length:30 -
WorkPhoneCountry: string
Title:
Work Phone CountryMaximum Length:10 -
WorkPhoneNumber: string
Title:
Work PhoneMaximum Length:40
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordQueries-RecordParcel-ParcelOwner-item-response
Type:
Show Source
object-
Address1: string
Title:
Address Line 1Maximum Length:240 -
Address2: string
Title:
Address Line 2Maximum Length:240 -
Address3: string
Title:
Address Line 3Maximum Length:240 -
Address4: string
Title:
Address Line 4Maximum Length:240 -
AgencyId: integer
(int32)
Title:
Agency IDDefault Value:1 -
BuildingType: string
Title:
BuildingMaximum Length:20 -
CellPhoneCountry: string
Title:
Cell Phone CountryMaximum Length:10 -
CellPhoneNumber: string
Title:
Cell PhoneMaximum Length:40 -
City: string
Title:
CityMaximum Length:60 -
Country: string
Title:
CountryMaximum Length:60 -
County: string
Title:
CountyMaximum Length:60 -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
DocumentNumber: string
Title:
DocumentMaximum Length:50 -
EmailId: string
Title:
EmailMaximum Length:50 -
FaxCountry: string
Title:
Fax CountryMaximum Length:10 -
FaxNumber: string
Title:
FaxMaximum Length:40 -
Floor: string
Title:
FloorMaximum Length:20 -
HomePhoneCountry: string
Title:
Home Phone CountryMaximum Length:10 -
HomePhoneNumber: string
Title:
Home PhoneMaximum Length:40 -
LastTransferDate: string
(date)
Title:
Last Transfer Date -
LastTransferType: string
Title:
Last Transfer TypeMaximum Length:50 -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record IDMaximum Length:50 -
LnpRecordKey: integer
(int64)
Title:
Record -
Owner: string
Title:
OwnerMaximum Length:150 -
OwnerId: integer
(int64)
Title:
Owner -
OwnerKey: integer
(int64)
Title:
Owner Key -
OwnerType: string
Title:
Ownership TypeMaximum Length:20 -
ParcelId: integer
(int64)
Title:
Parcel -
ParcelKey: integer
(int64)
Title:
Parcel Key -
PostalCode: string
Title:
Postal CodeMaximum Length:60 -
PostalPlus4Code: string
Title:
Postal Plus 4 CodeMaximum Length:20 -
PrimaryFlag: boolean
Title:
PrimaryMaximum Length:1 -
Province: string
Title:
ProvinceMaximum Length:60 -
SecondaryOwner: string
Title:
Secondary OwnerMaximum Length:150 -
State: string
Title:
StateMaximum Length:60 -
StreetDirection: string
Title:
DirectionMaximum Length:10 -
StreetName: string
Title:
StreetMaximum Length:240 -
StreetNumber: string
Title:
Street NumberMaximum Length:20 -
StreetType: string
Title:
Street TypeMaximum Length:20 -
UnitNumber: string
Title:
UnitMaximum Length:30 -
WorkPhoneCountry: string
Title:
Work Phone CountryMaximum Length:10 -
WorkPhoneNumber: string
Title:
Work PhoneMaximum Length:40
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- ContactLists
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/ContactListsParameters:
- LnpRecordKey:
$request.path.LnpRecordKey
The contact list resource is used to find attributes related to the contacts that are added to the permit application. - LnpRecordKey:
- RecordGISObjects
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordGISObjectsParameters:
- LnpRecordKey:
$request.path.LnpRecordKey
The record GIS object resource is used to view the gis objects that are associated with the application. - LnpRecordKey:
- RecordParcel
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcelParameters:
- LnpRecordKey:
$request.path.LnpRecordKey
The record parcel queries resource is used to view the parcels that are associated with the application. - LnpRecordKey: