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

Get all IVR records

get

/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordLists

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 an IVR record that matches the specified primary key criteria.
      Finder Variables:
      • LnpRecordKey; integer; The unique identifier for a record. The record can be for permits, business licenses, or planning and zoning, which is determined by the classification.
    • RowFinder: Finds an IVR record using LNP_RECORD_ID.
      Finder Variables:
      • IVR_ACCESS_CODE; string; The IVR password associated with the permit's applicant user profile, or the user profile of any of the permit's registered contacts.
      • LNP_RECORD_ID; string; The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
  • 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:
    • AboutToExpireDate; string; The date when the record is about to expire.
    • Address1; string; The first line of the parcel address.
    • Address2; string; The second line of the parcel address.
    • Address3; string; The third line of the parcel address.
    • Address4; string; The fourth line of the parcel address.
    • AddressId; integer; The unique identifier for the parcel address.
    • Classification; string; The record classification. The classifications can be permits, business licenses, or planning and zoning.
    • CreationDate; string; The date when the record was created.
    • CrossroadOne; string; The first crossroad of the intersection.
    • CurrencyCode; string; The currency code used for applying payments.
    • Description; string; The record description.
    • ExpirationDate; string; The date when the record expires.
    • InspectionGroup; string; The group of inspections if multiple inspections are required for the record type.
    • InspectionGroupAmend; string; The group of inspections for business license amendments if multiple inspections are required for the record type.
    • InspectionGroupRenew; string; The group of inspections for business license renewals if multiple inspections are required for the record type.
    • IssueDate; string; The date when the application was issued.
    • LicensePeriod; string; The reporting period that applies to the business license.
    • 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 can be for permits, business licenses, or planning and zoning, which is determined by the classification.
    • ParcelId; integer; The unique identifier for the parcel.
    • ProjectKey; integer; The project to which this record belongs.
    • RecordType; string; The user-friendly name for the record type.
    • RecordTypeCode; string; The unique alphanumeric code or short name for the record type.
    • RecordTypeId; string; The unique identifier for a record type.
    • Status; string; The record status.
    • StreetDirection; string; The street direction of the parcel address.
    • StreetName; string; The street name of the parcel address.
    • StreetNumber; string; The street number of the parcel address, or the first 4 characters of the parcel address.
    • StreetSuffix; string; The street suffix of the parcel address that further describes that street like Drive or Avenue.
    • StreetType; string; The street type of the parcel address.
    • 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 record was submitted.
    • SystemStatus; string; The predefined system status that the record status maps to.
    • Total; number; The total amount of fees for this record.
    • TotalDue; number; The amount of fees that are currently due for this record.
    • TotalPaid; number; The amount paid toward the total fees for this record.
    • UnitNumber; string; The unit number of the parcel address.
    • VersionType; string; The activity for business license type for which options are set, such as origination, amendment, or renewal.
  • 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 : publicSectorIVRRecordLists
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorIVRRecordLists-item-response
Type: object
Show Source
Back to Top