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

Get all inspection communication items

get

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCommunications

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 inspection communication item using the specified inspection identifiers.
      Finder Variables:
      • InspectionId; string; The unique identifier for an inspection.
      • LnpRecordKey; integer; The unique identifier for a record.
  • 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:
    • AgencyUser; string; Indicates whether the inspection was last modified by an agency user.
    • Applicant; integer; The party ID of the person applying for the application.
    • ApplicantEmailAddress1; string; The permit applicant email address.
    • ApplicantEmailAddress2; string; The permit applicant additional email address.
    • ApplicantLoginId; string; The permit applicant login ID.
    • ApplicantPersonName; string; The permit applicant name.
    • ApplicantPersonNameSuffix; string; The suffix to the permit applicant name.
    • ApplicantPhoneAreaCode; string; The area code for the permit applicant phone number.
    • ApplicantPhoneCountryCode; string; The country code for the permit applicant phone number.
    • ApplicantPhoneExtension; string; The permit applicant phone number extension.
    • ApplicantPhoneNumber; string; The permit applicant phone number.
    • ApplicantUserId; string; The permit applicant user ID.
    • AssessFee; string; Indicates whether fees should be assessed for the inspection.
    • ContactEmail; string; The email of the contact at the inspection site.
    • ContactName; string; The name of the contact at the inspection site.
    • ContactTextMessage; string; The mobile phone number of the contact at the inspection site.
    • EstimatedTimeArrival; string; The earliest estimated time of arrival at the building inspection site.
    • EstimatedTimeArrivalEnd; string; The latest estimated time of arrival at the building inspection site.
    • FeeBalanceDue; number; The fee balance due for the permit.
    • FinalInspection; string; Indicates whether this is the final inspection. The default is no.
    • HideFromUserFlag; string; Indicates whether the inspection will be displayed to a nonagency user prior to completion. The default value is false, which indicates the inspection is always displayed to nonagency users.
    • InspectionAddress1; string; The first address line of the building inspection site.
    • InspectionAddress2; string; The second address line of the building inspection site.
    • InspectionCity; string; The city in the address of the building inspection site.
    • InspectionCompleteDttm; string; The date and time when the inspection was completed.
    • InspectionCountry; string; The country in the address of the building inspection site.
    • InspectionCounty; string; The county in the address of the building inspection site.
    • InspectionId; string; The unique identifier for an inspection.
    • InspectionLocation; string; The location where the inspection will take place.
    • InspectionPostalCode; string; The postal code in the address of the building inspection site.
    • InspectionProvince; string; The province in the address of the building inspection site.
    • InspectionRating; string; The overall rating of the inspection, which is calculated based on a defined rating method.
    • InspectionResult; string; The results of the inspection. For example, Pass, Fail, Yes, or No.
    • InspectionResultDescr; string; The inspection result description of the inspection record.
    • InspectionScore; integer; The calculated total score of the inspection.
    • InspectionState; string; The state in the address of the building inspection site.
    • InspectionStatus; string; The inspection status description.
    • InspectionSupervisorDisplayNames; string; The display name of inspection supervisors as seen within the permitting and licensing application.
    • InspectionSupervisorEmails; string; The email addresses for inspection supervisors for which an in-product notification communication can be sent.
    • InspectionSupervisorUsernames; string; The user login ID for inspection supervisors for which an in-product notification communication can be sent.
    • InspectionType; string; The description of the inspection type.
    • InspectionUpdateDate; string; The date when the record was last updated.
    • InspectorArrival; string; The time when the inspector is expected to arrive for an inspection. The value can be displayed as Date Only, Specific Time, or Time Range, as specified in the agency options.
    • InspectorEmail; string; The building inspector email address.
    • InspectorId; integer; The inspector assigned to the inspection.
    • InspectorLoginId; string; The building inspector login ID.
    • InspectorName; string; The name of the inspector.
    • InspectorPhone; string; The building inspector phone number.
    • InspectorUserId; string; The building inspector user ID.
    • LnpRecordId; string; The building permit record identifier. For example, a permit ID with a value of Building Permit ID RA-2017-00029.
    • LnpRecordKey; integer; The unique identifier for a permit record.
    • NumberMajorViolations; integer; The total number of major violations for the inspection.
    • Owner; string; The primary or only owner of the parcel or property.
    • OwnerEmailId; string; The parcel owner email address.
    • ParcelId; integer; The identifier of the record parcel.
    • PermitStatus; string; The status of the permit record.
    • PermitStatusDescription; string; The status description of the permit record.
    • PermitSystemStatus; string; The status code of the permit record.
    • RecordType; string; The type of permit on the inspection schedule page, such as a residential addition.
    • RecordTypeId; string; The unique alphanumeric code or short name for the record type.
    • ScheduledEndDttm; string; The scheduled inspection end date.
    • ScheduledStartDttm; string; The scheduled inspection start date.
    • ScheduledTimeRange; string; The Inspection scheduled time range based on the defined setup of the permit type.
    • SecondaryOwner; string; The secondary owner of the parcel or property.
    • SystemResult; string; The unique alphanumeric code or short name for the inspection result.
    • Url; string; The inspection URL used within a communications template.
    • UrlLabel; string; The label displayed for an inspection URL used within a communications template.
    • WorkflowAssignedDate; string; The date when the workflow task was assigned.
    • WorkflowDueDate; string; The workflow task due date.
    • WorkflowTaskId; string; The workflow task ID.
    • WorkflowTaskName; string; The workflow task name.
  • 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 : publicSectorInspectionCommunications
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorInspectionCommunications-item-response
Type: object
Show Source
Back to Top