Create an IVR inspection
post
/fscmRestApi/resources/11.13.18.05/publicSectorIVRInspections
Request
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActlTravelTimeFromHrs: number
Title:
Travel Time from Site
The travel time from the inspection site in hours. -
ActlTravelTimeToHrs: number
Title:
Travel Time to Site
The travel time to the inspection site in hours. -
ActualDurationHrs: number
Title:
Duration in Hours
The actual duration of the inspection in hours. -
ActualEndDttm: string
(date-time)
Title:
End Date
The actual end date of the inspection. -
ActualStartDttm: string
(date-time)
Title:
Start Date
The actual start date of the inspection. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the inspection address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the inspection address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the inspection address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the inspection address. -
AddressId: integer
(int64)
The unique identifier of the record parcel address.
-
AgencyId: integer
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with the inspection. -
CancellationReason: string
Title:
Cancellation Reason
Maximum Length:150
The reason for canceling the inspection. -
City: string
Title:
City
Maximum Length:60
The city of the inspection address. -
ContactEmail: string
Title:
Email
Maximum Length:320
The inspection location contact???s email address. -
ContactName: string
Title:
Location Contact
Maximum Length:450
The name of the contact person for the inspection. -
ContractorSignatureDttm: string
(date-time)
Title:
Signed
The date and time when the contractor signed the inspection. -
Country: string
Title:
Country
Maximum Length:3
The country of the inspection address. -
County: string
Title:
County
Maximum Length:60
The county in the inspection address. -
DistanceUOM: string
Title:
Units
Maximum Length:5
The distance unit of measure. The prompt is the common units table. -
EstimatedDurationHrs: number
Title:
Estimated Duration in Hours
The estimated duration of the inspection in hours. -
EstimatedTimeArrival: string
(date-time)
Title:
ETA From
The estimated time of arrival at the inspection site. -
EstimatedTimeArrivalEnd: string
(date-time)
Title:
ETA To
The estimated end time of arrival at the inspection site. -
InspectionCompleteDttm: string
(date-time)
Title:
Completion Date
The date and time when the inspection was completed. -
InspectionId: 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. -
InspectionKey: integer
(int64)
The unique identifier of an inspection.
-
InspectionLocation: 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: string
Maximum Length:
100
The description of the inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection. -
InspectionRating: string
Title:
Rating
Maximum Length:5
The calculated rating based on the rating method. -
InspectionResult: string
Title:
Result
Maximum Length:25
The result of an inspection, such as Pass, Fail, Yes, and No. This is informational only. You can't assign a result to an inspection through IVR. -
InspectionScore: integer
(int32)
Title:
Score
The calculated total inspection score. -
InspectionSource: string
Maximum Length:
30
The source from which the inspection was created. -
InspectionStatus: string
Title:
Status
Maximum Length:15
The status of the inspection. -
InspectionType: string
Title:
Inspection Type
Maximum Length:15
The type of the inspection, such as Electrical. -
InspectionUpdateSource: string
The source from which the inspection was updated.
-
InspectorSignatureDttm: string
(date-time)
Title:
Signed
The date and time when the inspector signed the inspection. -
IvrAccessCode: string
The IVR password associated with the record's applicant user profile, or the user profile of any of the record's registered contacts.
-
LnpRecordId: string
Title:
Record ID
Maximum Length:50
A unique identifier for a record. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey: integer
(int64)
Title:
Record
The unique identifier for an application record. The record is for permits, business licenses, or planning and zoning, and is determined by the classification. -
LocationLatitude: number
Title:
Latitude
The latitude coordinate of the inspection location. -
LocationLongitude: number
Title:
Longitude
The longitude coordinate of the inspection location. -
NumberMajorViolations: integer
(int32)
Title:
Major Violation
The calculated total number of major violations for the inspection. -
OwnerSignatureDttm: string
(date-time)
Title:
Signed On
The date and time when the owner signed the inspection. -
ParcelId: integer
(int64)
The unique identifier of the record parcel.
-
PhoneAreaCode: string
Maximum Length:
10
The contact's phone area code. -
PhoneCountryCode: string
Maximum Length:
10
The contact's international country code for the phone number. -
PhoneExtension: string
Maximum Length:
20
The contact's additional phone number extension. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
The contact???s phone number. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code in the inspection address. -
PostalPlus4Code: string
Title:
Postal Code
Maximum Length:10
The extended postal code in the inspection address. -
PreferredContactMethod: string
Title:
Contact Methods
Maximum Length:30
The inspection location contact???s preferred contact method. -
PreferredDate: string
(date-time)
Title:
Preferred Date
The preferred date for the inspection. -
PreferredTime: string
Title:
Preferred Time
Maximum Length:15
The preferred time for the inspection, for example Morning or Afternoon. -
Province: string
Title:
Province
Maximum Length:60
The province in the inspection address. -
ReadyByDttm: string
(date-time)
Title:
Ready By
The date and time that the inspection site will be ready for the inspection to be performed. -
ReinspectionFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether this is a reinspection. The default is no. -
RequestedDate: string
Title:
Ready-by Date
Maximum Length:255
The date when the inspection was requested. -
RequestedTime: string
Title:
Ready-by Time
Maximum Length:255
The time when the inspection was requested. -
RequestorComment: string
Title:
Comments
Maximum Length:500
The inspection requester's comments. -
ScheduledEndDttm: string
(date-time)
Title:
Schedule End Date
The scheduled inspection end date. -
ScheduledStartDate: string
Title:
Date
Maximum Length:255
The date when the inspection was scheduled. -
ScheduledStartDttm: string
(date-time)
Title:
Schedule Start Date
The scheduled inspection start date. -
ScheduledStartTime: string
Title:
Time
Maximum Length:255
The time when the inspection was scheduled. -
State: string
Title:
State
Maximum Length:60
The state in the inspection address. -
SystemResult: string
Maximum Length:
20
The unique alphanumeric code or short name for the inspection result. -
SystemStatus: string
Maximum Length:
15
The unique alphanumeric code or short name for the inspection status. -
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
Root Schema : publicSectorIVRInspections-item-response
Type:
Show Source
object
-
ActlTravelTimeFromHrs: number
Title:
Travel Time from Site
The travel time from the inspection site in hours. -
ActlTravelTimeToHrs: number
Title:
Travel Time to Site
The travel time to the inspection site in hours. -
ActualDurationHrs: number
Title:
Duration in Hours
The actual duration of the inspection in hours. -
ActualEndDttm: string
(date-time)
Title:
End Date
The actual end date of the inspection. -
ActualStartDttm: string
(date-time)
Title:
Start Date
The actual start date of the inspection. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the inspection address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the inspection address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the inspection address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the inspection address. -
AddressId: integer
(int64)
The unique identifier of the record parcel address.
-
AgencyId: integer
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with the inspection. -
BillableFlag: boolean
Title:
Billable Option
Read Only:true
Maximum Length:1
Indicates whether the inspection is billable. The value defaults from the inspection type associated with the inspection. -
BillType: string
Title:
Billable Type
Read Only:true
Maximum Length:15
The bill type that determines the invoice type generated for this inspection. -
CancellationReason: string
Title:
Cancellation Reason
Maximum Length:150
The reason for canceling the inspection. -
City: string
Title:
City
Maximum Length:60
The city of the inspection address. -
Classification: string
Read Only:
true
Maximum Length:3
The classification of the record. -
ContactEmail: string
Title:
Email
Maximum Length:320
The inspection location contact???s email address. -
ContactName: string
Title:
Location Contact
Maximum Length:450
The name of the contact person for the inspection. -
ContractorSignatureDttm: string
(date-time)
Title:
Signed
The date and time when the contractor signed the inspection. -
Country: string
Title:
Country
Maximum Length:3
The country of the inspection address. -
County: string
Title:
County
Maximum Length:60
The county in the inspection address. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:100
The description of the inspection transaction. -
DistanceUOM: string
Title:
Units
Maximum Length:5
The distance unit of measure. The prompt is the common units table. -
EstimatedDurationHrs: number
Title:
Estimated Duration in Hours
The estimated duration of the inspection in hours. -
EstimatedTimeArrival: string
(date-time)
Title:
ETA From
The estimated time of arrival at the inspection site. -
EstimatedTimeArrivalEnd: string
(date-time)
Title:
ETA To
The estimated end time of arrival at the inspection site. -
FinalInspectionFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether this is the final inspection. The default is no. -
HideInspectorComment: string
Title:
Hide Inspector Comment
Read Only:true
Maximum Length:1
Indicates whether the inspector's comments are hidden from public users. This value defaults from the inspection type. -
InspectionCompleteDttm: string
(date-time)
Title:
Completion Date
The date and time when the inspection was completed. -
InspectionDistrictId: string
Title:
District
Read Only:true
Maximum Length:30
The unique identifier for the inspection district. -
InspectionId: 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. -
InspectionKey: integer
(int64)
The unique identifier of an inspection.
-
InspectionLocation: 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: string
Maximum Length:
100
The description of the inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection. -
InspectionRating: string
Title:
Rating
Maximum Length:5
The calculated rating based on the rating method. -
InspectionResult: string
Title:
Result
Maximum Length:25
The result of an inspection, such as Pass, Fail, Yes, and No. This is informational only. You can't assign a result to an inspection through IVR. -
InspectionScore: integer
(int32)
Title:
Score
The calculated total inspection score. -
InspectionSource: string
Maximum Length:
30
The source from which the inspection was created. -
InspectionStatus: string
Title:
Status
Maximum Length:15
The status of the inspection. -
InspectionType: string
Title:
Inspection Type
Maximum Length:15
The type of the inspection, such as Electrical. -
InspectionUpdateSource: string
The source from which the inspection was updated.
-
InspectorSignatureDttm: string
(date-time)
Title:
Signed
The date and time when the inspector signed the inspection. -
IvrAccessCode: string
The IVR password associated with the record's applicant user profile, or the user profile of any of the record's registered contacts.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the inspection was last updated. -
LicensePeriod: string
Read Only:
true
Maximum Length:100
The reporting period that applies to the business license. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
A unique identifier for a record. This identifier is automatically generated based on the rules configured for the record type. -
LnpRecordKey: integer
(int64)
Title:
Record
The unique identifier for an application record. The record is for permits, business licenses, or planning and zoning, and is determined by the classification. -
LocationLatitude: number
Title:
Latitude
The latitude coordinate of the inspection location. -
LocationLongitude: number
Title:
Longitude
The longitude coordinate of the inspection location. -
NoneResultItemCount: number
Read Only:
true
The number of checklist items for the inspection for which there is no inspection result. -
NumberMajorViolations: integer
(int32)
Title:
Major Violation
The calculated total number of major violations for the inspection. -
OwnerSignatureDttm: string
(date-time)
Title:
Signed On
The date and time when the owner signed the inspection. -
ParcelId: integer
(int64)
The unique identifier of the record parcel.
-
PhoneAreaCode: string
Maximum Length:
10
The contact's phone area code. -
PhoneCountryCode: string
Maximum Length:
10
The contact's international country code for the phone number. -
PhoneExtension: string
Maximum Length:
20
The contact's additional phone number extension. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
The contact???s phone number. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code in the inspection address. -
PostalPlus4Code: string
Title:
Postal Code
Maximum Length:10
The extended postal code in the inspection address. -
PreferredContactMethod: string
Title:
Contact Methods
Maximum Length:30
The inspection location contact???s preferred contact method. -
PreferredDate: string
(date-time)
Title:
Preferred Date
The preferred date for the inspection. -
PreferredTime: string
Title:
Preferred Time
Maximum Length:15
The preferred time for the inspection, for example Morning or Afternoon. -
Province: string
Title:
Province
Maximum Length:60
The province in the inspection address. -
ReadyByDttm: string
(date-time)
Title:
Ready By
The date and time that the inspection site will be ready for the inspection to be performed. -
RecordType: string
Title:
Permit Type
Read Only:true
Maximum Length:100
The user-friendly name for the record type. -
ReinspectionFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether this is a reinspection. The default is no. -
RequestedDate: string
Title:
Ready-by Date
Maximum Length:255
The date when the inspection was requested. -
RequestedTime: string
Title:
Ready-by Time
Maximum Length:255
The time when the inspection was requested. -
RequestorComment: string
Title:
Comments
Maximum Length:500
The inspection requester's comments. -
ScheduledEndDttm: string
(date-time)
Title:
Schedule End Date
The scheduled inspection end date. -
ScheduledStartDate: string
Title:
Date
Maximum Length:255
The date when the inspection was scheduled. -
ScheduledStartDttm: string
(date-time)
Title:
Schedule Start Date
The scheduled inspection start date. -
ScheduledStartTime: string
Title:
Time
Maximum Length:255
The time when the inspection was scheduled. -
State: string
Title:
State
Maximum Length:60
The state in the inspection address. -
StatusTime: string
(date-time)
Read Only:
true
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: string
Read Only:
true
Maximum Length:20
The street number of the parcel address, or the first four characters of the parcel address. -
Subclassification: string
Read Only:
true
Maximum Length:10
The subclassification for the record type, which indicates that the pre-application process is included in addition to the hearing process. -
SystemResult: string
Maximum Length:
20
The unique alphanumeric code or short name for the inspection result. -
SystemStatus: string
Maximum Length:
15
The unique alphanumeric code or short name for the inspection status. -
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.
-
VersionType: string
Read Only:
true
Maximum Length:1
The activity for business license type for which options are set, such as origination, amendment, or renewal.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.