Get a project record inspection
get
/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordInspections/{publicSectorProjectRecordInspectionsUniqID}
Request
Path Parameters
-
publicSectorProjectRecordInspectionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ProjectCode, InspectionId and RecordKey ---for the Project Record Inspections resource and used to uniquely identify an instance of Project Record Inspections. The client should not generate the hash key value. Instead, the client should query on the Project Record Inspections collection resource with a filter on the primary key values in order to navigate to a specific instance of Project Record Inspections.
For example: publicSectorProjectRecordInspections?q=ProjectCode=<value1>;InspectionId=<value2>;RecordKey=<value3>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorProjectRecordInspections-item-response
Type:
Show Source
object-
ActlTravelTimeFromHrs: number
Read Only:
trueThe number of hours taken by the inspector to return home or office from the inspection site. -
ActlTravelTimeToHrs: number
Read Only:
trueThe number of hours taken by the inspector to arrive at the inspection site from home or office. -
ActualDurationHrs: number
Read Only:
trueThe actual number of hours taken to complete the inspection. -
ActualEndDttm: string
(date-time)
Read Only:
trueThe actual date and time when the inspection ended. -
ActualStartDttm: string
(date-time)
Read Only:
trueThe actual date and time when the inspection started. -
Address1: string
Read Only:
trueMaximum Length:240The first or main address. -
Address2: string
Read Only:
trueMaximum Length:240The second address, if available. -
Address3: string
Read Only:
trueMaximum Length:240The third address, if available. -
Address4: string
Read Only:
trueMaximum Length:240The fourth address, if available. -
AddressId: integer
(int64)
Read Only:
trueThe identifier of the parcel address. -
AgencyId: integer
(int32)
Read Only:
trueThe unique identifier of the public sector agency. -
ApplicantBizProfileId: integer
(int64)
Read Only:
trueThe profile ID of the business of the applicant. -
ApplicantProfileId: integer
(int64)
Read Only:
trueThe profile ID of the applicant. -
BillableFlag: string
Read Only:
trueMaximum Length:1Indicates whether the inspection is a billable transaction. The default value is No. -
BillType: string
Read Only:
trueMaximum Length:15The type of invoice that is generated for the inspection transaction. -
CancellationReason: string
Read Only:
trueMaximum Length:150The reason for cancellation. -
City: string
Read Only:
trueMaximum Length:60The city of the inspection location. -
ContactEmail: string
Read Only:
trueMaximum Length:320The email address of the contact. -
ContactName: string
Read Only:
trueMaximum Length:450The name of the contact. -
ContractorName: string
Read Only:
trueMaximum Length:360The name of the contractor. -
ContractorSignature: string
(byte)
Read Only:
trueThe signature of the contractor. -
ContractorSignatureDttm: string
(date-time)
Read Only:
trueThe date and time when the contractor signed. -
CoordinateX: number
Read Only:
trueThe x-axis coordinate value of the inspection location. -
CoordinateY: number
Read Only:
trueThe y-axis coordinate value of the inspection location. -
Country: string
Read Only:
trueMaximum Length:3The country in which the inspection is required. -
County: string
Read Only:
trueMaximum Length:60The county of the inspection location. -
CreatedBy: string
Read Only:
trueMaximum Length:64The name of the user who created the inspection. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the inspection was created. -
Description: string
Read Only:
trueMaximum Length:100The description of the inspection. -
DistanceUom: string
Read Only:
trueMaximum Length:3The unit of measure for the distance in miles or kilometers for the inspection site. -
EstimatedDurationHrs: number
Read Only:
trueThe estimated number of hours required to perform the inspection. This information can be used for planning and scheduling. -
EstimatedTimeArrival: string
(date-time)
Read Only:
trueThe estimated time of arrival of the inspector at the inspection location. -
EstimatedTimeArrivalEnd: string
(date-time)
Read Only:
trueThe latest estimated time of arrival at the inspection site. -
FinalInspectionFlag: string
Read Only:
trueMaximum Length:1The option that indicates if the inspection type is final. -
HideInspectorComment: string
Read Only:
trueMaximum Length:1The option to hide the comments entered by the inspector. -
InspectionCompleteDttm: string
(date-time)
Read Only:
trueThe date and time when the inspection was completed. -
InspectionDistrictId: string
Read Only:
trueMaximum Length:30The unique identifier of the inspection location district. -
InspectionId: string
Title:
InspectionRead Only:trueMaximum Length:50The unique identifier of the inspection. -
InspectionLocation: string
Read Only:
trueMaximum Length:100The descriptive location of the inspection. -
InspectionName: string
Read Only:
trueMaximum Length:100The name of the inspection. -
InspectionRating: string
Read Only:
trueMaximum Length:5The rating of the inspection based on the range of scores defined by the agency. -
InspectionResult: string
Title:
ResultRead Only:trueMaximum Length:25The final result of the inspection. If scoring is used, the result appears after you complete the inspection checklists and submit the complete inspection with required signatures. -
InspectionScore: integer
(int32)
Read Only:
trueThe final score of the inspection that is calculated based on the entries for the checklist items. -
InspectionStatus: string
Title:
StatusRead Only:trueMaximum Length:15The name of the inspection status. The status name is used as the display status for the inspection in the permit application. -
InspectionType: string
Title:
Inspection TypeRead Only:trueMaximum Length:15The unique identifier of the type of inspection. -
InspectorId: integer
(int64)
Read Only:
trueThe unique identifier of the inspector. -
InspectorInitials: string
Read Only:
trueMaximum Length:6The initials of the inspector. -
InspectorName: string
Title:
InspectorRead Only:trueMaximum Length:360The name of the inspector. -
InspectorSignature: string
(byte)
Read Only:
trueThe signature of the inspector. -
InspectorSignatureDttm: string
(date-time)
Read Only:
trueThe date and time when the inspector signed. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the inspection was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The name of the user who last updated the inspection. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LnpRecordId: string
Title:
PermitRead Only:trueMaximum Length:50The identifier of the application record. The value is generated based on the auto number rule configured for the type of record. -
LnpRecordKey: integer
(int64)
Read Only:
trueThe unique identifier of the record. -
LocationLatitude: number
Read Only:
trueThe latitude of the inspection location. -
LocationLongitude: number
Read Only:
trueThe longitude of the inspection location. -
NumMajorViolations: integer
(int32)
Read Only:
trueThe total number of violations found in the inspection. A failing result for an inspection checklist item constitutes a major violation. -
OwnerName: string
Read Only:
trueMaximum Length:360The name of the owner. -
OwnerSignature: string
(byte)
Read Only:
trueThe signature of the owner. -
OwnerSignatureDttm: string
(date-time)
Read Only:
trueThe date and time when the owner signed. -
ParcelId: integer
(int64)
Read Only:
trueThe identifier of the parcel. -
PhoneAreaCode: string
Read Only:
trueMaximum Length:10The area code of the phone number. -
PhoneCountryCode: string
Read Only:
trueMaximum Length:10The country code of the phone number. -
PhoneExtension: string
Read Only:
trueMaximum Length:20The extension of the phone number. -
PhoneNumber: string
Read Only:
trueMaximum Length:40The phone number of the contact person. -
PostalCode: string
Read Only:
trueMaximum Length:60The postal code of the inspection location. -
PostalPlus4Code: string
Read Only:
trueMaximum Length:10The extended postal code of the inspection location. -
PreferredContactMethod: string
Read Only:
trueMaximum Length:30The preferred mode of communication. -
ProjectCode: string
Read Only:
trueMaximum Length:255The unique identifier of the project. -
Province: string
Read Only:
trueMaximum Length:60The province of the inspection location. -
ReadyByDttm: string
(date-time)
Read Only:
trueThe date and time after which the inspection can be performed. -
RecordId: string
Read Only:
trueMaximum Length:50The identifier of the application record. The value is generated based on the auto number rule configured for the type of record. -
RecordKey: integer
(int64)
Read Only:
trueThe unique identifier of the record. -
RecordType: string
Title:
Permit TypeRead Only:trueMaximum Length:100The type of the record. -
ReinspectionFlag: string
Read Only:
trueMaximum Length:1The option to indicate if this is a re-inspection. -
RequestorComment: string
Read Only:
trueMaximum Length:500The comment entered by the inspection requestor. -
ScheduledEndDttm: string
(date-time)
Read Only:
trueThe date and time when the inspection is scheduled to end. -
ScheduledStartDttm: string
(date-time)
Read Only:
trueThe date and time when the inspection is scheduled to start. -
Srid: integer
(int64)
Read Only:
trueThe SRID value of the inspection location. This Spatial Reference System Identifier (SRID) is a unique value that identifies the projected, not projected, and local spatial coordinate system definitions for the inspection location. These are commonly used in most GIS systems. -
State: string
Read Only:
trueMaximum Length:60The state of the inspection location. -
StatusTime: string
(date-time)
Read Only:
trueThe date and time when the status was set. -
SubmitDate: string
(date-time)
Read Only:
trueThe date and time when the permit was submitted. -
SystemResult: string
Read Only:
trueMaximum Length:20The result of the inspection as defined in the system. -
SystemStatus: string
Read Only:
trueMaximum Length:15The system defined status for the inspection. -
TravelFromActualDistance: number
Read Only:
trueThe actual distance from the inspection site. -
TravelFromEndOdometer: number
Read Only:
trueThe odometer reading value when the inspector reaches the next location from the inspection site. -
TravelFromStartOdometer: number
Read Only:
trueThe odometer reading value when the inspector starts from the inspection site. -
TravelToActualDistance: number
Read Only:
trueThe actual distance to the inspection site. -
TravelToEndOdometer: number
Read Only:
trueThe odometer reading value when the inspector reaches the inspection site. -
TravelToStartOdometer: number
Read Only:
trueThe odometer reading value when the inspector starts to the inspection site.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.