Jump to

• Request
• Response

Get all inspections

get

/fscmRestApi/resources/11.13.18.05/publicSectorInspections

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • AltKeyPUID: Finds the inspection that matches the specified alternate key persistent unique identifier criteria.
    Finder Variables:
    • InspectionPuid; string; The persistent unique identifier for an inspection.
  • AlternateKey: Finds the inspection that matches the specified alternate key criteria.
    Finder Variables:
    • InspectionId; string; The alternate unique identifier for the inspection.
  • PrimaryKey: Finds the inspection that matches the specified primary key criteria.
    Finder Variables:
    • InspectionKey; integer; Finds the inspection that matches the specified primary key criteria.
  • myInsFinder: Finds an inspection using the specified keyword.
    Finder Variables:
    • PersonId; integer; The keyword used to find an inspection by matching with a person ID.
  • simpleSearchFinder: Finds an inspection using the specified keyword.
    Finder Variables:
    • value; string; The keyword used to find an inspection by matching with a description, inspection type, inspection status, record ID, and so on.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActlTravelTimeFromHrs; number; The travel time from the inspection site in hours.
  • ActlTravelTimeToHrs; number; The travel time to the inspection site in hours.
  • ActualDurationHrs; number; The actual duration of the inspection in hours.
  • ActualEndDttm; string; The actual end date of the inspection.
  • ActualStartDttm; string; The actual start date of the inspection.
  • Address1; string; The first or main address.
  • Address2; string; The second address, if present.
  • Address3; string; The third address, if present.
  • Address4; string; The fourth address, if present.
  • AddressId; integer; The unique identifier of the record parcel address.
  • AgencyId; integer; The identifier for the public sector agency associated with the inspection.
  • ApplicantBizProfileId; integer; The unique identifier of the applicant business profile when the applicant is a business entity.
  • ApplicantProfileId; integer; The unique identifier of the applicant user profile.
  • AssessFeeFlag; string; Indicates whether fees should be assessed for the inspection.
  • BillType; string; The bill type that determines the invoice type generated for this inspection.
  • BillableFlag; boolean; A yes or no indicator that identifies whether the inspection is billable or not.
  • CancellationReason; string; The reason for canceling the inspection.
  • ChgSchedulePolicyHrs; integer; The number of hours prior to the scheduled inspection time that a user can cancel or reschedule an inspection.
  • City; string; The city of the inspection.
  • ContactEmail; string; The inspection location contact???s email address.
  • ContactName; string; The name of contact person for the inspection.
  • ContactPhoneText; string; The contact???s phone number for text.
  • ContractorName; string; The contractor???s name.
  • ContractorSignatureDttm; string; The date and time when the contractor signed the inspection.
  • CoordinateX; number; The X coordinate of the inspection location.
  • CoordinateY; number; The Y coordinate of inspection location.
  • Country; string; The county of the inspection.
  • County; string; The county in the inspection address.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date when the record was created.
  • Description; string; The description of the inspection transaction.
  • DistanceUOM; string; The distance unit of measure. The prompt is the common units table.
  • EstimatedDurationHrs; number; The estimated duration of the inspection in hours.
  • EstimatedTimeArrival; string; The estimated time of arrival at the inspection site.
  • EstimatedTimeArrivalEnd; string; The estimated end time of arrival at the inspection site.
  • ExpirationDate; string; The date when the permit associated with the inspection expires.
  • FinalInspectionFlag; boolean; Indicates whether this is the final inspection. The default is no.
  • HideInspectorComment; string; Indicates whether inspector's comments are hidden from public users. This value defaults from the inspection type.
  • InspectionCompleteDttm; string; The date and time when inspection was completed.
  • InspectionDistrictId; string; The inspection district ID.
  • 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.
  • InspectionKey; integer; The unique identifier of an inspection.
  • InspectionLocation; string; An optional descriptive name of the inspection location, such as Bank of America Building or corner lot.
  • InspectionName; string; The description of the inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection.
  • InspectionPuid; string; The public unique identifier for an inspection. Used to import data.
  • InspectionRating; string; The calculated rating based on the rating method.
  • InspectionResult; string; The result of inspection, such as Pass, Fail, Yes, and No.
  • InspectionScore; integer; The calculated total inspection score.
  • InspectionSource; string; The source from which the inspection was created.
  • InspectionStatus; string; The status of the inspection.
  • InspectionStreetNumberAlpha; string; The street number in the parcel address used for sort when the content is alphanumeric.
  • InspectionStreetNumberNumeric; integer; The street number in the parcel address used for sort when the content is numeric.
  • InspectionType; string; The type of the inspection, such as Electrical.
  • InspectorId; integer; The ID of the inspector assigned to the inspection.
  • InspectorInitials; string; The initials of the inspector.
  • InspectorName; string; The name of the user who is assigned to the inspection.
  • InspectorPuid; string; The public unique identifier for the inspector assigned to the inspection.
  • InspectorSignatureDttm; string; The date and time when the inspector signed the inspection.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdatedBy; string; The user who last updated the record.
  • LnpRecordId; string; The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
  • LnpRecordKey; integer; The unique identifier for a record.
  • LocationLatitude; number; The latitude coordinate of the inspection location.
  • LocationLongitude; number; The longitude coordinate of the inspection location.
  • NoneResultItemCount; number; The number of inspection checklist items which have no result.
  • NumberMajorViolations; integer; The calculated total number of major violations for the inspection.
  • OwnerName; string; The owner???s name.
  • OwnerSignatureDttm; string; The date and time when the owner signed the inspection.
  • ParcelId; integer; The unique identifier of the record parcel.
  • PermitDescription; string; The description of the permit associated with the inspection.
  • PermitStatus; string; The status of the permit associated with the inspection.
  • PermitSystemStatus; string; The unique alphanumeric code or short name for the record status.
  • PermitType; string; The type of permit associated with the inspection.
  • PhoneAreaCode; string; The contact's phone area code.
  • PhoneCountryCode; string; The contact's international country code for the phone number.
  • PhoneExtension; string; The contact's additional phone number extension.
  • PhoneNumber; string; The contact???s phone number.
  • PostalCode; string; The postal code in the inspection address.
  • PostalPlus4Code; string; The extended postal code in the inspection address.
  • PreferredContactMethod; string; The inspection location contact???s preferred contact method.
  • PreferredDate; string; The preferred date for the inspection to be performed.
  • PreferredInspectorId; integer; The unique identifier for the reinspection preferred inspector.
  • PreferredInspectorName; string; The name of the reinspection preferred inspector.
  • PreferredTime; string; The preferred time for the inspection to be performed.
  • Province; string; The province in the inspection address.
  • ReadyByDttm; string; The date and time after which the inspection can be performed.
  • RecordNumber; string; The public unique identifier for a permit. Used to import data.
  • RecordType; string; The user-friendly name for the permit type.
  • ReinspectionFlag; boolean; Indicates whether this is a reinspection. The default is no.
  • ReinspectionIdBy; string; The unique identifier for the reinspection.
  • ReinspectionIdOf; string; The unique identifier of the failed inspection that requires a reinspection.
  • RequestedDate; string; The date when the inspection was requested.
  • RequestedTime; string; The time when the inspection was requested.
  • RequestorComment; string; The inspection requester's comments.
  • RequiredFlag; boolean; Indicates whether the inspection is required. Defaults from the inspection group, but if not available, the default is no for not required.
  • SchedTimeAfterDescr; string; The description to show instead of the inspection scheduled time if after the configured breakpoint.
  • SchedTimeBeforeDescr; string; The description to show instead of the inspection scheduled time if before the configured breakpoint.
  • SchedTimeDisplayCutoff; string; The breakpoint time used to determine which description to show for the inspection scheduled time.
  • SchedTimeRangeDisplay; string; Indicates whether an inspection request should show configurable descriptions instead of a specific time.
  • ScheduledEndDttm; string; The scheduled inspection end date.
  • ScheduledStartDate; string; The date when the inspection was scheduled.
  • ScheduledStartDttm; string; The scheduled inspection start date.
  • ScheduledStartTime; string; The time when the inspection was scheduled.
  • SchedulingMethod; string; The method used for scheduling an inspection. The request method is used if a user submits a preferred date and preferred time for an inspection to be scheduled. The ready method is used if a user submits a ready by date and a ready by time for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.
  • Srid; integer; The spatial reference ID (SRID) of the inspection location.
  • State; string; The state in the inspection address.
  • StatusTime; string; 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.
  • StreetDirection; string; The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center.
  • StreetName; string; The street number in the parcel address.
  • StreetNameConcat; string; Indicates the concatenated value of the street name corresponding to the parcel address. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix and direction suffix.
  • StreetNumber; string; The street name in the parcel address used during a search.
  • StreetSuffix; string; The street suffix that further describes that street, For example Drive, Avenue, and so on.
  • StreetType; string; The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
  • SystemResult; string; The unique alphanumeric code or short name for the inspection result.
  • SystemStatus; string; The unique alphanumeric code or short name for the inspection status.
  • TextAreaCode; string; The contact's mobile phone area code.
  • TextCountryCode; string; The contact's international country code for the mobile phone number.
  • TextNumber; string; The contact???s mobile phone number.
  • 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.
  • UnitNumber; string; The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : publicSectorInspections

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorInspections-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Inspections",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorInspections-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorInspections-item-response"
    }
}

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 : publicSectorInspections-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 or main address.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second address, if present.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third address, if present.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address, if present.
• 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.
• ApplicantBizProfileId: integer (int64)
  Title: Business Profile

  Read Only: true

  The unique identifier of the applicant business profile when the applicant is a business entity.
