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

Get all inspection worklists

get

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionWorklists

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 inspection worklist that matches the specified primary key criteria.
      Finder Variables:
      • InspectionKey; integer; The unique identifier for the inspection.
    • simpleSearchFinder: Finds an inspection worklist using the specified keyword.
      Finder Variables:
      • value; string; The keyword used to find an inspection worklist by matching with a description, inspection type, inspection status, record ID, and so on.
  • 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:
    • ActivityDescription; string; The user-friendly description of the business license type for which options are set, such as origination, amendment, or renewal.
    • 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 or main address.
    • Address2; string; The second address, if present.
    • Address3; string; The third address, if present.
    • Address4; string; The fourth address, if present.
    • AddressId; integer; The unique identifier of the record parcel address.
    • AgencyId; integer; The identifier for the public sector agency associated with the inspection.
    • 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.
    • AssessFeeFlag; string; Indicates whether fees should be assessed for the inspection.
    • AssignmentMethod; string; Indicates the assignment method specified in the agency options for each inspection scheduling method. Values include Date Only, Specific Time, and Time Range.
    • BillType; string; The bill type that determines the invoice type generated for this inspection.
    • BillableFlag; string; A yes or no indicator that identifies whether the inspection is billable or not.
    • BusDbaBusinessName; string; The doing business as (DBA) name for a business entity.
    • CancellationReason; string; The reason for canceling the inspection.
    • ChgSchedulePolicyHrs; integer; The number of hours prior to the scheduled inspection time that a user can cancel or reschedule an inspection.
    • City; string; The city of the inspection.
    • Classification; string; The classification of the application record.
    • ClassificationDescription; string; The user-friendly description of the classification of the application record.
    • ContactEmail; string; The inspection location contact???s email address.
    • ContactName; string; The name of contact person for the inspection.
    • ContractorName; string; The contractor???s name.
    • ContractorSignatureDttm; string; The date and time when the contractor signed the inspection.
    • CoordinateX; number; The X coordinate of the inspection location.
    • CoordinateY; number; The Y coordinate of inspection location.
    • Country; string; The country of the inspection.
    • County; string; The county in the inspection address.
    • 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.
    • ExpirationDate; string; The date when the application associated with the inspection expires.
    • FinalInspectionFlag; string; Indicates whether this is the final inspection. The default is no.
    • HideInspectorComment; string; Indicates whether inspector's comments are hidden from public users. This value defaults from the inspection type.
    • InspectionCompleteDttm; string; The date and time when inspection was completed.
    • InspectionDistrictId; string; The inspection district ID.
    • InspectionGroup; string; The group of inspections if multiple inspections are required for the record type.
    • 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 key for an inspection record.
    • 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.
    • InspectionPuid; string; The public unique identifier for an inspection. Used to import data.
    • InspectionRating; string; The calculated rating based on the rating method.
    • InspectionResult; string; The result of inspection, such as Pass, Fail, Yes, and No.
    • 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.
    • InspectorId; integer; The ID of the inspector assigned to the inspection.
    • InspectorInitials; string; The initials of the inspector.
    • InspectorName; string; The name of the user who is assigned to the inspection.
    • InspectorSignatureDttm; string; The date and time when the inspector signed the inspection.
    • 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.
    • LocationLatitude; number; The latitude coordinate of the inspection location.
    • LocationLongitude; number; The longitude coordinate of the inspection location.
    • NoneResultItemCount; number; The number of inspection checklist items which have no result.
    • NumMajorViolations; integer; The calculated total number of major violations for the inspection.
    • OwnerName; string; The owner???s name.
    • OwnerSignatureDttm; string; The date and time when the owner signed the inspection.
    • ParcelId; integer; The unique identifier of the record parcel.
    • PermitDescription; string; The description of the permit associated with the inspection.
    • PermitStatus; string; The status of the permit associated with the inspection.
    • PermitSystemStatus; string; The unique alphanumeric code or short name for the record status.
    • PermitType; string; The type of permit associated with the inspection.
    • 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 to be performed.
    • PreferredInspectorId; integer; The unique identifier for the reinspection preferred inspector.
    • PreferredTime; string; The preferred time for the inspection to be performed.
    • Province; string; The province in the inspection address.
    • ReadyByDttm; string; The date and time after which the inspection can be performed.
    • RecordNumber; string; The public unique identifier for a permit. Used to import data.
    • RecordType; string; The user-friendly name for the permit type.
    • ReinspectionFlag; string; Indicates whether this is a reinspection. The default is no.
    • ReinspectionIdBy; string; The unique identifier for the reinspection.
    • ReinspectionIdOf; string; The unique identifier of the failed inspection that requires a reinspection.
    • RequestorComment; string; The inspection requester's comments.
    • RequiredFlag; string; Indicates whether the inspection is required. Defaults from the inspection group, but if not available, the default is no for not required.
    • ScheduledEndDttm; string; The scheduled inspection end date.
    • ScheduledStartDttm; string; The scheduled inspection start date.
    • SchedulingMethod; string; The method used for scheduling an inspection. The request method is used if a user submits a preferred date and preferred time for an inspection to be scheduled. The ready method is used if a user submits a ready by date and a ready by time for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.
    • Srid; integer; The spatial reference ID (SRID) of the inspection location.
    • 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.
    • StreetDirection; string; The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center.
    • StreetName; string; The street number in the parcel address.
    • StreetNameConcat; string; Indicates the concatenated value of the street name corresponding to the parcel address. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix, and direction suffix.
    • StreetNumber; string; The street name in the parcel address used during a search.
    • StreetNumberAlpha; string; The street number in the parcel address used for sort when the content is alphanumeric.
    • StreetNumberNumeric; number; The street number in the parcel address used for sort when the content is numeric.
    • StreetSuffix; string; The street suffix that further describes that street. For example, Drive, Avenue, and so on.
    • StreetType; string; The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
    • Subclassification; string; The subclassification for the record type, which indicates that the preapplication 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.
    • TextAreaCode; string; The contact's mobile phone area code.
    • TextCountryCode; string; The contact's international country code for the mobile phone number.
    • TextNumber; string; The contact???s mobile phone number.
    • 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.
    • UnitNumber; string; The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
    • VersionType; string; The activity code for business license type for which options are set.
  • 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 : publicSectorInspectionWorklists
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorInspectionWorklists-item-response
Type: object
Show Source
Nested Schema : Shape
Type: object
Read Only: true
The shape of the inspection location.
Back to Top