1. REST API for Oracle Public Sector Licensing and Permitting
  2. Tasks
  3. Permits
  4. Record Lists

Get all records, record parcels, and parcel addresses

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordLists

Request

Query Parameters
  • This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • 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:

    • AssignedActivePZFinder: Finds an active planning and zoning application using the specified keyword. Finder Variables:
      • bAssigneeUserId; string; Filters the transaction relation for the current logged in user.
      • value; string; The keyword used to find an active license application by record ID, record type, system status, classification, lnprecord ID, record type, status, person name, created by, creation date criteria, expiration date criteria, total due criteria, total criteria, record parcel, address 1, address 2, or city.
    • AgencyViewFinder: Finds records for the agency.
    • AgencyActiveLICSearchFinder: Finds the active license applications for the agency. Finder Variables:
      • value; string; The keyword used to find an active license application by record ID, record type, system status, current trans flag, record id, record type, status, preson name, created by, BUS_BUSINESS_NAME, BUS_DBA_BUSINESS_NAME, BUS_DESCRIPTION, BUS_START_DATE, BUS_BUSINESS_LEGAL_NAME, BUS_ADDRESS1, BUS_ADDRESS2, BUS_CITY, CREATION_DATE_CRITERIA, EXPIRATION_DATE_CRITERIA, TOTAL_DUE_CRITERIA, or TOTAL_CRITERIA.
    • RecordListSearchFinder: Finds a record using the specified keyword. Finder Variables:
      • value; string; The keyword used to find a record by record ID, record type, status, description, person name, user who created the record, or up to four parcel addresses.
    • publicSearchFinder: Finds a record by the specified keyword, for use by public users. Finder Variables:
      • value; string; The keyword used to find a record by record ID, record type, record status, creation date, expiration date, fees due, total fees, primary or secondary parcel address, or city.
    • BLGlobalSearchFinder: Finds an active global list by the specified keyword. Finder Variables:
      • value; string; The keyword used to find an active license application by record ID, record type, record id, record type, status, preson name, created by, BUS_BUSINESS_NAME, BUS_DBA_BUSINESS_NAME, BUS_DESCRIPTION, BUS_START_DATE, BUS_BUSINESS_LEGAL_NAME, BUS_ADDRESS1, BUS_ADDRESS2, BUS_CITY, CREATION_DATE_CRITERIA, EXPIRATION_DATE_CRITERIA, TOTAL_DUE_CRITERIA, and TOTAL_CRITERIA.
    • ActiveMasterBLListFinder: Finds an active BL master list by the specified keyword. Finder Variables:
      • value; string; The keyword used to find an active master list by record ID, record type, status, person name, the user who created the record, or creation date.
    • PublicUserViewFinder: Finds records for the public user.
    • AgencyActivePMTSearchFinder: Finds active permit applications for the agency. Finder Variables:
      • value; string; The keyword used to find an active permit application by record ID, record type, status, person name, user who created the record, creation date, expiration date, fees due, total fees, the primary or secondary parcel address, or city.
    • PublicUserActiveSearchFinder: Finds active records by the specified keyword, for use by public users. Finder Variables:
      • value; string; The keyword used to find an active permit application by record ID, record type, status, person name, user who created the record, creation date, expiration date, fees due, total fees, the primary or secondary parcel address, or city.
    • agencySearchFinder: Finds a record by the specified keyword, for use by agency staff. Finder Variables:
      • value; string; The keyword used to find a record by record ID, record type, status, person name, user who created the record, creation date, expiration date, fees due, total fees, the primary or secondary parcel address, or city.
    • AgencyActivePZSearchFinder: Finds active planning applications for the agency. Finder Variables:
      • value; string; The keyword used to find an active planning application by record ID, record type, status, person name, user who created the record, creation date, expiration date, fees due, total fees, the primary or secondary parcel address, or city.
    • ActiveMasterBLListForShowAllFinder: Finds an active BL master list by the specified keyword. Finder Variables:
      • value; string; The keyword used to find an active license application by record ID, record type, system status, current trans flag, record id, record type, status, preson name, created by, BUS_BUSINESS_NAME, BUS_DBA_BUSINESS_NAME, BUS_DESCRIPTION, BUS_START_DATE,BUS_BUSINESS_LEGAL_NAME, BUS_ADDRESS1, BUS_ADDRESS2, BUS_CITY, CREATION_DATE_CRITERIA, EXPIRATION_DATE_CRITERIA, TOTAL_DUE_CRITERIA, or TOTAL_CRITERIA.
    • UnAssignedActivePZFinder: Finds inactive planning and zoning applications by the specified keyword. Keywords can contain system status, classification, or assigned user ID. Finder Variables:
      • value; string; Finds the record ID, record type, address, and description.
    • PrimaryKey: Finds a record by 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.
  • 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.
  • 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 attributes. 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
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : publicSectorRecordLists
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorRecordLists-item
Type: object
Show Source
Nested Schema : Business Locations
Type: array
Title: Business Locations
The business locations resource is used to view the business locations.
Show Source
Nested Schema : Business Owners
Type: array
Title: Business Owners
The business owners resource is used to view the business owners.
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 : Parcels
Type: array
Title: Parcels
The record parcels resource is used to view the parcels that are associated with the application.
Show Source
Nested Schema : publicSectorRecordLists-BusinessLocation-item
Type: object
Show Source
Nested Schema : publicSectorRecordLists-BusinessOwner-item
Type: object
Show Source
Nested Schema : publicSectorRecordLists-ParcelAddress-item
Type: object
Show Source
Nested Schema : publicSectorRecordLists-RecordParcel-item
Type: object
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 : publicSectorRecordLists-RecordParcel-ParcelAddress-item
Type: object
Show Source
Back to Top