• ApplicantProfileId: integer (int64)
  Title: Applicant Profile

  Read Only: true

  The unique identifier of the applicant user profile.
• AssessFeeFlag: string
  Title: Assess Fee

  Maximum Length: 1

  Default Value: N

  Indicates whether fees should be assessed for the inspection.
• BillableFlag: boolean
  Title: Billable Option

  Read Only: true

  Maximum Length: 1

  A yes or no indicator that identifies whether the inspection is billable or not.
• 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.
• ChgSchedulePolicyHrs: integer (int32)
  Read Only: true

  The number of hours prior to the scheduled inspection time that a user can cancel or reschedule an inspection.
• City: string
  Title: City

  Maximum Length: 60

  The city of the inspection.
• 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 contact person for the inspection.
• ContactPhoneText: string
  Maximum Length: 255

  The contact???s phone number for text.
• ContractorName: string
  Title: Contractor

  Maximum Length: 360

  The contractor???s name.
• ContractorSignature: string (byte)
  The contractor???s signature.
• ContractorSignatureDttm: string (date-time)
  Title: Signed

  The date and time when the contractor signed the inspection.
• CoordinateX: number
  Title: Coordinate X

  The X coordinate of the inspection location.
• CoordinateY: number
  Title: Coordinate Y

  The Y coordinate of inspection location.
