Update an IVR Inspection
patch
/fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections/{InspectionId}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
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.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorIVRInspections-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. -
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. -
BillableFlag(optional):
boolean
Title:
Billable Option
Indicates whether the inspection is billable. The value defaults from the inspection type associated with the inspection. -
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. -
ContractorSignatureDttm(optional):
string(date-time)
Title:
Signed
The date and time when the contractor signed the inspection. -
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:
Estimated Duration in Hours
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 the 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 the inspection was completed. -
InspectionDistrictId(optional):
string
Title:
District
Maximum Length:30
The unique identifier for the inspection district. -
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. -
InspectorSignatureDttm(optional):
string(date-time)
Title:
Signed
The date and time when the inspector signed the inspection. -
IvrAccessCode(optional):
string
The IVR password associated with the permit's applicant user profile, or the user profile of any of the permit's registered contacts.
-
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date the inspection was last updated. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Record ID
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. -
NoneResultItemCount(optional):
number
The number of checklist items for the inspection for which there is no inspection result.
-
NumberMajorViolations(optional):
integer(int32)
Title:
Major Violation
The calculated total number of major violations for the inspection. -
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.
-
PreferredDate(optional):
string(date-time)
Title:
Preferred Date
The preferred date for the inspection. -
PreferredTime(optional):
string
Title:
Preferred Time
Maximum Length:15
The preferred time for the inspection, for example Morning or Afternoon. -
ReadyByDttm(optional):
string(date-time)
Title:
Ready By
The date and time that the inspection site will be ready for the inspection to 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. -
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.
-
StreetNumber(optional):
string
Maximum Length:
20
The street number of the parcel address, or the first four characters of the parcel address. -
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 : 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.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorIVRInspections-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. -
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. -
BillableFlag(optional):
boolean
Title:
Billable Option
Indicates whether the inspection is billable. The value defaults from the inspection type associated with the inspection. -
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. -
ContractorSignatureDttm(optional):
string(date-time)
Title:
Signed
The date and time when the contractor signed the inspection. -
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:
Estimated Duration in Hours
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 the 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 the inspection was completed. -
InspectionDistrictId(optional):
string
Title:
District
Maximum Length:30
The unique identifier for the inspection district. -
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. -
InspectorSignatureDttm(optional):
string(date-time)
Title:
Signed
The date and time when the inspector signed the inspection. -
IvrAccessCode(optional):
string
The IVR password associated with the permit's applicant user profile, or the user profile of any of the permit's registered contacts.
-
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date the inspection was last updated. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Record ID
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. -
NoneResultItemCount(optional):
number
The number of checklist items for the inspection for which there is no inspection result.
-
NumberMajorViolations(optional):
integer(int32)
Title:
Major Violation
The calculated total number of major violations for the inspection. -
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.
-
PreferredDate(optional):
string(date-time)
Title:
Preferred Date
The preferred date for the inspection. -
PreferredTime(optional):
string
Title:
Preferred Time
Maximum Length:15
The preferred time for the inspection, for example Morning or Afternoon. -
ReadyByDttm(optional):
string(date-time)
Title:
Ready By
The date and time that the inspection site will be ready for the inspection to 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. -
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.
-
StreetNumber(optional):
string
Maximum Length:
20
The street number of the parcel address, or the first four characters of the parcel address. -
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 : 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.