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; The key for an inspection record.
- 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.
- AltKeyPUID: Finds the inspection that matches the specified alternate key persistent unique identifier criteria.
-
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.
- Applicant; integer; The party ID of the person applying for a permit, business license, or planning and zoning conditional use permit.
- 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.
- BusDbaBusinessName; string; The doing business as (DBA) name for a business entity.
- 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.
- Classification; string; The classification of the application record.
- 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.
- CreatedByName; string; The display name of the user who created the record.
- 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 record 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.
- InspectionCreationDate; string; The date when the record was created.
- InspectionDistrictId; string; The inspection district ID.
- InspectionGroup; string; The inspection group associated with the record type.
- 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 key for an inspection record.
- 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.
- InspectionUpdateDate; string; The date when the record was last updated.
- 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.
- LayoutVersion; string; The version identifier assigned to a specific intake form layout.
- LicensePeriod; string; The license period associated with the business license.
- 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 record associated with the inspection.
- PermitStatus; string; The status of the record associated with the inspection.
- PermitSystemStatus; string; The unique alphanumeric code or short name for the record status.
- PermitType; string; The type of record 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.
- PrimaryFlag; boolean; Indicates whether the record is a primary application that has one or more subapplications. When a permit is created, the default value is N or no.
- PrimaryRecordId; string; The unique identifier for the primary application record. This identifier is automatically generated based on the rules configured for the record type.
- PrimaryRecordKey; integer; The unique identifier for the primary record.
- PrimarySort; string; The sort level of this inspection based on the PrimaryFlag value. If the PrimaryFlag value is Y or yes, then 1, else 2.
- 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 record. Used to import data.
- RecordType; string; The user-friendly name for the permit type.
- RecordTypeCode; string; The record type code of the record associated with the inspection.
- RecordTypeId; string; The unique identifier for the record 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.
- RelationshipType; string; Indicates the relationship between the record associated with the inspection and other application records. Valid values are Primary or Subapplication.
- 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. This attribute will be deprecated in a future release and should not be used.
- SchedTimeBeforeDescr; string; The description to show instead of the inspection scheduled time if before the configured breakpoint. This attribute will be deprecated in a future release and should not be used.
- SchedTimeDisplayCutoff; string; The breakpoint time used to determine which description to show for the inspection scheduled time. This attribute will be deprecated in a future release and should not be used.
- 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.
- SubapplicationFlag; boolean; Indicates whether the record is a subapplication or child of a primary application. When a permit is created, the default value is N or no.
- SubapplicationSort; string; The sort level of this inspection based on the SubapplicationFlag value. If the SubapplicationFlag value is Y or yes, then 1, else 2.
- Subclassification; string; The subclassification for the record type, which indicates that the pre-application process is included in addition to the hearing process.
- 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.
- UpdatedByName; string; The user who last updated the record.
- VersionType; string; The activity for business license type for which options are set, such as origination, amendment, or renewal.
-
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorInspections
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorInspections-item-response
Type:
Show Source
object
-
ActlTravelTimeFromHrs: number
Title:
Travel Time from Site
The travel time from the inspection site in hours. -
ActlTravelTimeToHrs: number
Title:
Travel Time to Site
The travel time to the inspection site in hours. -
ActualDurationHrs: number
Title:
Duration in Hours
The actual duration of the inspection in hours. -
ActualEndDttm: string
(date-time)
Title:
End Date
The actual end date of the inspection. -
ActualStartDttm: string
(date-time)
Title:
Start Date
The actual start date of the inspection. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first 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. -
Applicant: integer
(int64)
Read Only:
true
The party ID of the person applying for a permit, business license, or planning and zoning conditional use permit. -
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. -
BusDbaBusinessName: string
Read Only:
true
Maximum Length:100
The doing business as (DBA) name for a business entity. -
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. -
Classification: string
Read Only:
true
Maximum Length:3
The classification of the application 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 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. -
CreatedByName: string
Title:
Created By
Read Only:true
Maximum Length:255
The display name of the user who created the record. -
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 record 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. -
InspectionCreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
InspectionDistrictId: string
Title:
District
Read Only:true
Maximum Length:30
The inspection district ID. -
InspectionGroup: string
Read Only:
true
Maximum Length:15
The inspection group associated with the record type. -
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 key for an inspection record.
-
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. -
InspectionUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
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. -
LayoutVersion: string
Read Only:
true
Maximum Length:30
The version identifier assigned to a specific intake form layout. -
LicensePeriod: string
Title:
License Period
Read Only:true
Maximum Length:100
The license period associated with the business license. -
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 record associated with the inspection. -
PermitStatus: string
Read Only:
true
Maximum Length:15
The status of the record 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 record 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. -
PrimaryFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the record is a primary application that has one or more subapplications. When a permit is created, the default value is N or no. -
PrimaryRecordId: string
Read Only:
true
Maximum Length:50
The unique identifier for the primary application record. This identifier is automatically generated based on the rules configured for the record type. -
PrimaryRecordKey: integer
(int64)
Read Only:
true
The unique identifier for the primary record. -
PrimarySort: string
Read Only:
true
Maximum Length:1
The sort level of this inspection based on the PrimaryFlag value. If the PrimaryFlag value is Y or yes, then 1, else 2. -
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 record. Used to import data. -
RecordType: string
Title:
Permit Type
Maximum Length:100
The user-friendly name for the permit type. -
RecordTypeCode: string
Title:
Record Type Code
Read Only:true
Maximum Length:20
The record type code of the record associated with the inspection. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
The unique identifier for the record 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. -
RelationshipType: string
Read Only:
true
Maximum Length:80
Indicates the relationship between the record associated with the inspection and other application records. Valid values are Primary or Subapplication. -
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. This attribute will be deprecated in a future release and should not be used. -
SchedTimeBeforeDescr: string
Read Only:
true
Maximum Length:30
The description to show instead of the inspection scheduled time if before the configured breakpoint. This attribute will be deprecated in a future release and should not be used. -
SchedTimeDisplayCutoff: string
(date-time)
Read Only:
true
The breakpoint time used to determine which description to show for the inspection scheduled time. This attribute will be deprecated in a future release and should not be used. -
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. -
SubapplicationFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the record is a subapplication or child of a primary application. When a permit is created, the default value is N or no. -
SubapplicationSort: string
Read Only:
true
Maximum Length:1
The sort level of this inspection based on the SubapplicationFlag value. If the SubapplicationFlag value is Y or yes, then 1, else 2. -
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. -
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. -
UpdatedByName: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
VersionType: string
Read Only:
true
Maximum Length:1
The activity for business license type for which options are set, such as origination, amendment, or renewal.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Shape
Type:
object
The shape of the inspection location.
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.