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

Get all the project record inspections

get

/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordInspections

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:

    • InspectionsByDateFinder: Finds the record inspections assigned to a project that match the specified finder criteria.
      Finder Variables:
      • Bind_EndDate; string; Finds the record inspections assigned to a project that match the specified date criteria.
      • Bind_StartDate; string; Finds the record inspections assigned to a project that match the specified date criteria.
    • PrimaryKey: Finds the row that matches the specified primary key.
      Finder Variables:
      • InspectionId; string; The unique identifier of the inspection.
      • ProjectCode; string; The unique identifier string for the project.
      • RecordKey; integer; The identifier of the application record. The value is generated based on the auto number rule configured for the type of record.
    • simpleSearchFinder: Finds the record inspection assigned to a project that matches the specified keyword.
      Finder Variables:
      • value; string; The keyword used to find the inspection of the record assigned to a project.
  • 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 number of hours taken by the inspector to return home or office from the inspection site.
    • ActlTravelTimeToHrs; number; The number of hours taken by the inspector to arrive at the inspection site from home or office.
    • ActualDurationHrs; number; The actual number of hours taken to complete the inspection.
    • ActualEndDttm; string; The actual date and time when the inspection ended.
    • ActualStartDttm; string; The actual date and time when the inspection started.
    • Address1; string; The first or main address.
    • Address2; string; The second address, if available.
    • Address3; string; The third address, if available.
    • Address4; string; The fourth address, if available.
    • AddressId; integer; The identifier of the parcel address.
    • AgencyId; integer; The unique identifier of the public sector agency.
    • ApplicantBizProfileId; integer; The profile ID of the business of the applicant.
    • ApplicantProfileId; integer; The profile ID of the applicant.
    • BillType; string; The type of invoice that is generated for the inspection transaction.
    • BillableFlag; string; Indicates whether the inspection is a billable transaction. The default value is No.
    • CancellationReason; string; The reason for cancellation.
    • City; string; The city of the inspection location.
    • ContactEmail; string; The email address of the contact.
    • ContactName; string; The name of the contact.
    • ContractorName; string; The name of the contractor.
    • ContractorSignatureDttm; string; The date and time when the contractor signed.
    • CoordinateX; number; The x-axis coordinate value of the inspection location.
    • CoordinateY; number; The y-axis coordinate value of the inspection location.
    • Country; string; The country in which the inspection is required.
    • County; string; The county of the inspection location.
    • CreatedBy; string; The name of the user who created the inspection.
    • CreationDate; string; The date when the inspection was created.
    • Description; string; The description of the inspection.
    • DistanceUom; string; The unit of measure for the distance in miles or kilometers for the inspection site.
    • EstimatedDurationHrs; number; The estimated number of hours required to perform the inspection. This information can be used for planning and scheduling.
    • EstimatedTimeArrival; string; The estimated time of arrival of the inspector at the inspection location.
    • EstimatedTimeArrivalEnd; string; The latest estimated time of arrival at the inspection site.
    • FinalInspectionFlag; string; The option that indicates if the inspection type is final.
    • HideInspectorComment; string; The option to hide the comments entered by the inspector.
    • InspectionCompleteDttm; string; The date and time when the inspection was completed.
    • InspectionDistrictId; string; The unique identifier of the inspection location district.
    • InspectionId; string; The unique identifier of the inspection.
    • InspectionLocation; string; The descriptive location of the inspection.
    • InspectionName; string; The name of the inspection.
    • InspectionRating; string; The rating of the inspection based on the range of scores defined by the agency.
    • InspectionResult; string; The final result of the inspection. If scoring is used, the result appears after you complete the inspection checklists and submit the complete inspection with required signatures.
    • InspectionScore; integer; The final score of the inspection that is calculated based on the entries for the checklist items.
    • InspectionStatus; string; The name of the inspection status. The status name is used as the display status for the inspection in the permit application.
    • InspectionType; string; The unique identifier of the type of inspection.
    • InspectorId; integer; The unique identifier of the inspector.
    • InspectorInitials; string; The initials of the inspector.
    • InspectorName; string; The name of the inspector.
    • InspectorSignatureDttm; string; The date and time when the inspector signed.
    • LastUpdateDate; string; The date when the inspection was last updated.
    • LastUpdatedBy; string; The name of the user who last updated the inspection.
    • LnpRecordId; string; The identifier of the application record. The value is generated based on the auto number rule configured for the type of record.
    • LnpRecordKey; integer; The unique identifier of the record.
    • LocationLatitude; number; The latitude of the inspection location.
    • LocationLongitude; number; The longitude of the inspection location.
    • NumMajorViolations; integer; The total number of violations found in the inspection. A failing result for an inspection checklist item constitutes a major violation.
    • OwnerName; string; The name of the owner.
    • OwnerSignatureDttm; string; The date and time when the owner signed.
    • ParcelId; integer; The identifier of the parcel.
    • PhoneAreaCode; string; The area code of the phone number.
    • PhoneCountryCode; string; The country code of the phone number.
    • PhoneExtension; string; The extension of the phone number.
    • PhoneNumber; string; The phone number of the contact person.
    • PostalCode; string; The postal code of the inspection location.
    • PostalPlus4Code; string; The extended postal code of the inspection location.
    • PreferredContactMethod; string; The preferred mode of communication.
    • ProjectCode; string; The unique identifier of the project.
    • Province; string; The province of the inspection location.
    • ReadyByDttm; string; The date and time after which the inspection can be performed.
    • RecordId; string; The identifier of the application record. The value is generated based on the auto number rule configured for the type of record.
    • RecordKey; integer; The unique identifier of the record.
    • RecordType; string; The type of the record.
    • ReinspectionFlag; string; The option to indicate if this is a re-inspection.
    • RequestorComment; string; The comment entered by the inspection requestor.
    • ScheduledEndDttm; string; The date and time when the inspection is scheduled to end.
    • ScheduledStartDttm; string; The date and time when the inspection is scheduled to start.
    • Srid; integer; The SRID value of the inspection location. This Spatial Reference System Identifier (SRID) is a unique value that identifies the projected, not projected, and local spatial coordinate system definitions for the inspection location. These are commonly used in most GIS systems.
    • State; string; The state of the inspection location.
    • StatusTime; string; The date and time when the status was set.
    • SubmitDate; string; The date and time when the permit was submitted.
    • SystemResult; string; The result of the inspection as defined in the system.
    • SystemStatus; string; The system defined status for the inspection.
    • TravelFromActualDistance; number; The actual distance from the inspection site.
    • TravelFromEndOdometer; number; The odometer reading value when the inspector reaches the next location from the inspection site.
    • TravelFromStartOdometer; number; The odometer reading value when the inspector starts from the inspection site.
    • TravelToActualDistance; number; The actual distance to the inspection site.
    • TravelToEndOdometer; number; The odometer reading value when the inspector reaches the inspection site.
    • TravelToStartOdometer; number; The odometer reading value when the inspector starts to the inspection site.
  • 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 : publicSectorProjectRecordInspections
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorProjectRecordInspections-item-response
Type: object
Show Source
Back to Top