Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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: Preferred Contact Method

  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.

{
    "type":"object",
    "properties":{
        "InspectionType":{
            "title":"Inspection Type",
            "maxLength":"15",
            "type":"string",
            "description":"The type of the inspection, such as Electrical.",
            "nullable":false
        },
        "DistanceUOM":{
            "title":"Units",
            "maxLength":"5",
            "type":"string",
            "description":"The distance unit of measure. The prompt is the common units table.",
            "nullable":true
        },
        "ScheduledEndDttm":{
            "title":"Schedule End Date",
            "type":"string",
            "description":"The scheduled inspection end date.",
            "format":"date-time",
            "nullable":true
        },
        "TravelToActualDistance":{
            "type":"number",
            "description":"The total distance traveled to the inspection site.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        },
        "LocationLatitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude coordinate of the inspection location.",
            "nullable":true
        },
        "ActualEndDttm":{
            "title":"End Date",
            "type":"string",
            "description":"The actual end date of the inspection.",
            "format":"date-time",
            "nullable":true
        },
        "SystemResult":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the inspection result.",
            "nullable":true
        },
        "TravelFromStartOdometer":{
            "type":"number",
            "description":"The odometer reading before travel from the inspection site.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        },
        "RequestorComment":{
            "title":"Comments",
            "maxLength":"500",
            "type":"string",
            "description":"The inspection requester's comments.",
            "nullable":true
        },
        "ScheduledStartDate":{
            "title":"Date",
            "maxLength":"255",
            "type":"string",
            "description":"The date when the inspection was scheduled.",
            "nullable":true
        },
        "PreferredTime":{
            "title":"Preferred Time",
            "maxLength":"15",
            "type":"string",
            "description":"The preferred time for the inspection, for example Morning or Afternoon.",
            "nullable":true
        },
        "EstimatedDurationHrs":{
            "title":"Estimated Duration in Hours",
            "type":"number",
            "description":"The estimated duration of the inspection in hours.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        },
        "InspectionLocation":{
            "title":"Inspection Location",
            "maxLength":"100",
            "type":"string",
            "description":"An optional descriptive name of the inspection location, such as Bank of America Building or corner lot.",
            "nullable":true
        },
        "TravelToStartOdometer":{
            "type":"number",
            "description":"The odometer reading before travel to the inspection site.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        },
        "RequestedDate":{
            "title":"Ready-by Date",
            "maxLength":"255",
            "type":"string",
            "description":"The date when the inspection was requested.",
            "nullable":true
        },
        "InspectionUpdateSource":{
            "type":"string",
            "description":"The source from which the inspection was updated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":"30",
            "type":"string",
            "description":"The inspection location contact???s preferred contact method.",
            "nullable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique identifier of the record parcel address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "TravelFromEndOdometer":{
            "type":"number",
            "description":"The odometer reading upon arrival at the next location.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        },
        "InspectionResult":{
            "title":"Result",
            "maxLength":"25",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the inspection address.",
            "nullable":true
        },
        "LnpRecordKey":{
            "title":"Record",
            "type":"integer",
            "description":"The unique identifier for an application record. The record is for permits, business licenses, or planning and zoning, and is determined by the classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "InspectionCompleteDttm":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date and time when the inspection was completed.",
            "format":"date-time",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the inspection address.",
            "nullable":true
        },
        "PhoneExtension":{
            "maxLength":"20",
            "type":"string",
            "description":"The contact's additional phone number extension.",
            "nullable":true
        },
        "ActlTravelTimeFromHrs":{
            "title":"Travel Time from Site",
            "type":"number",
            "description":"The travel time from the inspection site in hours.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        },
        "ActualDurationHrs":{
            "title":"Duration in Hours",
            "type":"number",
            "description":"The actual duration of the inspection in hours.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        },
        "PostalPlus4Code":{
            "title":"Postal Code",
            "maxLength":"10",
            "type":"string",
            "description":"The extended postal code in the inspection address.",
            "nullable":true
        },
        "TravelFromActualDistance":{
            "type":"number",
            "description":"The total distance traveled from the inspection site.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        },
        "RequestedTime":{
            "title":"Ready-by Time",
            "maxLength":"255",
            "type":"string",
            "description":"The time when the inspection was requested.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the inspection address.",
            "nullable":true
        },
        "ReadyByDttm":{
            "title":"Ready By",
            "type":"string",
            "description":"The date and time that the inspection site will be ready for the inspection to be performed.",
            "format":"date-time",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country of the inspection address.",
            "nullable":true
        },
        "OwnerSignatureDttm":{
            "title":"Signed On",
            "type":"string",
            "description":"The date and time when the owner signed the inspection.",
            "format":"date-time",
            "nullable":true
        },
        "CancellationReason":{
            "title":"Cancellation Reason",
            "maxLength":"150",
            "type":"string",
            "description":"The reason for canceling the inspection.",
            "nullable":true
        },
        "EstimatedTimeArrivalEnd":{
            "title":"ETA To",
            "type":"string",
            "description":"The estimated end time of arrival at the inspection site.",
            "format":"date-time",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the inspection.",
            "nullable":false,
            "default":"1"
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the inspection address.",
            "nullable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the inspection address.",
            "nullable":true
        },
        "ScheduledStartDttm":{
            "title":"Schedule Start Date",
            "type":"string",
            "description":"The scheduled inspection start date.",
            "format":"date-time",
            "nullable":true
        },
        "PhoneAreaCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The contact's phone area code.",
            "nullable":true
        },
        "PhoneCountryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The contact's international country code for the phone number.",
            "nullable":true
        },
        "InspectionStatus":{
            "title":"Status",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the inspection.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActualStartDttm":{
            "title":"Start Date",
            "type":"string",
            "description":"The actual start date of the inspection.",
            "format":"date-time",
            "nullable":true
        },
        "InspectionName":{
            "maxLength":"100",
            "type":"string",
            "description":"The description of the inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection.",
            "nullable":false
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the inspection address.",
            "nullable":true
        },
        "InspectionKey":{
            "type":"integer",
            "description":"The unique identifier of an inspection.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "IvrAccessCode":{
            "type":"string",
            "description":"The IVR password associated with the record's applicant user profile, or the user profile of any of the record's registered contacts.",
            "nullable":true,
            "x-queryable":false
        },
        "InspectorSignatureDttm":{
            "title":"Signed",
            "type":"string",
            "description":"The date and time when the inspector signed the inspection.",
            "format":"date-time",
            "nullable":true
        },
        "SystemStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the inspection status.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"A unique identifier for a record. This identifier is automatically generated based on the rules configured for the record type.",
            "nullable":false
        },
        "ParcelId":{
            "type":"integer",
            "description":"The unique identifier of the record parcel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ContractorSignatureDttm":{
            "title":"Signed",
            "type":"string",
            "description":"The date and time when the contractor signed the inspection.",
            "format":"date-time",
            "nullable":true
        },
        "InspectionScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated total inspection score.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            }
        },
        "InspectionId":{
            "title":"Inspection",
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "TravelToEndOdometer":{
            "type":"number",
            "description":"The odometer reading upon arrival at the site.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the inspection address.",
            "nullable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the inspection address.",
            "nullable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the inspection address.",
            "nullable":true
        },
        "EstimatedTimeArrival":{
            "title":"ETA From",
            "type":"string",
            "description":"The estimated time of arrival at the inspection site.",
            "format":"date-time",
            "nullable":true
        },
        "InspectionRating":{
            "title":"Rating",
            "maxLength":"5",
            "type":"string",
            "description":"The calculated rating based on the rating method.",
            "nullable":true
        },
        "NumberMajorViolations":{
            "title":"Major Violation",
            "type":"integer",
            "description":"The calculated total number of major violations for the inspection.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            }
        },
        "InspectionSource":{
            "maxLength":"30",
            "type":"string",
            "description":"The source from which the inspection was created.",
            "nullable":true
        },
        "ContactEmail":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The inspection location contact???s email address.",
            "nullable":true
        },
        "ReinspectionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is a reinspection. The default is no.",
            "nullable":true,
            "default":false
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The contact???s phone number.",
            "nullable":true
        },
        "ScheduledStartTime":{
            "title":"Time",
            "maxLength":"255",
            "type":"string",
            "description":"The time when the inspection was scheduled.",
            "nullable":true
        },
        "LocationLongitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude coordinate of the inspection location.",
            "nullable":true
        },
        "PreferredDate":{
            "title":"Preferred Date",
            "type":"string",
            "description":"The preferred date for the inspection.",
            "format":"date-time",
            "nullable":true
        },
        "ContactName":{
            "title":"Location Contact",
            "maxLength":"450",
            "type":"string",
            "description":"The name of the contact person for the inspection.",
            "nullable":true
        },
        "ActlTravelTimeToHrs":{
            "title":"Travel Time to Site",
            "type":"number",
            "description":"The travel time to the inspection site in hours.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorIVRInspections-item-response

Type: object

Show Source

• 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: Preferred Contact Method

  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.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "maxLength":"10",
            "type":"string",
            "description":"The subclassification for the record type, which indicates that the pre-application process is included in addition to the hearing process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionType":{
            "title":"Inspection Type",
            "maxLength":"15",
            "type":"string",
            "description":"The type of the inspection, such as Electrical.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistanceUOM":{
            "title":"Units",
            "maxLength":"5",
            "type":"string",
            "description":"The distance unit of measure. The prompt is the common units table.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledEndDttm":{
            "title":"Schedule End Date",
            "type":"string",
            "description":"The scheduled inspection end date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TravelToActualDistance":{
            "type":"number",
            "description":"The total distance traveled to the inspection site.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "LocationLatitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude coordinate of the inspection location.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualEndDttm":{
            "title":"End Date",
            "type":"string",
            "description":"The actual end date of the inspection.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SystemResult":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the inspection result.",
            "nullable":true,
            "x-queryable":true
        },
        "TravelFromStartOdometer":{
            "type":"number",
            "description":"The odometer reading before travel from the inspection site.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "RequestorComment":{
            "title":"Comments",
            "maxLength":"500",
            "type":"string",
            "description":"The inspection requester's comments.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledStartDate":{
            "title":"Date",
            "maxLength":"255",
            "type":"string",
            "description":"The date when the inspection was scheduled.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredTime":{
            "title":"Preferred Time",
            "maxLength":"15",
            "type":"string",
            "description":"The preferred time for the inspection, for example Morning or Afternoon.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedDurationHrs":{
            "title":"Estimated Duration in Hours",
            "type":"number",
            "description":"The estimated duration of the inspection in hours.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "InspectionLocation":{
            "title":"Inspection Location",
            "maxLength":"100",
            "type":"string",
            "description":"An optional descriptive name of the inspection location, such as Bank of America Building or corner lot.",
            "nullable":true,
            "x-queryable":true
        },
        "LicensePeriod":{
            "maxLength":"100",
            "type":"string",
            "description":"The reporting period that applies to the business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TravelToStartOdometer":{
            "type":"number",
            "description":"The odometer reading before travel to the inspection site.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "StreetNumber":{
            "maxLength":"20",
            "type":"string",
            "description":"The street number of the parcel address, or the first four characters of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequestedDate":{
            "title":"Ready-by Date",
            "maxLength":"255",
            "type":"string",
            "description":"The date when the inspection was requested.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionUpdateSource":{
            "type":"string",
            "description":"The source from which the inspection was updated.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":"30",
            "type":"string",
            "description":"The inspection location contact???s preferred contact method.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique identifier of the record parcel address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TravelFromEndOdometer":{
            "type":"number",
            "description":"The odometer reading upon arrival at the next location.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "InspectionResult":{
            "title":"Result",
            "maxLength":"25",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Record",
            "type":"integer",
            "description":"The unique identifier for an application record. The record is for permits, business licenses, or planning and zoning, and is determined by the classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InspectionCompleteDttm":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date and time when the inspection was completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "maxLength":"20",
            "type":"string",
            "description":"The contact's additional phone number extension.",
            "nullable":true,
            "x-queryable":true
        },
        "HideInspectorComment":{
            "title":"Hide Inspector Comment",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the inspector's comments are hidden from public users. This value defaults from the inspection type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActlTravelTimeFromHrs":{
            "title":"Travel Time from Site",
            "type":"number",
            "description":"The travel time from the inspection site in hours.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "ActualDurationHrs":{
            "title":"Duration in Hours",
            "type":"number",
            "description":"The actual duration of the inspection in hours.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Code",
            "maxLength":"10",
            "type":"string",
            "description":"The extended postal code in the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "TravelFromActualDistance":{
            "type":"number",
            "description":"The total distance traveled from the inspection site.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "NoneResultItemCount":{
            "type":"number",
            "description":"The number of checklist items for the inspection for which there is no inspection result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedTime":{
            "title":"Ready-by Time",
            "maxLength":"255",
            "type":"string",
            "description":"The time when the inspection was requested.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "ReadyByDttm":{
            "title":"Ready By",
            "type":"string",
            "description":"The date and time that the inspection site will be ready for the inspection to be performed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country of the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerSignatureDttm":{
            "title":"Signed On",
            "type":"string",
            "description":"The date and time when the owner signed the inspection.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CancellationReason":{
            "title":"Cancellation Reason",
            "maxLength":"150",
            "type":"string",
            "description":"The reason for canceling the inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the inspection transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedTimeArrivalEnd":{
            "title":"ETA To",
            "type":"string",
            "description":"The estimated end time of arrival at the inspection site.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the inspection.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionDistrictId":{
            "title":"District",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the inspection district.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledStartDttm":{
            "title":"Schedule Start Date",
            "type":"string",
            "description":"The scheduled inspection start date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The contact's phone area code.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The contact's international country code for the phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalInspectionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is the final inspection. The default is no.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionStatus":{
            "title":"Status",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the inspection.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActualStartDttm":{
            "title":"Start Date",
            "type":"string",
            "description":"The actual start date of the inspection.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Permit Type",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly name for the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionName":{
            "maxLength":"100",
            "type":"string",
            "description":"The description of the inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection.",
            "nullable":false,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionKey":{
            "type":"integer",
            "description":"The unique identifier of an inspection.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "IvrAccessCode":{
            "type":"string",
            "description":"The IVR password associated with the record's applicant user profile, or the user profile of any of the record's registered contacts.",
            "nullable":true,
            "x-queryable":false
        },
        "BillType":{
            "title":"Billable Type",
            "maxLength":"15",
            "type":"string",
            "description":"The bill type that determines the invoice type generated for this inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectorSignatureDttm":{
            "title":"Signed",
            "type":"string",
            "description":"The date and time when the inspector signed the inspection.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the inspection status.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"A unique identifier for a record. This identifier is automatically generated based on the rules configured for the record type.",
            "nullable":false,
            "x-queryable":true
        },
        "ParcelId":{
            "type":"integer",
            "description":"The unique identifier of the record parcel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContractorSignatureDttm":{
            "title":"Signed",
            "type":"string",
            "description":"The date and time when the contractor signed the inspection.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated total inspection score.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "StatusTime":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionId":{
            "title":"Inspection",
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TravelToEndOdometer":{
            "type":"number",
            "description":"The odometer reading upon arrival at the site.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "BillableFlag":{
            "title":"Billable Option",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the inspection is billable. The value defaults from the inspection type associated with the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedTimeArrival":{
            "title":"ETA From",
            "type":"string",
            "description":"The estimated time of arrival at the inspection site.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "VersionType":{
            "maxLength":"1",
            "type":"string",
            "description":"The activity for business license type for which options are set, such as origination, amendment, or renewal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionRating":{
            "title":"Rating",
            "maxLength":"5",
            "type":"string",
            "description":"The calculated rating based on the rating method.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberMajorViolations":{
            "title":"Major Violation",
            "type":"integer",
            "description":"The calculated total number of major violations for the inspection.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "InspectionSource":{
            "maxLength":"30",
            "type":"string",
            "description":"The source from which the inspection was created.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactEmail":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The inspection location contact???s email address.",
            "nullable":true,
            "x-queryable":true
        },
        "ReinspectionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this is a reinspection. The default is no.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The contact???s phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledStartTime":{
            "title":"Time",
            "maxLength":"255",
            "type":"string",
            "description":"The time when the inspection was scheduled.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationLongitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude coordinate of the inspection location.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredDate":{
            "title":"Preferred Date",
            "type":"string",
            "description":"The preferred date for the inspection.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Location Contact",
            "maxLength":"450",
            "type":"string",
            "description":"The name of the contact person for the inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "ActlTravelTimeToHrs":{
            "title":"Travel Time to Site",
            "type":"number",
            "description":"The travel time to the inspection site in hours.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the inspection was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top