Get an inspection worklist
get
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionWorklists/{InspectionKey}
Request
Path Parameters
-
InspectionKey(required): integer
The key for an inspection record.
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:
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.
Root Schema : publicSectorInspectionWorklists-item-response
Type:
Show Source
object
-
ActivityDescription: string
Read Only:
true
Maximum Length:80
The user-friendly description of the business license type for which options are set, such as origination, amendment, or renewal. -
ActlTravelTimeFromHrs: number
Read Only:
true
The travel time from the inspection site in hours. -
ActlTravelTimeToHrs: number
Read Only:
true
The travel time to the inspection site in hours. -
ActualDurationHrs: number
Read Only:
true
The actual duration of the inspection in hours. -
ActualEndDttm: string
(date-time)
Read Only:
true
The actual end date of the inspection. -
ActualStartDttm: string
(date-time)
Read Only:
true
The actual start date of the inspection. -
Address1: string
Read Only:
true
Maximum Length:240
The first or main address. -
Address2: string
Read Only:
true
Maximum Length:240
The second address, if present. -
Address3: string
Read Only:
true
Maximum Length:240
The third address, if present. -
Address4: string
Read Only:
true
Maximum Length:240
The fourth address, if present. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier of the record parcel address. -
AgencyId: integer
(int32)
Read Only:
true
The identifier for the public sector agency associated with the inspection. -
ApplicantBizProfileId: integer
(int64)
Read Only:
true
The unique identifier of the applicant business profile when the applicant is a business entity. -
ApplicantProfileId: integer
(int64)
Read Only:
true
The unique identifier of the applicant user profile. -
AssessFeeFlag: string
Read Only:
true
Maximum Length:1
Indicates whether fees should be assessed for the inspection. -
AssignmentMethod: string
Read Only:
true
Maximum Length:30
Indicates the assignment method specified in the agency options for each inspection scheduling method. Values include Date Only, Specific Time, and Time Range. -
BillableFlag: string
Read Only:
true
Maximum Length:1
A yes or no indicator that identifies whether the inspection is billable or not. -
BillType: string
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
Read Only:
true
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
Read Only:
true
Maximum Length:60
The city of the inspection. -
Classification: string
Read Only:
true
Maximum Length:3
The classification of the application record. -
ClassificationDescription: string
Read Only:
true
Maximum Length:80
The user-friendly description of the classification of the application record. -
ContactEmail: string
Read Only:
true
Maximum Length:320
The inspection location contact???s email address. -
ContactName: string
Read Only:
true
Maximum Length:450
The name of contact person for the inspection. -
ContractorName: string
Read Only:
true
Maximum Length:360
The contractor???s name. -
ContractorSignature: string
(byte)
Read Only:
true
The contractor???s signature. -
ContractorSignatureDttm: string
(date-time)
Read Only:
true
The date and time when the contractor signed the inspection. -
CoordinateX: number
Read Only:
true
The X coordinate of the inspection location. -
CoordinateY: number
Read Only:
true
The Y coordinate of inspection location. -
Country: string
Read Only:
true
Maximum Length:3
The country of the inspection. -
County: string
Read Only:
true
Maximum Length:60
The county in the inspection address. -
Description: string
Read Only:
true
Maximum Length:100
The description of the inspection transaction. -
DistanceUom: string
Read Only:
true
Maximum Length:5
The distance unit of measure. The prompt is the common units table. -
EstimatedDurationHrs: number
Read Only:
true
The estimated duration of the inspection in hours. -
EstimatedTimeArrival: string
(date-time)
Read Only:
true
The estimated time of arrival at the inspection site. -
EstimatedTimeArrivalEnd: string
(date-time)
Read Only:
true
The estimated end time of arrival at the inspection site. -
ExpirationDate: string
(date-time)
Read Only:
true
The date when the application associated with the inspection expires. -
FinalInspectionFlag: string
Read Only:
true
Maximum Length:1
Indicates whether this is the final inspection. The default is no. -
HideInspectorComment: string
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)
Read Only:
true
The date and time when inspection was completed. -
InspectionDistrictId: string
Read Only:
true
Maximum Length:30
The inspection district ID. -
InspectionGroup: string
Read Only:
true
Maximum Length:15
The group of inspections if multiple inspections are required for the record type. -
InspectionId: string
Read Only:
true
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
Read Only:
true
The key for an inspection record. -
InspectionLocation: string
Read Only:
true
Maximum Length:100
An optional descriptive name of the inspection location, such as Bank of America Building or corner lot. -
InspectionName: string
Read Only:
true
Maximum Length:100
The description of the inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection. -
InspectionPuid: string
Read Only:
true
Maximum Length:480
The public unique identifier for an inspection. Used to import data. -
InspectionRating: string
Read Only:
true
Maximum Length:5
The calculated rating based on the rating method. -
InspectionResult: string
Read Only:
true
Maximum Length:25
The result of inspection, such as Pass, Fail, Yes, and No. -
InspectionScore: integer
(int32)
Read Only:
true
The calculated total inspection score. -
InspectionSource: string
Read Only:
true
Maximum Length:30
The source from which the inspection was created. -
InspectionStatus: string
Read Only:
true
Maximum Length:15
The status of the inspection. -
InspectionType: string
Read Only:
true
Maximum Length:15
The type of the inspection, such as Electrical. -
InspectorId: integer
(int64)
Read Only:
true
The ID of the inspector assigned to the inspection. -
InspectorInitials: string
Read Only:
true
Maximum Length:6
The initials of the inspector. -
InspectorName: string
Read Only:
true
Maximum Length:360
The name of the user who is assigned to the inspection. -
InspectorSignature: string
(byte)
Read Only:
true
The inspector???s signature. -
InspectorSignatureDttm: string
(date-time)
Read Only:
true
The date and time when the inspector signed the inspection. -
LicensePeriod: string
Read Only:
true
Maximum Length:100
The reporting period that applies to the business license. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Read Only:
true
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)
Read Only:
true
The unique identifier for a record. -
LocationLatitude: number
Read Only:
true
The latitude coordinate of the inspection location. -
LocationLongitude: number
Read Only:
true
The longitude coordinate of the inspection location. -
NoneResultItemCount: number
Read Only:
true
The number of inspection checklist items which have no result. -
NumMajorViolations: integer
(int32)
Read Only:
true
The calculated total number of major violations for the inspection. -
OwnerName: string
Read Only:
true
Maximum Length:360
The owner???s name. -
OwnerSignature: string
(byte)
Read Only:
true
The site owner???s signature. -
OwnerSignatureDttm: string
(date-time)
Read Only:
true
The date and time when the owner signed the inspection. -
ParcelId: integer
(int64)
Read Only:
true
The unique identifier of the record parcel. -
PermitDescription: string
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
Read Only:
true
Maximum Length:10
The contact's phone area code. -
PhoneCountryCode: string
Read Only:
true
Maximum Length:10
The contact's international country code for the phone number. -
PhoneExtension: string
Read Only:
true
Maximum Length:20
The contact's additional phone number extension. -
PhoneNumber: string
Read Only:
true
Maximum Length:40
The contact???s phone number. -
PostalCode: string
Read Only:
true
Maximum Length:60
The postal code in the inspection address. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:10
The extended postal code in the inspection address. -
PreferredContactMethod: string
Read Only:
true
Maximum Length:30
The inspection location contact???s preferred contact method. -
PreferredDate: string
(date-time)
Read Only:
true
The preferred date for the inspection to be performed. -
PreferredInspectorId: integer
(int64)
Read Only:
true
The unique identifier for the reinspection preferred inspector. -
PreferredTime: string
Read Only:
true
Maximum Length:15
The preferred time for the inspection to be performed. -
Province: string
Read Only:
true
Maximum Length:60
The province in the inspection address. -
ReadyByDttm: string
(date-time)
Read Only:
true
The date and time after which the inspection can be performed. -
RecordNumber: string
Read Only:
true
Maximum Length:64
The public unique identifier for a permit. Used to import data. -
RecordType: string
Read Only:
true
Maximum Length:100
The user-friendly name for the permit type. -
ReinspectionFlag: string
Read Only:
true
Maximum Length:1
Indicates whether this is a reinspection. The default is no. -
ReinspectionIdBy: string
Read Only:
true
Maximum Length:50
The unique identifier for the reinspection. -
ReinspectionIdOf: string
Read Only:
true
Maximum Length:50
The unique identifier of the failed inspection that requires a reinspection. -
RequestorComment: string
Read Only:
true
Maximum Length:500
The inspection requester's comments. -
RequiredFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the inspection is required. Defaults from the inspection group, but if not available, the default is no for not required. -
ScheduledEndDttm: string
(date-time)
Read Only:
true
The scheduled inspection end date. -
ScheduledStartDttm: string
(date-time)
Read Only:
true
The scheduled inspection start date. -
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
Read Only:
true
The shape of the inspection location. -
Srid: integer
(int64)
Read Only:
true
The spatial reference ID (SRID) of the inspection location. -
State: string
Read Only:
true
Maximum Length:60
The state in the inspection address. -
StatusTime: string
(date-time)
Read Only:
true
The date and time value of the scheduled inspection start time, requested inspection start time, or last updated date, which is determined by the inspection status. -
StreetDirection: string
Read Only:
true
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
Read Only:
true
Maximum Length:240
The street number in the parcel address. -
StreetNameConcat: string
Read Only:
true
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
Read Only:
true
Maximum Length:20
The street name in the parcel address used during a search. -
StreetNumberAlpha: string
Read Only:
true
Maximum Length:20
The street number in the parcel address used for sort when the content is alphanumeric. -
StreetNumberNumeric: number
Read Only:
true
The street number in the parcel address used for sort when the content is numeric. -
StreetSuffix: string
Read Only:
true
Maximum Length:20
The street suffix that further describes that street. For example, Drive, Avenue, and so on. -
StreetType: string
Read Only:
true
Maximum Length:20
The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on. -
Subclassification: string
Read Only:
true
Maximum Length:10
The subclassification for the record type, which indicates that the preapplication process is included in addition to the hearing process. -
SystemResult: string
Read Only:
true
Maximum Length:20
The unique alphanumeric code or short name for the inspection result. -
SystemStatus: string
Read Only:
true
Maximum Length:15
The unique alphanumeric code or short name for the inspection status. -
TextAreaCode: string
Read Only:
true
Maximum Length:10
The contact's mobile phone area code. -
TextCountryCode: string
Read Only:
true
Maximum Length:10
The contact's international country code for the mobile phone number. -
TextNumber: string
Read Only:
true
Maximum Length:40
The contact???s mobile phone number. -
TravelFromActualDistance: number
Read Only:
true
The total distance traveled from the inspection site. -
TravelFromEndOdometer: number
Read Only:
true
The odometer reading upon arrival at the next location. -
TravelFromStartOdometer: number
Read Only:
true
The odometer reading before travel from the inspection site. -
TravelToActualDistance: number
Read Only:
true
The total distance traveled to the inspection site. -
TravelToEndOdometer: number
Read Only:
true
The odometer reading upon arrival at the site. -
TravelToStartOdometer: number
Read Only:
true
The odometer reading before travel to the inspection site. -
UnitNumber: string
Read Only:
true
Maximum Length:30
The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300. -
VersionType: string
Read Only:
true
Maximum Length:1
The activity code for business license type for which options are set.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Shape
Type:
object
Read Only:
true
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.