Get a permit
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordParcelAddressSearchQueries/{publicSectorRecordParcelAddressSearchQueriesUniqID}
Request
Path Parameters
-
publicSectorRecordParcelAddressSearchQueriesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- LnpRecordKey, ParcelKey and AddressKey ---for the Record Parcel Address Search Queries resource and used to uniquely identify an instance of Record Parcel Address Search Queries. The client should not generate the hash key value. Instead, the client should query on the Record Parcel Address Search Queries collection resource with a filter on the primary key values in order to navigate to a specific instance of Record Parcel Address Search Queries.
For example: publicSectorRecordParcelAddressSearchQueries?q=LnpRecordKey=<value1>;ParcelKey=<value2>;AddressKey=<value3>
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 : publicSectorRecordParcelAddressSearchQueries-item-response
Type:
Show Source
object
-
AddressKey: integer
(int64)
Read Only:
true
The unique identifier for the parcel address associated with a parcel. -
Applicant: integer
(int64)
Read Only:
true
The 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)
Read Only:
true
The unique identifier of the applicant user profile. -
City: string
Read Only:
true
Maximum Length:60
The city name in the parcel address. -
Classification: string
Read Only:
true
Maximum Length:3
The classification of the permit type. -
Description: string
Read Only:
true
Maximum Length:1000
The record description. -
DistrictName: string
Read Only:
true
Maximum Length:50
The district name of the parcel. -
IssueDate: string
(date-time)
Read Only:
true
The date on which the permit was issued. -
Jurisdiction: string
Read Only:
true
Maximum Length:50
The name of the city, if incorporated, or the name of the county, if unincorporated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
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
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. -
Paddressfour: string
Read Only:
true
Maximum Length:240
The fourth parcel address, if present. -
Paddressone: string
Read Only:
true
Maximum Length:240
The first or main parcel address. -
Paddressthree: string
Read Only:
true
Maximum Length:240
The third parcel address, if present. -
Paddresstwo: string
Read Only:
true
Maximum Length:240
The second parcel address, if present. -
PaPrimary: string
Read Only:
true
Maximum Length:1
Indicates flag value for the primary parcel address. -
ParcelFullAddress: string
Read Only:
true
Maximum Length:966
The full address of the parcel. -
ParcelId: integer
(int64)
Read Only:
true
The identifier of the record parcel. -
ParcelIdEntered: string
Read Only:
true
Maximum Length:30
The Assessor Parcel Number (APN) as entered by the user. -
ParcelKey: integer
(int64)
Read Only:
true
The unique identifier for the parcel associated with a parcel address. -
ParcelPrimary: string
Read Only:
true
Maximum Length:1
Indicates flag value for the primary parcel. -
PersonFirstName: string
Read Only:
true
Maximum Length:150
The first name of the applicant. -
PersonLastName: string
Read Only:
true
Maximum Length:150
The last name of the applicant. -
PersonMiddleName: string
Read Only:
true
Maximum Length:60
The middle name of the applicant. -
PersonName: string
Read Only:
true
Maximum Length:450
The full name of the applicant. -
PersonNameSuffix: string
Read Only:
true
Maximum Length:30
The suffix of the applicant name, 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
Read Only:
true
Maximum Length:60
The title of the applicant. -
PostalCode: string
Read Only:
true
Maximum Length:60
The postal code in the parcel address. -
PrimaryAddress: string
Read Only:
true
Maximum Length:966
The primary address of the parcel. -
ProjectKey: integer
(int64)
Read Only:
true
The project to which this permit belongs. -
PropertyDescription: string
Read Only:
true
Maximum Length:240
The property description. -
RecordType: string
Read Only:
true
Maximum Length:100
The user-friendly name for the permit type. -
RecordTypeCode: string
Read Only:
true
Maximum Length:20
The record type code of the parcel address. -
RenewalDate: string
(date-time)
Read Only:
true
The date on which the permit was renewed. -
State: string
Read Only:
true
Maximum Length:60
The state name in the parcel address. -
Status: string
Read Only:
true
Maximum Length:15
The status of the parcel address. -
StreetName: string
Read Only:
true
Maximum Length:240
The street name in the parcel adress. -
StreetNumber: string
Read Only:
true
Maximum Length:20
The street number in the parcel adress. -
SubmitDate: string
(date-time)
Read Only:
true
The date on which the application was submitted. -
SystemStatus: string
Read Only:
true
Maximum Length:15
The predefined system status to which the record status maps. -
TransPrimary: string
Read Only:
true
Maximum Length:1
Indicates flag value for the transaction primary. -
UnitNumber: string
Read Only:
true
Maximum Length:30
The unit number in the parcel 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.