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

Get all IVR inspections

get

/fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections

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 the IVR inspection that matches the specified primary key criteria.
      Finder Variables:
      • InspectionKey; integer; The unique identifier for the IVR inspection.
    • RowFinder: Finds an IVR inspection by INSPECTION_ID and LNP_RECORD_KEY.
      Finder Variables:
      • INSPECTION_ID; string; The unique identifier for an inspection. Identifies the inspection transaction on the inspection list page and generated based on the automatic number rule configured for this inspection type, for example, E2018-00006.
      • IVR_ACCESS_CODE; string; The IVR password associated with the record's applicant user profile, or the user profile of any of the record's registered contacts.
      • LNP_RECORD_KEY; integer; The unique identifier for an application record. The record is for permits, business licenses, or planning and zoning, and 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.
  • 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:
    • ActlTravelTimeFromHrs; number; The travel time from the inspection site in hours.
    • ActlTravelTimeToHrs; number; The travel time to the inspection site in hours.
    • ActualDurationHrs; number; The actual duration of the inspection in hours.
    • ActualEndDttm; string; The actual end date of the inspection.
    • ActualStartDttm; string; The actual start date of the inspection.
    • Address1; string; The first line of the inspection address.
    • Address2; string; The second line of the inspection address.
    • Address3; string; The third line of the inspection address.
    • Address4; string; The fourth line of the inspection address.
    • AddressId; integer; The unique identifier of the record parcel address.
    • AgencyId; integer; The identifier for the public sector agency associated with the inspection.
    • BillType; string; The bill type that determines the invoice type generated for this inspection.
    • BillableFlag; boolean; Indicates whether the inspection is billable. The value defaults from the inspection type associated with the inspection.
    • CancellationReason; string; The reason for canceling the inspection.
    • City; string; The city of the inspection address.
    • Classification; string; The classification of the record.
    • ContactEmail; string; The inspection location contact???s email address.
    • ContactName; string; The name of the contact person for the inspection.
    • ContractorSignatureDttm; string; The date and time when the contractor signed the inspection.
    • Country; string; The country of the inspection address.
    • County; string; The county in the inspection address.
    • CreationDate; string; The date when the record was created.
    • Description; string; The description of the inspection transaction.
    • DistanceUOM; string; The distance unit of measure. The prompt is the common units table.
    • EstimatedDurationHrs; number; The estimated duration of the inspection in hours.
    • EstimatedTimeArrival; string; The estimated time of arrival at the inspection site.
    • EstimatedTimeArrivalEnd; string; The estimated end time of arrival at the inspection site.
    • FinalInspectionFlag; boolean; Indicates whether this is the final inspection. The default is no.
    • HideInspectorComment; string; Indicates whether the inspector's comments are hidden from public users. This value defaults from the inspection type.
    • InspectionCompleteDttm; string; The date and time when the inspection was completed.
    • InspectionDistrictId; string; The unique identifier for the inspection district.
    • InspectionId; string; The unique identifier for an inspection. Identifies the inspection transaction on the inspection list page and generated based on the automatic number rule configured for this inspection type, for example, E2018-00006.
    • InspectionKey; integer; The unique identifier of an inspection.
    • InspectionLocation; string; An optional descriptive name of the inspection location, such as Bank of America Building or corner lot.
    • InspectionName; string; The description of the inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection.
    • InspectionRating; string; The calculated rating based on the rating method.
    • InspectionResult; string; The result of an inspection, such as Pass, Fail, Yes, and No. This is informational only. You can't assign a result to an inspection through IVR.
    • InspectionScore; integer; The calculated total inspection score.
    • InspectionSource; string; The source from which the inspection was created.
    • InspectionStatus; string; The status of the inspection.
    • InspectionType; string; The type of the inspection, such as Electrical.
    • InspectorSignatureDttm; string; The date and time when the inspector signed the inspection.
    • LastUpdateDate; string; The date the inspection was last updated.
    • LicensePeriod; string; The reporting period that applies to the business license.
    • LnpRecordId; string; A unique identifier for a record. This identifier is automatically generated based on the rules configured for the record type.
    • LnpRecordKey; integer; The unique identifier for an application record. The record is for permits, business licenses, or planning and zoning, and is determined by the classification.
    • LocationLatitude; number; The latitude coordinate of the inspection location.
    • LocationLongitude; number; The longitude coordinate of the inspection location.
    • NoneResultItemCount; number; The number of checklist items for the inspection for which there is no inspection result.
    • NumberMajorViolations; integer; The calculated total number of major violations for the inspection.
    • OwnerSignatureDttm; string; The date and time when the owner signed the inspection.
    • ParcelId; integer; The unique identifier of the record parcel.
    • PhoneAreaCode; string; The contact's phone area code.
    • PhoneCountryCode; string; The contact's international country code for the phone number.
    • PhoneExtension; string; The contact's additional phone number extension.
    • PhoneNumber; string; The contact???s phone number.
    • PostalCode; string; The postal code in the inspection address.
    • PostalPlus4Code; string; The extended postal code in the inspection address.
    • PreferredContactMethod; string; The inspection location contact???s preferred contact method.
    • PreferredDate; string; The preferred date for the inspection.
    • PreferredTime; string; The preferred time for the inspection, for example Morning or Afternoon.
    • Province; string; The province in the inspection address.
    • ReadyByDttm; string; The date and time that the inspection site will be ready for the inspection to be performed.
    • RecordType; string; The user-friendly name for the record type.
    • ReinspectionFlag; boolean; Indicates whether this is a reinspection. The default is no.
    • RequestedDate; string; The date when the inspection was requested.
    • RequestedTime; string; The time when the inspection was requested.
    • RequestorComment; string; The inspection requester's comments.
    • ScheduledEndDttm; string; The scheduled inspection end date.
    • ScheduledStartDate; string; The date when the inspection was scheduled.
    • ScheduledStartDttm; string; The scheduled inspection start date.
    • ScheduledStartTime; string; The time when the inspection was scheduled.
    • State; string; The state in the inspection address.
    • StatusTime; string; The date and time value of the scheduled inspection start time, requested inspection start time, or last updated date, which is determined by the inspection status.
    • StreetNumber; string; The street number of the parcel address, or the first four characters of the parcel address.
    • Subclassification; string; The subclassification for the record type, which indicates that the pre-application process is included in addition to the hearing process.
    • SystemResult; string; The unique alphanumeric code or short name for the inspection result.
    • SystemStatus; string; The unique alphanumeric code or short name for the inspection status.
    • TravelFromActualDistance; number; The total distance traveled from the inspection site.
    • TravelFromEndOdometer; number; The odometer reading upon arrival at the next location.
    • TravelFromStartOdometer; number; The odometer reading before travel from the inspection site.
    • TravelToActualDistance; number; The total distance traveled to the inspection site.
    • TravelToEndOdometer; number; The odometer reading upon arrival at the site.
    • TravelToStartOdometer; number; The odometer reading before travel to the inspection site.
    • 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 : publicSectorIVRInspections
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorIVRInspections-item-response
Type: object
Show Source
Back to Top