Get all inspections
get
/fscmRestApi/resources/11.13.18.05/publicSectorInspections
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
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).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
finder: string
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:- myInsFinder: Finds an inspection using the specified keyword. Finder Variables:
- PersonId; integer; The keyword used to find an inspection by matching with a person ID.
- simpleSearchFinder: Finds an inspection using the specified keyword. Finder Variables:
- value; string; The keyword used to find an inspection by matching with a description, inspection type, inspection status, record ID, and so on.
- PrimaryKey: Finds the inspection that matches the specified primary key criteria. Finder Variables:
- InspectionId; string; The unique identifier for the inspection.
- myInsFinder: Finds an inspection using the specified keyword. Finder Variables:
-
limit: integer
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.
-
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified attributes. 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
-
q: string
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 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorInspections
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorInspections-item
Type:
Show Source
object
-
ActlTravelTimeFromHrs(optional):
number
Title:
Travel Time from Site
The travel time from the inspection site in hours. -
ActlTravelTimeToHrs(optional):
number
Title:
Travel Time to Site
The travel time to the inspection site in hours. -
ActualDurationHrs(optional):
number
Title:
Duration in Hours
The actual duration of the inspection in hours. -
ActualEndDttm(optional):
string(date-time)
Title:
End Date
The actual end date of the inspection. -
ActualStartDttm(optional):
string(date-time)
Title:
Start Date
The actual start date of the inspection. -
Address1(optional):
string
Title:
Address Line 1
Maximum Length:240
The first or main address. -
Address2(optional):
string
Title:
Address Line 2
Maximum Length:240
The second address, if present. -
Address3(optional):
string
Title:
Address Line 3
Maximum Length:240
The third address, if present. -
Address4(optional):
string
Title:
Address Line 4
Maximum Length:240
The fourth address, if present. -
AddressId(optional):
integer(int64)
The unique identifier of the record parcel address.
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for the public sector agency associated with the inspection. -
ApplicantBizProfileId(optional):
integer(int64)
Title:
Business Profile
The unique identifier of the applicant business profile when the applicant is a business entity. -
ApplicantProfileId(optional):
integer(int64)
Title:
Applicant Profile
The unique identifier of the applicant user profile. -
BillableFlag(optional):
boolean
Title:
Billable Option
A yes or no indicator that identifies whether the inspection is billable or not. -
BillType(optional):
string
Title:
Billable Type
Maximum Length:15
The bill type that determines the invoice type generated for this inspection. -
CancellationReason(optional):
string
Title:
Cancellation Reason
Maximum Length:150
The reason for canceling the inspection. -
City(optional):
string
Title:
City
Maximum Length:60
The city of the inspection. -
ContactEmail(optional):
string
Title:
Email
Maximum Length:320
The inspection location contact's email address. -
ContactName(optional):
string
Title:
Location Contact
Maximum Length:450
The name of contact person for the inspection. -
ContactPhoneText(optional):
string
Maximum Length:
255
The contact's phone number for text. -
ContractorName(optional):
string
Title:
Contractor
Maximum Length:360
The contractor's name. -
ContractorSignature(optional):
string(binary)
The contractor's signature.
-
ContractorSignatureDttm(optional):
string(date-time)
Title:
Signed
The date and time when the contractor signed the inspection. -
CoordinateX(optional):
number
Title:
Coordinate X
The X coordinate of the inspection location. -
CoordinateY(optional):
number
Title:
Coordinate Y
The Y coordinate of inspection location. -
Country(optional):
string
Title:
Country
Maximum Length:3
The county of the inspection. -
County(optional):
string
Title:
County
Maximum Length:60
The county in the inspection address. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the record. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the record was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the inspection transaction. -
DistanceUOM(optional):
string
Title:
Units
Maximum Length:5
The distance unit of measure. The prompt is the common units table. -
EstimatedDurationHrs(optional):
number
Title:
Duration
The estimated duration of the inspection in hours. -
EstimatedTimeArrival(optional):
string(date-time)
Title:
ETA From
The estimated time of arrival at the inspection site. -
EstimatedTimeArrivalEnd(optional):
string(date-time)
Title:
ETA To
The estimated end time of arrival at the inspection site. -
FinalInspectionFlag(optional):
boolean
Indicates whether this is the final inspection. The default is no.
-
HideInspectorComment(optional):
string
Title:
Hide Inspector Comment
Maximum Length:1
Indicates whether inspector's comments are hidden from public users. This value defaults from the inspection type. -
InspectionCompleteDttm(optional):
string(date-time)
Title:
Completion Date
The date and time when inspection was completed. -
InspectionDistrictId(optional):
string
Title:
District
Maximum Length:30
The inspection district ID. -
InspectionId(optional):
string
Title:
Inspection
Maximum Length:50
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. -
InspectionLocation(optional):
string
Title:
Inspection Location
Maximum Length:100
An optional descriptive name of the inspection location, such as Bank of America Building or corner lot. -
InspectionName(optional):
string
Maximum Length:
100
The description of the inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection. -
InspectionRating(optional):
string
Title:
Rating
Maximum Length:5
The calculated rating based on the rating method. -
InspectionResult(optional):
string
Title:
Result
Maximum Length:15
The result of inspection, such as Pass, Fail, Yes, and No. -
InspectionScore(optional):
integer(int32)
Title:
Score
The calculated total inspection score. -
InspectionStatus(optional):
string
Title:
Status
Maximum Length:15
The status of the inspection. -
InspectionType(optional):
string
Title:
Inspection Type
Maximum Length:15
The type of the inspection, such as Electrical. -
InspectorId(optional):
integer(int64)
Title:
Inspector ID
The ID of the inspector assigned to the inspection. -
InspectorInitials(optional):
string
Title:
Initials
Maximum Length:6
The initials of the inspector. -
InspectorName(optional):
string
Title:
Inspector
Maximum Length:360
The name of the user who is assigned to the inspection. -
InspectorSignature(optional):
string(binary)
The inspector's signature.
-
InspectorSignatureDttm(optional):
string(date-time)
Title:
Signed
The date and time when the inspector signed the inspection. -
InsuranceRelatedInspectionView(optional):
array Permits Related Inspections
Title:
Permits Related Inspections
The inspections resource is used to capture all permit inspections and display the inspection information to the user, including inspection type, inspection ID, scheduling time, the user who created the inspection, and so on. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the record was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Permit
Maximum Length:50
The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey(optional):
integer(int64)
Title:
Record
The unique identifier for a record. -
LocationLatitude(optional):
number
Title:
Latitude
The latitude coordinate of the inspection location. -
LocationLongitude(optional):
number
Title:
Longitude
The longitude coordinate of the inspection location. -
NoneResultItemCount(optional):
number
The number of inspection checklist items which have no result.
-
NumberMajorViolations(optional):
integer(int32)
Title:
Major Violation
The calculated total number of major violations for the inspection. -
OwnerName(optional):
string
Title:
Owner
Maximum Length:360
The owner's name. -
OwnerSignature(optional):
string(binary)
The site owner's signature.
-
OwnerSignatureDttm(optional):
string(date-time)
Title:
Signed On
The date and time when the owner signed the inspection. -
ParcelId(optional):
integer(int64)
The unique identifier of the record parcel.
-
PhoneAreaCode(optional):
string
Maximum Length:
10
The contact's phone area code. -
PhoneCountryCode(optional):
string
Maximum Length:
10
The contact's international country code for the phone number. -
PhoneExtension(optional):
string
Maximum Length:
20
The contact's additional phone number extension. -
PhoneNumber(optional):
string
Title:
Phone
Maximum Length:40
The contact's phone number. -
PostalCode(optional):
string
Title:
Postal Code
Maximum Length:60
The postal code in the inspection address. -
PostalPlus4Code(optional):
string
Title:
Postal Code
Maximum Length:10
The extended postal code in the inspection address. -
PreferredContactMethod(optional):
string
Title:
Contact Method
Maximum Length:30
The inspection location contact's preferred contact method. -
PreferredDate(optional):
string(date-time)
Title:
Preferred Date
The preferred date for the inspection to be performed. -
PreferredTime(optional):
string
Title:
Preferred Time
Maximum Length:15
The preferred time for the inspection to be performed. -
Province(optional):
string
Title:
Province
Maximum Length:60
The province in the inspection address. -
ReadyByDttm(optional):
string(date-time)
Title:
Ready By
The date and time after which the inspection can be performed. -
RecordType(optional):
string
Title:
Permit Type
Maximum Length:100
The user-friendly name for the permit type. -
ReinspectionFlag(optional):
boolean
Indicates whether this is a reinspection. The default is no.
-
RequestedDate(optional):
string
Title:
Ready by Date
Maximum Length:255
The date when the inspection was requested. -
RequestedTime(optional):
string
Title:
Ready by Time
Maximum Length:255
The time when the inspection was requested. -
RequestorComment(optional):
string
Title:
Comments
Maximum Length:500
The inspection requester's comments. -
ScheduledEndDttm(optional):
string(date-time)
Title:
Schedule End Date
The scheduled inspection end date. -
ScheduledStartDate(optional):
string
Title:
Date
Maximum Length:255
The date when the inspection was scheduled. -
ScheduledStartDttm(optional):
string(date-time)
Title:
Schedule Start Date
The scheduled inspection start date. -
ScheduledStartTime(optional):
string
Title:
Time
Maximum Length:255
The time when the inspection was scheduled. -
Srid(optional):
integer(int64)
The spatial reference ID (SRID) of the inspection location.
-
State(optional):
string
Title:
State
Maximum Length:60
The state in the inspection address. -
StatusTime(optional):
string(date-time)
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.
-
SystemResult(optional):
string
Maximum Length:
20
The unique alphanumeric code or short name for the inspection result. -
SystemStatus(optional):
string
Maximum Length:
15
The unique alphanumeric code or short name for the inspection status. -
TravelFromActualDistance(optional):
number
The total distance traveled from the inspection site.
-
TravelFromEndOdometer(optional):
number
The odometer reading upon arrival at the next location.
-
TravelFromStartOdometer(optional):
number
The odometer reading before travel from the inspection site.
-
TravelToActualDistance(optional):
number
The total distance traveled to the inspection site.
-
TravelToEndOdometer(optional):
number
The odometer reading upon arrival at the site.
-
TravelToStartOdometer(optional):
number
The odometer reading before travel to the inspection site.
Nested Schema : Permits Related Inspections
Type:
array
Title:
Permits Related Inspections
The inspections resource is used to capture all permit inspections and display the inspection information to the user, including inspection type, inspection ID, scheduling time, the user who created the inspection, and so on.
Show Source
Nested Schema : publicSectorInspections-InsuranceRelatedInspectionView-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The unique identifier for the public sector agency associated with the related inspection.
-
InspectionId(optional):
string
Maximum Length:
50
The unique identifier for an inspection. -
links(optional):
array Items
Title:
Items
Link Relations -
RelatedInspectionId(optional):
string
Maximum Length:
50
The unique identifier for a related inspection. -
RelationshipType(optional):
string
Maximum Length:
15
The static list of values (LOV) identifying how two inspections are related, such as an inspection and a reinspection.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.