• Country: string
  Title: Country

  Maximum Length: 3

  The county of the inspection.
• County: string
  Title: County

  Maximum Length: 60

  The county in the inspection address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• 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: Duration

  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.
• ExpirationDate: string (date-time)
  Read Only: true

  The date when the permit associated with the inspection expires.
• 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 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 inspection was completed.
• InspectionDistrictId: string
  Title: District

  Read Only: true

  Maximum Length: 30

  The inspection district ID.
• 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.
• InspectionPuid: string
  Maximum Length: 480

  The public unique identifier for an inspection. Used to import data.
• 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 inspection, such as Pass, Fail, Yes, and No.
• 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.
• InspectionStreetNumberAlpha: string
  Read Only: true

  Maximum Length: 20

  The street number in the parcel address used for sort when the content is alphanumeric.
• InspectionStreetNumberNumeric: integer (int64)
  Read Only: true

  The street number in the parcel address used for sort when the content is numeric.
• 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.
• InspectorId: integer (int64)
  Title: Inspector ID

  The ID of the inspector assigned to the inspection.
• InspectorInitials: string
  Title: Initials

  Maximum Length: 6

  The initials of the inspector.
• InspectorName: string
  Title: Inspector

  Maximum Length: 360

  The name of the user who is assigned to the inspection.
• InspectorPuid: string
  The public unique identifier for the inspector assigned to the inspection.
• InspectorSignature: string (byte)
  The inspector???s signature.
• InspectorSignatureDttm: string (date-time)
  Title: Signed

  The date and time when the inspector signed the inspection.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Permit

  Maximum Length: 50

  The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
• LnpRecordKey: integer (int64)
  Title: Record

  The unique identifier for a record.
• LocationLatitude: number
  Title: Latitude

  The latitude coordinate of the inspection location.
• LocationLongitude: number
  Title: Longitude

  The longitude coordinate of the inspection location.
• NoneResultItemCount: number
  The number of inspection checklist items which have no result.
• NumberMajorViolations: integer (int32)
  Title: Major Violation

  The calculated total number of major violations for the inspection.
• OwnerName: string
  Title: Owner

  Maximum Length: 360

  The owner???s name.
• OwnerSignature: string (byte)
  The site owner???s signature.
