1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Permits
  4. Record Parcel Address Search Queries

Get all permits

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordParcelAddressSearchQueries

Request

Query Parameters
  • 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).
  • 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
  • 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:
      • AddressKey; integer; The unique identifier for a parcel address.
      • 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.
      • ParcelKey; integer; The unique identifier for a permit parcel.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AddressKey; integer; The unique identifier for the parcel address associated with a parcel.
    • Applicant; integer; The 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.
    • City; string; The city name in the parcel address.
    • Classification; string; The classification of the permit type.
    • Description; string; The record description.
    • DistrictName; string; The district name of the parcel.
    • IssueDate; string; The date on which the permit was issued.
    • Jurisdiction; string; The name of the city, if incorporated, or the name of the county, if unincorporated.
    • 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.
    • PaPrimary; string; Indicates flag value for the primary parcel address.
    • Paddressfour; string; The fourth parcel address, if present.
    • Paddressone; string; The first or main parcel address.
    • Paddressthree; string; The third parcel address, if present.
    • Paddresstwo; string; The second parcel address, if present.
    • ParcelFullAddress; string; The full address of the parcel.
    • ParcelId; integer; The identifier of the record parcel.
    • ParcelIdEntered; string; The Assessor Parcel Number (APN) as entered by the user.
    • ParcelKey; integer; The unique identifier for the parcel associated with a parcel address.
    • ParcelPrimary; string; Indicates flag value for the primary parcel.
    • PersonFirstName; string; The first name of the applicant.
    • PersonLastName; string; The last name of the applicant.
    • PersonMiddleName; string; The middle name of the applicant.
    • PersonName; string; The full name of the applicant.
    • PersonNameSuffix; string; The suffix of the applicant name, such as Junior or Senior.
    • PersonPreNameAdjunct; string; The salutation for the applicant, such as Mr. or Mrs.
    • PersonTitle; string; The title of the applicant.
    • PostalCode; string; The postal code in the parcel address.
    • PrimaryAddress; string; The primary address of the parcel.
    • ProjectKey; integer; The project to which this permit belongs.
    • PropertyDescription; string; The property description.
    • RecordType; string; The user-friendly name for the permit type.
    • RecordTypeCode; string; The record type code of the parcel address.
    • RenewalDate; string; The date on which the permit was renewed.
    • State; string; The state name in the parcel address.
    • Status; string; The status of the parcel address.
    • StreetName; string; The street name in the parcel adress.
    • StreetNumber; string; The street number in the parcel adress.
    • SubmitDate; string; The date on which the application was submitted.
    • SystemStatus; string; The predefined system status to which the record status maps.
    • TransPrimary; string; Indicates flag value for the transaction primary.
    • UnitNumber; string; The unit number in the parcel address.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorRecordParcelAddressSearchQueries
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorRecordParcelAddressSearchQueries-item-response
Type: object
Show Source
Back to Top