Get all permits
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries
Request
Query Parameters
-
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 -
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 a permit using the primary key criteria.
Finder Variables:- LnpRecordKey; integer; The unique identifier for a record. The record can be for a permit, business license, professional license, or planning and zoning, which is determined by the classification.
- PrimaryKey: Finds a permit using the primary key criteria.
-
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.
-
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 -
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 fields. 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- AboutToExpireDate; string; The date to indicate when the permit application is about to expire.
- Address1; string; The first or main address.
- Address2; string; The second address, if present.
- Address3; string; The third address, if present.
- Address4; string; The fourth address, if present.
- Applicant; integer; The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.
- ApplicantBizProfileId; integer; The unique identifier of the applicant business profile when the applicant is a business entity.
- ApplicantProfileId; integer; The unique identifier of the applicant user profile.
- ApplicantUserId; string; The user ID of the applicant.
- City; string; The city in the parcel address.
- Classification; string; The classification of the permit type.
- Country; string; The country in the address.
- County; string; The county in the parcel address.
- CreationDate; string; The date when the record was created.
- CurrencyCode; string; The currency code used for applying payments.
- DateOfBirth; string; The applicant date of birth.
- DepartmentId; string; The unique identifier for a department.
- Description; string; The record description.
- DocGroupId; string; Indicates the document group used by the application. The document group is defined by a set of attachment document categories.
- EmailAddress1; string; The applicant main email address.
- EmailAddress2; string; The applicant secondary email address.
- ExpirationDate; string; The date when the permit expires.
- ExpirationGraceDate; string; Indicates the date that the application can be extended to.
- ExpirationGroupId; string; Identifies the expiration group associated with the record type.
- FullAddress; string; The full address of the permit applicant.
- Gender; string; The applicant sex. Values are male or female.
- InsCommenceAteDate; string; Indicates the date that the inspection commencement will be about to expire.
- InsCommenceExpDate; string; Indicates the date that the inspection commencement will expire.
- InsCommenceGraceDate; string; Indicates the date that the inspection commencement can be extended to.
- InspectionGroup; string; The group of inspections if multiple inspections are required for the permit type.
- IssueDate; string; The date when the permit was issued.
- LastUpdateDate; string; The date when the record was last updated.
- LayoutVersion; string; The layout version used for this record.
- LicensePeriod; string; Indicates the period of license application.
- LicenseStatus; string; Indicates the status of license application.
- LnpRecordId; string; The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
- 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.
- OrganizationName; string; The name of the applicant organization.
- PersonFirstName; string; The applicant first name.
- PersonLastName; string; The applicant last name.
- PersonMiddleName; string; The applicant middle name.
- PersonName; string; The applicant full name.
- PersonNameSuffix; string; The applicant name suffix, such as Junior or Senior.
- PersonPreNameAdjunct; string; The salutation for the applicant, such as Mr. or Mrs.
- PersonTitle; string; The applicant title.
- PhoneAreaCode; string; The area code in the applicant telephone number.
- PhoneCountryCode; string; The country code in the applicant telephone number.
- PhoneExtension; string; The extension for the applicant telephone number.
- PhoneNumber; string; The applicant telephone number.
- PostalCode; string; The postal code in the parcel address.
- PostalPlus4Code; string; The extended postal code in the parcel address.
- PrimaryFlag; string; Indicates whether the record is primary.
- PrimaryRecordId; string; Used to store the parent record ID for a sub-record.
- PrimaryRecordKey; string; Used to store the primary record key for a sub-record.
- ProjectKey; integer; The project to which this permit belongs.
- Province; string; The province in the parcel address.
- ReceivedDate; string; The date on which the transaction was received.
- RecordNumber; string; The public unique identifier of the parent record used in the import process.
- RecordType; string; The user-friendly name for the permit type.
- RecordTypeCode; string; The unique alphanumeric code or short name for the permit type.
- RecordTypeId; string; The unique identifier for a permit type.
- ReissueDate; string; The date when the permit was reissued.
- RenewalDate; string; The date when the permit was renewed.
- State; string; The state in the parcel address.
- Status; string; The permit status.
- SubapplicationFlag; string; Indicates whether the record is a sub application.
- Subclassification; string; The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process.
- SubmitDate; string; The date when the application was submitted.
- SubmittedByName; string; The name of the person who submitted the application.
- SystemStatus; string; The predefined system status to which the record status maps.
- VersionType; string; The version of the permit. Values are original, amendment, and renewal.
- WfNoAmendFlag; string; Indicates 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; Indicates 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; Indicates 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; The workflow process ID.
-
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".
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 : publicSectorRecordQueries
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordQueries-item-response
Type:
Show Source
object
-
AboutToExpireDate: string
(date-time)
Title:
About to Expire Date
Read Only:true
The date to indicate when the permit application is about to expire. -
Address1: string
Title:
Applicant Address Line 1
Read Only:true
Maximum Length:240
The first or main address. -
Address2: string
Title:
Applicant Address Line 2
Read Only:true
Maximum Length:240
The second address, if present. -
Address3: string
Title:
Applicant Address Line 3
Read Only:true
Maximum Length:240
The third address, if present. -
Address4: string
Title:
Applicant Address Line 4
Read Only:true
Maximum Length:240
The fourth address, if present. -
Applicant: integer
(int64)
Title:
Applicant Party ID
Read Only:true
The 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:
true
The unique identifier of the applicant business profile when the applicant is a business entity. -
ApplicantProfileId: integer
(int64)
Title:
Applicant Profile
Read Only:true
The unique identifier of the applicant user profile. -
ApplicantUserId: string
Title:
Applicant User ID
Read Only:true
Maximum Length:20
The user ID of the applicant. -
City: string
Title:
Applicant City
Read Only:true
Maximum Length:60
The city in the parcel address. -
Classification: string
Title:
Classification
Read Only:true
Maximum Length:3
The classification of the permit type. -
ContactLists: array
Record Contact Lists
Title:
Record Contact Lists
The contact list resource is used to find attributes related to the contacts that are added to the permit application. -
Country: string
Title:
Applicant Country
Read Only:true
Maximum Length:3
The country in the address. -
County: string
Title:
Applicant County
Read Only:true
Maximum Length:60
The county in the parcel address. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:3
The currency code used for applying payments. -
DateOfBirth: string
(date-time)
Read Only:
true
The applicant date of birth. -
DepartmentId: string
Title:
Department
Read Only:true
Maximum Length:30
The unique identifier for a department. -
Description: string
Title:
Description
Read Only:true
Maximum Length:300
The record description. -
DocGroupId: string
Read Only:
true
Maximum Length:30
Indicates the document group used by the application. The document group is defined by a set of attachment document categories. -
EmailAddress1: string
Title:
Email
Read Only:true
Maximum Length:320
The applicant main email address. -
EmailAddress2: string
Title:
Email 2
Read Only:true
Maximum Length:320
The applicant secondary email address. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Read Only:true
The date when the permit expires. -
ExpirationGraceDate: string
(date-time)
Read Only:
true
Indicates the date that the application can be extended to. -
ExpirationGroupId: string
Read Only:
true
Maximum Length:50
Identifies the expiration group associated with the record type. -
FullAddress: string
Title:
Address
Read Only:true
Maximum Length:15
The full address of the permit applicant. -
Gender: string
Read Only:
true
Maximum Length:30
The applicant sex. Values are male or female. -
InsCommenceAteDate: string
(date-time)
Read Only:
true
Indicates the date that the inspection commencement will be about to expire. -
InsCommenceExpDate: string
(date-time)
Read Only:
true
Indicates the date that the inspection commencement will expire. -
InsCommenceGraceDate: string
(date-time)
Read Only:
true
Indicates the date that the inspection commencement can be extended to. -
InspectionGroup: string
Read Only:
true
Maximum Length:15
The group of inspections if multiple inspections are required for the permit type. -
IssueDate: string
(date-time)
Title:
Issue Date
Read Only:true
The date when the permit was issued. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LayoutVersion: string
Read Only:
true
Maximum Length:30
The layout version used for this record. -
LicensePeriod: string
Title:
License Period
Read Only:true
Maximum Length:100
Indicates the period of license application. -
LicenseStatus: string
Title:
License Status
Read Only:true
Maximum Length:30
Indicates the status of license application. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Transaction Number
Read Only:true
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: integer
Title:
Transaction Key
Read Only:true
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: string
Title:
Organization Name
Read Only:true
Maximum Length:360
The name of the applicant organization. -
PersonFirstName: string
Title:
Applicant First Name
Read Only:true
Maximum Length:150
The applicant first name. -
PersonLastName: string
Title:
Applicant Last Name
Read Only:true
Maximum Length:150
The applicant last name. -
PersonMiddleName: string
Title:
Applicant Middle Name
Read Only:true
Maximum Length:60
The applicant middle name. -
PersonName: string
Title:
Name
Read Only:true
Maximum Length:450
The applicant full name. -
PersonNameSuffix: string
Read Only:
true
Maximum Length:30
The applicant name suffix, such as Junior or Senior. -
PersonPreNameAdjunct: string
Read Only:
true
Maximum Length:30
The salutation for the applicant, such as Mr. or Mrs. -
PersonTitle: string
Title:
Applicant Title
Read Only:true
Maximum Length:60
The applicant title. -
PhoneAreaCode: string
Title:
Applicant Phone Area Code
Read Only:true
Maximum Length:10
The area code in the applicant telephone number. -
PhoneCountryCode: string
Title:
Applicant Phone Country Code
Read Only:true
Maximum Length:10
The country code in the applicant telephone number. -
PhoneExtension: string
Title:
Extension
Read Only:true
Maximum Length:20
The extension for the applicant telephone number. -
PhoneNumber: string
Title:
Applicant Phone Number
Read Only:true
Maximum Length:40
The applicant telephone number. -
PostalCode: string
Title:
Applicant Postal Code
Read Only:true
Maximum Length:60
The postal code in the parcel address. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:10
The extended postal code in the parcel address. -
PrimaryFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the record is primary. -
PrimaryRecordId: string
Read Only:
true
Maximum Length:50
Used to store the parent record ID for a sub-record. -
PrimaryRecordKey: string
Read Only:
true
Maximum Length:18
Used to store the primary record key for a sub-record. -
ProjectKey: integer
(int64)
Read Only:
true
The project to which this permit belongs. -
Province: string
Title:
Applicant Province
Read Only:true
Maximum Length:60
The province in the parcel address. -
ReceivedDate: string
(date-time)
Read Only:
true
The date on which the transaction was received. -
RecordGISObjects: array
Record GIS Objects
Title:
Record GIS Objects
The record gis object resource is used to view the gis objects that are associated with the application. -
RecordNumber: string
Title:
Record Number
Read Only:true
Maximum Length:64
The public unique identifier of the parent record used in the import process. -
RecordParcel: array
Record Parcel Queries
Title:
Record Parcel Queries
The record parcel queries resource is used to view the parcels that are associated with the application. -
RecordType: string
Title:
Transaction Type
Read Only:true
Maximum Length:100
The user-friendly name for the permit type. -
RecordTypeCode: string
Read Only:
true
Maximum Length:20
The unique alphanumeric code or short name for the permit type. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
The unique identifier for a permit type. -
ReissueDate: string
(date-time)
Title:
Reissue Date
Read Only:true
The date when the permit was reissued. -
RenewalDate: string
(date-time)
Title:
Renewal Date
Read Only:true
The date when the permit was renewed. -
State: string
Title:
Applicant State
Read Only:true
Maximum Length:60
The state in the parcel address. -
Status: string
Title:
Status
Read Only:true
Maximum Length:15
The permit status. -
SubapplicationFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the record is a sub application. -
Subclassification: string
Title:
Subclassification
Read Only:true
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: string
(date-time)
Title:
Submission Date
Read Only:true
The date when the application was submitted. -
SubmittedByName: string
Title:
Submitted By
Read Only:true
The name of the person who submitted the application. -
SystemStatus: string
Title:
System Status
Read Only:true
Maximum Length:15
The predefined system status to which the record status maps. -
VersionType: string
Read Only:
true
Maximum Length:1
The version of the permit. Values are original, amendment, and renewal. -
WfNoAmendFlag: string
Read Only:
true
Maximum Length:1
Indicates 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:
true
Maximum Length:1
Indicates 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:
true
Maximum Length:1
Indicates 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:
true
The workflow process ID.
Nested Schema : Record Contact Lists
Type:
array
Title:
Record Contact Lists
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Record GIS Objects
Type:
array
Title:
Record GIS Objects
The 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:
array
Title:
Record Parcel Queries
The 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:
64
Indicates 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 1
Maximum Length:240
The first address line for the contact person. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second address line for the contact person. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third address line for the contact person. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth address line for the contact person. -
AgencyId: integer
Title:
Agency ID
Default Value:1
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. -
ApplicantFlag: string
Title:
Applicant
Maximum Length:1
Default Value:N
This field indicates if the contact is an applicant. -
AuthorizeAgentFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact person is an authorized user of the license. -
City: string
Title:
City
Maximum Length:60
The city for the contact person's address. -
ContactAccess: string
Maximum Length:
30
Indicates whether the contact is granted access to the application. -
ContactActive: string
Maximum Length:
1
Default Value:Y
The contact status of the person. -
ContactBizPartyId: integer
(int64)
Title:
Contact Business Party
The 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 Key
The unique identifier for the contact. -
ContactPartyId: integer
(int64)
Title:
Contact Party
The contact list party ID. -
ContactProfileId: integer
(int64)
The profile ID of the contact.
-
ContactPuid: string
Maximum Length:
480
The 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 Type
Maximum Length:30
Identifies the contact type of the primary contact of the permit application. -
Country: string
Title:
Country
Maximum Length:3
The country for the contact person. -
County: string
Title:
County
Maximum Length:60
The county for the contact person's address. -
DateOfBirth: string
(date)
Title:
Date of Birth
The date of birth of the contact person's address. -
EmailAddress1: string
Title:
Email
Maximum Length:320
The email for the contact person's address. -
Gender: string
Title:
Gender
Maximum Length:30
The gender for the contact person's gender. -
JobTitle: string
Maximum Length:
60
The job title of the person associated with the contact. -
LicenseHolderFlag: string
Maximum Length:
1
Indicates the person to whom the contractor license was issued. -
LicenseNumber: string
Maximum Length:
30
The license number for the applicant when the contact is an applicant. -
LicenseSetupCode: string
Maximum Length:
30
The setup code for the applicant when the contact is an applicant. -
LicenseType: string
Maximum Length:
30
The license type for the applicant when the contact is an applicant. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpBusinessOwnersKey: integer
(int64)
Unique identifier for the business owner.
-
LnpBusinessOwnersPuid: string
Maximum Length:
480
The unique identifier for the business owner in the legacy system. -
LnpRecordId: string
Title:
Record 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: integer
(int64)
Title:
Record
The unique identifier for a permit type. -
MakeApplicantDate: string
(date)
The date when the contact was made a previous applicant.
-
OrganizationName: string
Title:
Organization
Maximum Length:360
The name of the applicant's organization. -
OwnerFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact person is a business owner. -
PersonFirstName: string
Title:
First Name
Maximum Length:150
The contact person's first name. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The contact person's last name. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The contact person's middle name. -
PersonName: string
Title:
Display Name
Maximum Length:450
The contact person's name. -
PersonNameSuffix: string
Title:
Suffix
Maximum Length:30
The contact name suffix, such as Junior or Senior. -
PersonPreNameAdjunct: string
Title:
Salutation
Maximum Length:30
The salutation for the contact such as Mr. or Mrs. -
PersonTitle: string
Title:
Title
Maximum Length:60
The title of the contact person. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:10
The area code in the contact telephone number. -
PhoneAreaCodeAlt: string
Maximum Length:
10
The alternate area code in the contact person's telephone number. -
PhoneCountryCode: string
Title:
Country Code
Maximum Length:10
The country code in the contact telephone number. -
PhoneCountryCodeAlt: string
Maximum Length:
10
The alternate country code in the contact person telephone number. -
PhoneExtension: string
Title:
Extension
Maximum Length:20
The extension for the contact's telephone number. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
The contact person's phone number. -
PhoneNumberAlt: string
Maximum Length:
40
The contact person's telephone number. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code for the contact person's address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:10
The extended postal code in the contact list. -
PreviousApplicantFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the contact is the previous applicant. The default value is N. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates 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:
Province
Maximum Length:60
The province in the contact person's address. -
RecordNumber: string
Maximum Length:
64
The public unique identifier of the parent record. -
State: string
Title:
State
Maximum Length:60
The state in the contact person's address.
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.
Nested Schema : publicSectorRecordQueries-RecordGISObjects-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
CreationDate: string
(date-time)
Read Only:
true
The 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:
100
The unique identifier for the layer that the GIS object belongs to. -
GisObjDisplayAttrs: string
Maximum Length:
4000
The collection of display attributes for the GIS object. -
GisObjIdAttrs: string
Maximum Length:
2000
The 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:
true
The date when the GIS object was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Maximum Length:
50
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Shape
Type:
object
The 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:
200
The information about additional structures located on the parcel. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the public sector agency associated with the parcel. -
Bathrooms: string
Maximum Length:
20
The number of bathrooms in the building on the parcel. -
Bedrooms: string
Maximum Length:
20
The number of bedrooms in the building on the parcel. -
BlockNumber: 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: 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: 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: string
Maximum Length:
100
The neighborhood information related to the location of the parcel. -
CensusTract: string
Maximum Length:
100
The neighborhood information related to the location of the parcel. -
ClimateZone: string
Maximum Length:
200
The climate zone information of the parcel. -
CoordinateX: number
Title:
Coordinate X
The x-axis coordinate for the record parcel. -
CoordinateY: number
Title:
Coordinate Y
The y-axis coordinate for the record parcel. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record parcel was created. -
DistrictName: string
Title:
District
Maximum Length:50
The district name of the parcel. -
DwellingUnitCount: integer
(int64)
The count of dwelling units in the record parcel.
-
FireRisk: string
Maximum Length:
200
The fire risk information related to the parcel. -
FloodInsRateMap: string
Maximum Length:
200
The Flood Insurance Rate Map related to the parcel. -
FloodZone: string
Maximum Length:
200
The detailed land information of the parcel. -
GeneralPlanTwo: string
Maximum Length:
30
The alternate plan information of the parcel. -
Jurisdiction: string
Title:
Jurisdiction
Maximum Length:50
The name of the city, if incorporated, or the name of the county, if unincorporated. -
LandslideRisk: string
Maximum Length:
200
The landslide risk information related to the parcel. -
LandUseCode: 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: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record parcel was last updated. -
Latitude: number
Title:
Latitude
The geographic location of the parcel that is north or south of the equator. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LiquefactionRisk: string
Maximum Length:
200
The liquefaction risk information of the parcel. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The unique identifier for the application record. -
LnpRecordKey: integer
(int64)
Title:
Record
The unique identifier for the record associated with the parcel. -
Longitude: 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: 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: string
Title:
Map Book Page
Maximum Length:50
The recorded map book and page. -
MapName: string
Title:
Map Name
Maximum Length:50
The recorded map name. For example, Public Works. -
PageNumber: 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). -
ParcelAddress: array
Parcel Addresses
Title:
Parcel Addresses
The parcel addresses resource is used to view the parcel addresses. -
ParcelId: integer
(int64)
Title:
Parcel
The identifier of the record parcel. -
ParcelIdEntered: string
Title:
Parcel
Maximum Length:30
The Assessor Parcel Number (APN) as entered by the user. -
ParcelKey: integer
(int64)
Title:
Parcel Key
The unique identifier for the parcel associated with a parcel address. -
ParcelOwner: array
Parcel Owners
Title:
Parcel Owners
The parcel owners resource is used to view the parcel owners. -
ParcelSizeOne: number
The first parcel size.
-
ParcelSizeOneUnit: string
Maximum Length:
10
The unit of measure for the first parcel size. -
ParcelSizeTwo: number
The second parcel size.
-
ParcelSizeTwoUnit: string
Maximum Length:
10
The unit of measure for the second parcel size. -
ParcelStatus: string
Maximum Length:
20
Default Value:ORA_FIN
The status of the parcel, which is Final or Provisional. -
ParcelType: string
Title:
Parcel Type
Maximum Length:30
The type of the parcel. For example, commercial, residential, or government. -
ParentParcelId: integer
(int64)
Title:
Parent Parcel
The unique identifier of the parent record parcel. -
Patio: string
Maximum Length:
200
The information about patios located on the parcel. -
Pool: string
Maximum Length:
200
The information about pools located on the parcel. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
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: string
Title:
Primary Zone
Maximum Length:30
The primary zoning ID of the zoning for the parcel. -
PropertyDescription: string
Title:
Property Description
Maximum Length:240
The property description. -
SectionNumber: 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). -
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:
200
The soil type information of the parcel. -
Srid: integer
(int64)
Title:
SRID
The GIS coordinate system in use. -
StructureSizeOne: number
The first structure size.
-
StructureSizeOneUnit: string
Maximum Length:
10
The unit of measure for the first structure size. -
StructureSizeTwo: number
The second structure size.
-
StructureSizeTwoUnit: string
Maximum Length:
10
The unit of measure for the second structure size. -
Subdivision: 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: string
Maximum Length:
100
The area Identifier of the parcel location for tax purposes. -
UnitNumber: 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: string
Maximum Length:
4
The year in which the building on the parcel was built. -
ZoningCodeTwo: string
Maximum Length:
30
The secondary zoning code of the parcel. -
ZoningDescription: string
Title:
Zone Description
Maximum Length:240
The zoning description.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Parcel Addresses
Type:
array
Title:
Parcel Addresses
The parcel addresses resource is used to view the parcel addresses.
Show Source
Nested Schema : Parcel Owners
Type:
array
Title:
Parcel Owners
The parcel owners resource is used to view the parcel owners.
Show Source
Nested Schema : Shape
Type:
object
The 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 1
Maximum Length:240
-
Address2: string
Title:
Address Line 2
Maximum Length:240
-
Address3: string
Title:
Address Line 3
Maximum Length:240
-
Address4: string
Title:
Address Line 4
Maximum Length:240
-
AddressId: integer
(int64)
Title:
Address
-
AddressKey: integer
(int64)
Title:
Address Key
-
AddressType: string
Title:
Address Type
Maximum Length:20
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
-
BuildingType: string
Title:
Building
Maximum Length:20
-
CellPhoneCountry: string
Title:
Cell Phone Country
Maximum Length:10
-
CellPhoneNumber: string
Title:
Cell Phone
Maximum Length:40
-
City: string
Title:
City
Maximum Length:60
-
CoordinateX: number
Title:
Coordinate X
-
CoordinateY: number
Title:
Coordinate Y
-
Country: string
Title:
Country
Maximum Length:60
-
County: string
Title:
County
Maximum Length:60
-
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
-
CrossroadOne: string
Maximum Length:
240
-
CrossroadTwo: string
Maximum Length:
240
-
EmailId: string
Title:
Email
Maximum Length:50
-
FaxCountry: string
Title:
Fax Country
Maximum Length:10
-
FaxNumber: string
Title:
Fax
Maximum Length:40
-
Floor: string
Title:
Floor
Maximum Length:20
-
HomePhoneCountry: string
Title:
Home Phone Country
Maximum Length:10
-
HomePhoneNumber: string
Title:
Home Phone
Maximum Length:40
-
InputSource: string
Title:
Source
Maximum Length:1
-
Landmark: string
Maximum Length:
200
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
Latitude: number
Title:
Latitude
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
-
LnpRecordKey: integer
(int64)
Title:
Record
-
Longitude: number
Title:
Longitude
-
MunicipalityId: string
Title:
Municipality
Maximum Length:20
-
ParcelId: integer
(int64)
Title:
Parcel
-
ParcelKey: integer
(int64)
Title:
Parcel Key
-
PostalCode: string
Title:
Postal Code
Maximum Length:60
-
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
-
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
-
PrimaryTransAddress: boolean
Title:
Primary Transaction Address
Maximum Length:1
-
Province: string
Title:
Province
Maximum Length:60
-
Srid: integer
(int64)
Title:
SRID
-
State: string
Title:
State
Maximum Length:60
-
StreetDirection: string
Title:
Direction
Maximum Length:10
-
StreetName: string
Title:
Street
Maximum Length:240
-
StreetNameConcat: string
Maximum Length:
350
-
StreetNumber: string
Title:
Street Number
Maximum Length:20
-
StreetSuffix: string
Maximum Length:
20
-
StreetType: string
Title:
Street Type
Maximum Length:20
-
UnitNumber: string
Title:
Unit
Maximum Length:30
-
WorkPhoneCountry: string
Title:
Work Phone Country
Maximum Length:10
-
WorkPhoneNumber: string
Title:
Work Phone
Maximum Length:40
Nested Schema : Links
Type:
array
Title:
Links
The 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 1
Maximum Length:240
-
Address2: string
Title:
Address Line 2
Maximum Length:240
-
Address3: string
Title:
Address Line 3
Maximum Length:240
-
Address4: string
Title:
Address Line 4
Maximum Length:240
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
-
BuildingType: string
Title:
Building
Maximum Length:20
-
CellPhoneCountry: string
Title:
Cell Phone Country
Maximum Length:10
-
CellPhoneNumber: string
Title:
Cell Phone
Maximum Length:40
-
City: string
Title:
City
Maximum Length:60
-
Country: string
Title:
Country
Maximum Length:60
-
County: string
Title:
County
Maximum Length:60
-
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
-
DocumentNumber: string
Title:
Document
Maximum Length:50
-
EmailId: string
Title:
Email
Maximum Length:50
-
FaxCountry: string
Title:
Fax Country
Maximum Length:10
-
FaxNumber: string
Title:
Fax
Maximum Length:40
-
Floor: string
Title:
Floor
Maximum Length:20
-
HomePhoneCountry: string
Title:
Home Phone Country
Maximum Length:10
-
HomePhoneNumber: string
Title:
Home Phone
Maximum Length:40
-
LastTransferDate: string
(date)
Title:
Last Transfer Date
-
LastTransferType: string
Title:
Last Transfer Type
Maximum Length:50
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
-
LnpRecordKey: integer
(int64)
Title:
Record
-
Owner: string
Title:
Owner
Maximum Length:150
-
OwnerId: integer
(int64)
Title:
Owner
-
OwnerKey: integer
(int64)
Title:
Owner Key
-
OwnerType: string
Title:
Ownership Type
Maximum Length:20
-
ParcelId: integer
(int64)
Title:
Parcel
-
ParcelKey: integer
(int64)
Title:
Parcel Key
-
PostalCode: string
Title:
Postal Code
Maximum Length:60
-
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
-
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
-
Province: string
Title:
Province
Maximum Length:60
-
SecondaryOwner: string
Title:
Secondary Owner
Maximum Length:150
-
State: string
Title:
State
Maximum Length:60
-
StreetDirection: string
Title:
Direction
Maximum Length:10
-
StreetName: string
Title:
Street
Maximum Length:240
-
StreetNumber: string
Title:
Street Number
Maximum Length:20
-
StreetType: string
Title:
Street Type
Maximum Length:20
-
UnitNumber: string
Title:
Unit
Maximum Length:30
-
WorkPhoneCountry: string
Title:
Work Phone Country
Maximum Length:10
-
WorkPhoneNumber: string
Title:
Work Phone
Maximum Length:40
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source