• 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.
• PermitDescription: string
  Title: Permit Description

  Read Only: true

  Maximum Length: 1000

  The description of the permit associated with the inspection.
• PermitStatus: string
  Read Only: true

  Maximum Length: 15

  The status of the permit associated with the inspection.
• PermitSystemStatus: string
  Read Only: true

  Maximum Length: 15

  The unique alphanumeric code or short name for the record status.
• PermitType: string
  Read Only: true

  Maximum Length: 1000

  The type of permit associated with the inspection.
• 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 to be performed.
• PreferredInspectorId: integer (int64)
  Title: Preferred Inspector

  The unique identifier for the reinspection preferred inspector.
• PreferredInspectorName: string
  Read Only: true

  The name of the reinspection preferred inspector.
• PreferredTime: string
  Title: Preferred Time

  Maximum Length: 15

  The preferred time for the inspection to be performed.
• Province: string
  Title: Province

  Maximum Length: 60

  The province in the inspection address.
• ReadyByDttm: string (date-time)
  Title: Ready By

  The date and time after which the inspection can be performed.
• RecordNumber: string
  Maximum Length: 64

  The public unique identifier for a permit. Used to import data.
• RecordType: string
  Title: Permit Type

  Maximum Length: 100

  The user-friendly name for the permit type.
• ReinspectionFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether this is a reinspection. The default is no.
• ReinspectionIdBy: string
  Title: Reinspected By

  Maximum Length: 50

  The unique identifier for the reinspection.
• ReinspectionIdOf: string
  Title: Reinspection Of

  Maximum Length: 50

  The unique identifier of the failed inspection that requires a reinspection.
• 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.
• RequiredFlag: boolean
  Title: Required

  Maximum Length: 1

  Default Value: false

  Indicates whether the inspection is required. Defaults from the inspection group, but if not available, the default is no for not required.
• SchedTimeAfterDescr: string
  Read Only: true

  Maximum Length: 30

  The description to show instead of the inspection scheduled time if after the configured breakpoint.
• SchedTimeBeforeDescr: string
  Read Only: true

  Maximum Length: 30

  The description to show instead of the inspection scheduled time if before the configured breakpoint.
• SchedTimeDisplayCutoff: string (date-time)
  Read Only: true

  The breakpoint time used to determine which description to show for the inspection scheduled time.
• SchedTimeRangeDisplay: string
  Read Only: true

  Maximum Length: 1

  Indicates whether an inspection request should show configurable descriptions instead of a specific time.
• ScheduledEndDttm: string (date-time)
  Title: Schedule End Date

  Read Only: true

  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.
• SchedulingMethod: string
  Read Only: true

  Maximum Length: 15

  The method used for scheduling an inspection. The request method is used if a user submits a preferred date and preferred time for an inspection to be scheduled. The ready method is used if a user submits a ready by date and a ready by time for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.
• Shape: object Shape
  The shape of the inspection location.
• Srid: integer (int64)
  The spatial reference ID (SRID) of the inspection location.
• State: string
  Title: State

  Maximum Length: 60

  The state in the inspection address.
• StatusTime: 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.
• StreetDirection: string
  Maximum Length: 10

  The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center.
• StreetName: string
  Maximum Length: 240

  The street number in the parcel address.
• StreetNameConcat: string
  Maximum Length: 350

  Indicates the concatenated value of the street name corresponding to the parcel address. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix and direction suffix.
• StreetNumber: string
  Maximum Length: 20

  The street name in the parcel address used during a search.
• StreetSuffix: string
  Maximum Length: 20

  The street suffix that further describes that street, For example Drive, Avenue, and so on.
• StreetType: string
  Maximum Length: 20

  The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
• 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.
• TextAreaCode: string
  Maximum Length: 10

  The contact's mobile phone area code.
• TextCountryCode: string
  Maximum Length: 10

  The contact's international country code for the mobile phone number.
• TextNumber: string
  Title: Mobile Phone

  Maximum Length: 40

  The contact???s mobile phone number.
• 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.
• UnitNumber: string
  Maximum Length: 30

  The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.

