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

Get all assigned or unassigned inspections

get

/fscmRestApi/resources/11.13.18.05/publicSectorUnasgnInspections

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 that matches the primary key criteria specified.
      Finder Variables:
      • AgencyId; integer; The unique identifier for the agency associated with the inspection.
      • InspectionKey; integer; The unique identifier for an inspection.
    • simpleSearchFinder: Finds inspections with the specified key criteria.
      Finder Variables:
      • value; string; The keyword used to find an inspection by inspection identifier, inspection type, record identifier, inspection district, address1, address2, or city.
  • 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:
    • Address1; string; The first line of the address on the inspection.
    • Address2; string; The second line of the address on the inspection.
    • Address3; string; The third line of the address on the inspection.
    • Address4; string; The fourth line of the address on the inspection.
    • AddressId; integer; The unique identifier of the record parcel address.
    • AgencyId; integer; The unique identifier of the agency associated with the inspection.
    • City; string; The city of the address on the inspection.
    • Country; string; The country of the address on the inspection.
    • County; string; The county of the address on the inspection.
    • Description; string; The description of the inspection, which comes from the inspection type.
    • EstimatedDurationHrs; number; The estimated duration of the inspection in hours.
    • InspectionCompleteDttm; string; The date and time at which the inspection was completed.
    • InspectionDistrict; string; The district on the inspection.
    • InspectionGroup; string; The inspection group associated with the permit.
    • InspectionId; string; The unique identifier of the inspection.
    • InspectionKey; integer; The unique identifier of the inspection.
    • InspectionResult; string; The result of the inspection as recorded by the inspector.
    • InspectionStatus; string; The status of the inspection.
    • InspectionType; string; The inspection type on the inspection.
    • InspectorId; integer; The unique identifier of the inspector assigned to the inspection.
    • InspectorName; string; The name of the assigned inspector.
    • LnpRecordId; string; The unique identifier of the application record.
    • LnpRecordKey; integer; The unique identifier of the record associated with the permit.
    • ParcelId; integer; The unique identifier of the record parcel.
    • PermitDescription; string; The description of the record associated with the inspection.
    • PostalCode; string; The postal code of the address on the inspection.
    • PreferredDate; string; The preferred date for the inspection to be performed.
    • PreferredInspectorName; string; The name of the preferred inspector.
    • PreferredTime; string; The preferred time for the inspection to be performed.
    • PriorInspectorName; string; The name of the inspector assigned to the prior inspection associated with this reinspection.
    • ReadyByDttm; string; The date and time after which the inspection can be performed.
    • ReinspectionIdBy; string; The unique identifier of the inspection that is the reinspection of this inspection.
    • ReinspectionIdOf; string; The unique identifier of the prior inspection associated with this reinspection.
    • ScheduledEndDttm; string; The date and time that the inspection is scheduled to end.
    • ScheduledStartDttm; string; The date and time that the inspection is scheduled to start.
    • SchedulingMethod; string; The method used for scheduling an inspection. The request method is used if a user submits a request for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.
    • State; string; The state code of the address on the inspection.
    • SystemResult; string; The code that represents the result of the inspection.
    • SystemStatus; string; The code that represents the status of the inspection.
  • 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 : publicSectorUnasgnInspections
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorUnasgnInspections-item-response
Type: object
Show Source
Back to Top