{
    "type":"object",
    "properties":{
        "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
        },
        "SchedTimeBeforeDescr":{
            "maxLength":30,
            "type":"string",
            "description":"The description to show instead of the inspection scheduled time if before the configured breakpoint.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledEndDttm":{
            "title":"Schedule End Date",
            "type":"string",
            "description":"The scheduled inspection end date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLatitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude coordinate of the inspection location.",
            "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
        },
        "StreetSuffix":{
            "maxLength":20,
            "type":"string",
            "description":"The street suffix that further describes that street, For example Drive, Avenue, and so on.",
            "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
        },
        "ReinspectionIdOf":{
            "title":"Reinspection Of",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the failed inspection that requires a reinspection.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedDurationHrs":{
            "title":"Duration",
            "type":"number",
            "description":"The estimated duration of the inspection in hours.",
            "nullable":true,
            "x-hints":{
                "precision":8,
                "scale":2
            },
            "x-queryable":true
        },
        "RequestedDate":{
            "title":"Ready by Date",
            "maxLength":255,
            "type":"string",
            "description":"The date when the inspection was requested.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactMethod":{
            "title":"Contact Methods",
            "maxLength":30,
            "type":"string",
            "description":"The inspection location contact???s preferred contact method.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantProfileId":{
            "title":"Applicant Profile",
            "type":"integer",
            "description":"The unique identifier of the applicant user profile.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SchedTimeAfterDescr":{
            "maxLength":30,
            "type":"string",
            "description":"The description to show instead of the inspection scheduled time if after the configured breakpoint.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionResult":{
            "title":"Result",
            "maxLength":25,
            "type":"string",
            "description":"The result of inspection, such as Pass, Fail, Yes, and No.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetType":{
            "maxLength":20,
            "type":"string",
            "description":"The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Record",
            "type":"integer",
            "description":"The unique identifier for a record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 inspector's comments are hidden from public users. This value defaults from the inspection type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectorId":{
            "title":"Inspector ID",
            "type":"integer",
            "description":"The ID of the inspector assigned to the inspection.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "NoneResultItemCount":{
            "type":"number",
            "description":"The number of inspection checklist items which have no result.",
            "nullable":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
        },
        "ReadyByDttm":{
            "title":"Ready By",
            "type":"string",
            "description":"The date and time after which the inspection can be performed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "description":"The county of the inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "maxLength":10,
            "type":"string",
            "description":"The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateX":{
            "title":"Coordinate X",
            "type":"number",
            "description":"The X coordinate of the inspection location.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier for a permit. Used to import data.",
            "nullable":false,
            "x-queryable":true
        },
        "CoordinateY":{
            "title":"Coordinate Y",
            "type":"number",
            "description":"The Y coordinate of inspection location.",
            "nullable":true,
            "x-queryable":true
        },
        "TextNumber":{
            "title":"Mobile Phone",
            "maxLength":40,
            "type":"string",
            "description":"The contact???s mobile phone number.",
            "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
        },
        "Shape":{
            "type":"object",
            "description":"The shape of the inspection location.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "AssessFeeFlag":{
            "title":"Assess Fee",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether fees should be assessed for the inspection.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "InspectionDistrictId":{
            "title":"District",
            "maxLength":30,
            "type":"string",
            "description":"The inspection district ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SchedTimeRangeDisplay":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an inspection request should show configurable descriptions instead of a specific time.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "InspectorInitials":{
            "title":"Initials",
            "maxLength":6,
            "type":"string",
            "description":"The initials of the inspector.",
            "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
        },
        "PermitDescription":{
            "title":"Permit Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the permit associated with the inspection.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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,
            "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
        },
        "OwnerSignature":{
            "type":"string",
            "description":"The site owner???s signature.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "InspectionStreetNumberNumeric":{
            "type":"integer",
            "description":"The street number in the parcel address used for sort when the content is numeric.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":20
            },
            "x-queryable":true
        },
        "ApplicantBizProfileId":{
            "title":"Business Profile",
            "type":"integer",
            "description":"The unique identifier of the applicant business profile when the applicant is a business entity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "ContractorName":{
            "title":"Contractor",
            "maxLength":360,
            "type":"string",
            "description":"The contractor???s name.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The date when the permit associated with the inspection expires.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for an inspection. Used to import data.",
            "nullable":false,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":40,
            "type":"string",
            "description":"The contact???s phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the inspection is required. Defaults from the inspection group, but if not available, the default is no for not required.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PermitStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the permit associated with the inspection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLongitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude coordinate of the inspection location.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Location Contact",
            "maxLength":450,
            "type":"string",
            "description":"The name of 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 when the record was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredInspectorId":{
            "title":"Preferred Inspector",
            "type":"integer",
            "description":"The unique identifier for the reinspection preferred inspector.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StreetName":{
            "maxLength":240,
            "type":"string",
            "description":"The street number in the parcel address.",
            "nullable":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
        },
        "ContractorSignature":{
            "type":"string",
            "description":"The contractor???s signature.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "TravelToActualDistance":{
            "type":"number",
            "description":"The total distance traveled to the inspection site.",
            "nullable":true,
            "x-hints":{
                "precision":8,
                "scale":2
            },
            "x-queryable":true
        },
        "PreferredInspectorName":{
            "type":"string",
            "description":"The name of the reinspection preferred inspector.",
            "nullable":true,
            "readOnly":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
        },
        "StreetNameConcat":{
            "maxLength":350,
            "type":"string",
            "description":"Indicates the concatenated value of the street name corresponding to the parcel address. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix and direction suffix.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestorComment":{
            "title":"Comments",
            "maxLength":500,
            "type":"string",
            "description":"The inspection requester's comments.",
            "nullable":true,
            "x-queryable":true
        },
        "ReinspectionIdBy":{
            "title":"Reinspected By",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the reinspection.",
            "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
        },
        "PreferredTime":{
            "title":"Preferred Time",
            "maxLength":15,
            "type":"string",
            "description":"The preferred time for the inspection to be performed.",
            "nullable":true,
            "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
        },
        "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 name in the parcel address used during a search.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InspectorPuid":{
            "type":"string",
            "description":"The public unique identifier for the inspector assigned to the inspection.",
            "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
            }
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique identifier of the record parcel address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the inspection.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionCompleteDttm":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date and time when 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
        },
        "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
        },
        "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
        },
        "InspectorSignature":{
            "type":"string",
            "description":"The inspector???s signature.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPhoneText":{
            "maxLength":255,
            "type":"string",
            "description":"The contact???s phone number for text.",
            "nullable":true,
            "x-queryable":true
        },
        "SchedulingMethod":{
            "maxLength":15,
            "type":"string",
            "description":"The method used for scheduling an inspection. The request method is used if a user submits a preferred date and preferred time for an inspection to be scheduled. The ready method is used if a user submits a ready by date and a ready by time for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The owner???s name.",
            "nullable":true,
            "x-queryable":true
        },
        "PermitSystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The unique alphanumeric code or short name for the record status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the inspection address.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectorName":{
            "title":"Inspector",
            "maxLength":360,
            "type":"string",
            "description":"The name of the user who is assigned to the inspection.",
            "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
        },
        "SchedTimeDisplayCutoff":{
            "type":"string",
            "description":"The breakpoint time used to determine which description to show for the inspection scheduled time.",
            "format":"date-time",
            "nullable":true,
            "readOnly":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
        },
        "RecordType":{
            "title":"Permit Type",
            "maxLength":100,
            "type":"string",
            "description":"The user-friendly name for the permit type.",
            "nullable":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":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "TextCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The contact's international country code for the mobile phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "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":"Permit",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for an application 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
        },
        "PermitType":{
            "maxLength":1000,
            "type":"string",
            "description":"The type of permit associated with the inspection.",
            "nullable":true,
            "readOnly":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
        },
        "BillableFlag":{
            "title":"Billable Option",
            "maxLength":1,
            "type":"boolean",
            "description":"A yes or no indicator that identifies whether the inspection is billable or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChgSchedulePolicyHrs":{
            "type":"integer",
            "description":"The number of hours prior to the scheduled inspection time that a user can cancel or reschedule an inspection.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionStreetNumberAlpha":{
            "maxLength":20,
            "type":"string",
            "description":"The street number in the parcel address used for sort when the content is alphanumeric.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first or main 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
        },
        "InspectionRating":{
            "title":"Rating",
            "maxLength":5,
            "type":"string",
            "description":"The calculated rating based on the rating method.",
            "nullable":true,
            "x-queryable":true
        },
        "TextAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The contact's mobile phone area code.",
            "nullable":true,
            "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
        },
        "ScheduledStartTime":{
            "title":"Time",
            "maxLength":255,
            "type":"string",
            "description":"The time when the inspection was scheduled.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredDate":{
            "title":"Preferred Date",
            "type":"string",
            "description":"The preferred date for the inspection to be performed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Srid":{
            "type":"integer",
            "description":"The spatial reference ID (SRID) of the inspection location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "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 : Shape

Type: object

The shape of the inspection location.

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